ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.mapsuitegeocoder.usageocoder
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder
<!– Class –> This class is for United States Geocoding.
Remarks
This class is the derived class of Geocoder for United States Geocoding. By default, its MatchingPlugIn collection contains the StreetDbfMatchingPlugIn, ZipDbfMatchingPlugIn, CityDbfMatchingPlugIn, CountyDbfMatchingPlugIn and StateDbfMatchingPlugIn.
Inheritance Hierarchy
*System.Object ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder *ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 UsaGeocoder | This is the constructor of this class. | ||
| UsaGeocoder | String | This is the constructor of this class. | |
| UsaGeocoder | String, MatchMode | This is the constructor of this class. | |
| UsaGeocoder | String, StreetNumberMatchingMode | This is the constructor of this class. | |
| UsaGeocoder | String, MatchMode, StreetNumberMatchingMode | This is the constructor of this class. |
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
| Close | Geocoder | This method closes the Geocoder and releases all of its resources. | |
| Equals | Object | Object | |
| GetHashCode | Object | ||
| GetType | Object | ||
| Match | String, String | This method matches the specified street address and zip code. | |
| Match | String, String, String | This method matches the specified street address, city and state. | |
| Match | String | Geocoder | This method matches the input source text. |
| Open | Geocoder | This method opens the Geocoder so that it is initialized and ready to use. | |
| ToString | Object |
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 CloseCore | Geocoder | This method closes the Geocoder and releases all of its resources. This method loops through each MatchingPlugIn object in the MatchingPlugIns collection to call their Close() method. | |
| EvaluateMatchResults | IEnumerable<GeocoderMatch> | This method evaluates the MatchItems from different MatchingPlugIns and gets the final MatchResult. This is a concrete wrapper for EvaluateMatchResultsCore. | |
| EvaluateMatchResultsCore | IEnumerable<GeocoderMatch> | This method evaluates the MatchItems from different MatchingPlugIns and gets the final MatchResult. This method adds all MatchItems into one list, then loops though and evaluates every two MatchItems, sorts the MatchItems by the MatchRanking property of the MatchItem, and finally adds them to MatchResult. When evaluating two MatchItems, if the name-value pairs of the two MatchItems have the same key and that key is in the compare key array, just compare the value. If the values are equal then use the MatchRanking plus the RankingMultiplier. | |
| Finalize | Object | ||
| MatchCore | String | Geocoder(overriden) | This method matches the source text. |
| MemberwiseClone | Object | ||
| OpenCore | Geocoder(overriden) | Opens all of the internal MatchingPlugins. |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 DataPath | String | Geocoder | The path to the Geocoder data folder. |
| MatchMode | MatchMode | This parameter represents the match mode. | |
| MatchingPlugIns | Collection<MatchingPlugin> | Geocoder | The collection of MatchingPlugIns. |
| StreetNumberMatchingMode | StreetNumberMatchingMode | This parameter represents the street number matching mode mode. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|
Public Constructors
UsaGeocoder()
This is the constructor of this class.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28.29</a>
Parameters
| Name | Type | Description |
|---|
UsaGeocoder(String)
This is the constructor of this class.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28String.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28String.29</a>
Parameters
| Name | Type | Description |
|---|---|---|
| dataPath | String<!– System.String –> | The path to the Geocoder data folder. |
UsaGeocoder(String, MatchMode)
This is the constructor of this class.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28String.2C_MatchMode.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28String.2C_MatchMode.29</a>
Parameters
| Name | Type | Description |
|---|---|---|
| dataPath | String<!– System.String –> | The path to the Geocoder data folder. |
| matchMode | MatchMode<!– ThinkGeo.MapSuite.MapSuiteGeocoder.MatchMode –> | This parameter represents the match mode. |
UsaGeocoder(String, StreetNumberMatchingMode)
This is the constructor of this class.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28String.2C_StreetNumberMatchingMode.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28String.2C_StreetNumberMatchingMode.29</a>
Parameters
| Name | Type | Description |
|---|---|---|
| dataPath | String<!– System.String –> | The path to the Geocoder data folder. |
| streetNumberMatchingMode | StreetNumberMatchingMode<!– ThinkGeo.MapSuite.MapSuiteGeocoder.StreetNumberMatchingMode –> | This parameter represents the street number match mode. |
UsaGeocoder(String, MatchMode, StreetNumberMatchingMode)
This is the constructor of this class.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28String.2C_MatchMode.2C_StreetNumberMatchingMode.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28String.2C_MatchMode.2C_StreetNumberMatchingMode.29</a>
Parameters
| Name | Type | Description |
|---|---|---|
| dataPath | String<!– System.String –> | The path to the Geocoder data folder. |
| matchMode | MatchMode<!– ThinkGeo.MapSuite.MapSuiteGeocoder.MatchMode –> | This parameter represents the match mode. |
| streetNumberMatchingMode | StreetNumberMatchingMode<!– ThinkGeo.MapSuite.MapSuiteGeocoder.StreetNumberMatchingMode –> | This parameter represents the street number match mode. |
Protected Constructors
Public Methods
Close()
This method closes the Geocoder and releases all of its resources.
Remarks
This method is the concrete wrapper for the virtual method CloseCore.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder –> Go Back
Equals(Object)
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#Equals.28Object.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#Equals.28Object.29</a>
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
GetHashCode()
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#GetHashCode.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#GetHashCode.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetType()
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#GetType.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#GetType.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| Type<!– System.Type –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Match(String, String)
This method matches the specified street address and zip code.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#Match.28String.2C_String.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#Match.28String.2C_String.29</a>
Return Value
| Return Type | Description |
|---|---|
| Collection<GeocoderMatch><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch} –> | The matched results within a collection of GeocoderMatch. |
Parameters
| Name | Type | Description |
|---|---|---|
| streetAddress | String<!– System.String –> | This parameter is the street address to match. |
| zip | String<!– System.String –> | This parameter is the zip code to match. |
<!– ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder –> Go Back
Match(String, String, String)
This method matches the specified street address, city and state.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#Match.28String.2C_String.2C_String.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#Match.28String.2C_String.2C_String.29</a>
Return Value
| Return Type | Description |
|---|---|
| Collection<GeocoderMatch><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch} –> | The matched results within a collection of GeocoderMatch. |
Parameters
| Name | Type | Description |
|---|---|---|
| streetAddress | String<!– System.String –> | This parameter is the street address to match. |
| city | String<!– System.String –> | This parameter is the city to match. |
| state | String<!– System.String –> | This parameter is the state to match. |
<!– ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder –> Go Back
Match(String)
This method matches the input source text.
Remarks
This method is the concrete wrapper for the virtual method MatchCore.
Return Value
| Return Type | Description |
|---|---|
| Collection<GeocoderMatch><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch} –> | A collection of GeocoderMatch. |
Parameters
| Name | Type | Description |
|---|---|---|
| sourceText | String<!– System.String –> | Source text to match. |
<!– ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder –> Go Back
Open()
This method opens the Geocoder so that it is initialized and ready to use.
Remarks
This method is the concrete wrapper for the virtual method OpenCore.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder –> Go Back
ToString()
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#ToString.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#ToString.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Protected Methods
CloseCore()
This method closes the Geocoder and releases all of its resources. This method loops through each MatchingPlugIn object in the MatchingPlugIns collection to call their Close() method.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#CloseCore.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#CloseCore.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder –> Go Back
EvaluateMatchResults(IEnumerable<GeocoderMatch>)
This method evaluates the MatchItems from different MatchingPlugIns and gets the final MatchResult. This is a concrete wrapper for EvaluateMatchResultsCore.
Remarks
For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>
Return Value
| Return Type | Description |
|---|---|
| Collection<GeocoderMatch><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch} –> | The evaluated results within a collection of GeocoderMatch. |
Parameters
| Name | Type | Description |
|---|---|---|
| sourceMatchItems | IEnumerable<GeocoderMatch><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch} –> | The collection of GeocoderMatch. |
<!– ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder –> Go Back
EvaluateMatchResultsCore(IEnumerable<GeocoderMatch>)
This method evaluates the MatchItems from different MatchingPlugIns and gets the final MatchResult. This method adds all MatchItems into one list, then loops though and evaluates every two MatchItems, sorts the MatchItems by the MatchRanking property of the MatchItem, and finally adds them to MatchResult. When evaluating two MatchItems, if the name-value pairs of the two MatchItems have the same key and that key is in the compare key array, just compare the value. If the values are equal then use the MatchRanking plus the RankingMultiplier.
Remarks
For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>
Return Value
| Return Type | Description |
|---|---|
| Collection<GeocoderMatch><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch} –> | MatchResult object. |
Parameters
| Name | Type | Description |
|---|---|---|
| sourceMatchItems | IEnumerable<GeocoderMatch><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch} –> | The collection of MatchItems. |
<!– ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder –> Go Back
Finalize()
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#Finalize.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#Finalize.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
MatchCore(String)
This method matches the source text.
Remarks
This method calls the match method of each MatchingPlugIn object and then evaluates the match results from each MatchingPlugIn object to get the best match items.
Return Value
| Return Type | Description |
|---|---|
| Collection<GeocoderMatch><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch} –> | The matched results within a collection of GeocoderMatch. |
Parameters
| Name | Type | Description |
|---|---|---|
| sourceText | String<!– System.String –> | The source text to match. |
<!– ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder(overriden) –> Go Back
MemberwiseClone()
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#MemberwiseClone.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#MemberwiseClone.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
OpenCore()
Opens all of the internal MatchingPlugins.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#OpenCore.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#OpenCore.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder(overriden) –> Go Back
Public Properties
DataPath
The path to the Geocoder data folder.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#DataPath” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#DataPath</a>
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder –> Go Back
MatchMode
This parameter represents the match mode.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28String.2C_MatchMode.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28String.2C_MatchMode.29</a>
Return Value
| Return Type |
|---|
| MatchMode<!– ThinkGeo.MapSuite.MapSuiteGeocoder.MatchMode –> |
<!– ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder –> Go Back
MatchingPlugIns
The collection of MatchingPlugIns.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#MatchingPlugIns” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#MatchingPlugIns</a>
Return Value
| Return Type |
|---|
| Collection<MatchingPlugin><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin} –> |
<!– ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder –> Go Back
StreetNumberMatchingMode
This parameter represents the street number matching mode mode.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28String.2C_StreetNumberMatchingMode.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28String.2C_StreetNumberMatchingMode.29</a>
Return Value
| Return Type |
|---|
| StreetNumberMatchingMode<!– ThinkGeo.MapSuite.MapSuiteGeocoder.StreetNumberMatchingMode –> |
<!– ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder –> Go Back
Protected Properties
Public Events
thinkgeo.mapsuite.mapsuitegeocoder.usageocoder.1440040131.txt.gz · Last modified: 2015/09/21 07:04 (external edit)