Click or drag to resize

LocationSearchSource Class

Verizon Connect Logo
Print this page
Learn more about Verizon Connect GeoBase.
Get information about the latest release
A search source for GeoBase's location search API. Custom search sources can be implemented by creating a subclass of this class and creating an associated subclass of LocationSearchOperation. Subclasses are normally implemented as a singleton.
Inheritance Hierarchy

Namespace:  Telogis.GeoBase.Geocoding
Assembly:  geobase.net (in geobase.net.dll) Version: 4.99.0.0
Syntax
public abstract class LocationSearchSource

The LocationSearchSource type exposes the following members.

Properties
  NameDescription
Public propertyGroupName
The group name of the search source. Related sources can share search arguments by using the same group name. Can be overridden by subclasses to specify a group name, which is then used as the prefix for argument names when presented to users of LocationSearch. Defaults to null, meaning that Name is used as the argument name prefix instead.
Public propertyHandledResultTypes
Specifies the result types handled by this source.
Public propertyName
The name of the search source, for use for things such as prefixing custom search arguments. Must be unique across search source.
Public propertySearchesRemotely
Indicates whether the search spends most of its time waiting for results from an external server. If true, this indicates that the Location Search can continue searching other sources while waiting for this source to complete, reducing total search time.
Top
Methods
  NameDescription
Public methodCreateSearchOperation
Create and return a new search operation for the search source, using the provided arguments. The search operation should be returned unstarted.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetCustomSearchArgs
Returns a list of custom arguments for this search source that can be specified in the CustomArgs property of a LocationSearchBaseArgs object. Argument names are automatically prefixed by the search source group name or name when presented to users of LocationSearch, however will always be provided to individual search sources without these prefixes.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetIgnoredTypesForApplicableSearches
Specifies result types that will be excluded for search sources with a lower priority than this when IsApplicableToSearch(LocationSearchBaseArgs) returns true for the same search arguments. This could be used, for example, to restrict further searching for queries that match a format specific to this source, but for which there are no results.
Public methodGetIgnoredTypesForMatchingSearches
Specifies result types that will be excluded for search sources with a lower priority than this when the source returns any results. If it does not return results, searching of other sources will continue as normal. This should generally be used only when the presence of results from this source implies that results from other sources are unlikely.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsApplicableToSearch
Determines whether the search source is applicable for a particular search.
Public methodPriorityForSearch
Determines the priority of the search source for a particular search. The priority is used to determine the order in which search sources are queried; sources with a higher priority are searched first.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldStatic memberDefaultGeocodingPriority
The default priority value to use for geocoding operations.
Public fieldStatic memberDefaultPoiPriority
The default priority value to use for POI searches.
Public fieldStatic memberDefaultRelativePoiPriority
The default prioriy value to use for POI searches that are relative to a certain location, e.g. in Aliso Viejo.
Public fieldStatic memberDefaultReverseGeocodingPriority
The default priority value to use for reverse geocode operations.
Public fieldStatic memberMaximumPriority
The maximum priority value to use for search operations.
Public fieldStatic memberPriorityToStartRemoteSources
The priority level at which remote operations are started. Sources with higher priority should be extremely quick and exclude further sources when they find results. This avoids the need to begin costly network requests when we can quickly determine that they are not needed.
Top
See Also