Click or drag to resize

RelativeSource Class

Verizon Connect Logo
Print this page
Learn more about Verizon Connect GeoBase.
Get information about the latest release
A specialized search source for GeoBase's location search API for use with relative queries such as 'hotels in aliso viejo'. Custom relative sources can subclass this, along with RelativeSearchOperation, to provide access to other kinds of relative query results other than built in point of interest results.
Inheritance Hierarchy

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

The RelativeSource 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.
(Inherited from LocationSearchSource.)
Public propertyHandledResultTypes
Specifies the result types handled by this source.
(Overrides LocationSearchSourceHandledResultTypes.)
Public propertyName
The name of the search source, for use for things such as prefixing custom search arguments. Must be unique across search source.
(Inherited from LocationSearchSource.)
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.
(Inherited from LocationSearchSource.)
Top
Methods
  NameDescription
Public methodCreateSearchOperation
Creates a new LocationSearchOperation for this specialized search source with the given arguments.
(Overrides LocationSearchSourceCreateSearchOperation(LocationSearchBaseArgs).)
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.
(Inherited from LocationSearchSource.)
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.
(Overrides LocationSearchSourceGetIgnoredTypesForApplicableSearches(LocationSearchBaseArgs).)
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.
(Inherited from LocationSearchSource.)
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.
(Overrides LocationSearchSourceIsApplicableToSearch(LocationSearchBaseArgs).)
Public methodIsValidOuterQuery
Overridden by subclasses to determine wheter an outer query (i.e., the portion of the query describing the type of result to return, such as "hotels" in "hotels near aliso viejo") is valid. Generally, this method should return true only if the outer query is fully formed (i.e., not a prefix). The source is applicable if, and only if, this method returns true; this method will only be called if the query is a relative query, and subclasses should override this method instead of IsApplicableToSearch(LocationSearchBaseArgs). By default, further sources will not be searched if this method returns true.
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.
(Overrides LocationSearchSourcePriorityForSearch(LocationSearchBaseArgs).)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also