thinkgeo.mapsuite.mapsuitegeocoder.usageocoder
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.mapsuitegeocoder.usageocoder [2015/09/21 07:04] admin |
thinkgeo.mapsuite.mapsuitegeocoder.usageocoder [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder ====== | ====== ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This class is for United States Geocoding. | This class is for United States Geocoding. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 9: | Line 12: | ||
| ** {{wiki:PublicMethod.gif|}} UsaGeocoder() ** | ** {{wiki:PublicMethod.gif|}} UsaGeocoder() ** | ||
| - | This is the constructor of this class. | + | * //This is the constructor of this class.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28.29// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} UsaGeocoder(String) ** | ** {{wiki:PublicMethod.gif|}} UsaGeocoder(String) ** | ||
| - | This is the constructor of this class. | + | * //This is the constructor of this class.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28String.29// |
| == Parameters == | == Parameters == | ||
| * //dataPath// | * //dataPath// | ||
| Line 27: | Line 30: | ||
| ** {{wiki:PublicMethod.gif|}} UsaGeocoder(String,MatchMode) ** | ** {{wiki:PublicMethod.gif|}} UsaGeocoder(String,MatchMode) ** | ||
| - | This is the constructor of this class. | + | * //This is the constructor of this class.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28String.2C_MatchMode.29// |
| == Parameters == | == Parameters == | ||
| * //dataPath// | * //dataPath// | ||
| Line 42: | Line 45: | ||
| ** {{wiki:PublicMethod.gif|}} UsaGeocoder(String,StreetNumberMatchingMode) ** | ** {{wiki:PublicMethod.gif|}} UsaGeocoder(String,StreetNumberMatchingMode) ** | ||
| - | This is the constructor of this class. | + | * //This is the constructor of this class.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28String.2C_StreetNumberMatchingMode.29// |
| == Parameters == | == Parameters == | ||
| * //dataPath// | * //dataPath// | ||
| Line 57: | Line 60: | ||
| ** {{wiki:PublicMethod.gif|}} UsaGeocoder(String,MatchMode,StreetNumberMatchingMode) ** | ** {{wiki:PublicMethod.gif|}} UsaGeocoder(String,MatchMode,StreetNumberMatchingMode) ** | ||
| - | This is the constructor of this class. | + | * //This is the constructor of this class.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28String.2C_MatchMode.2C_StreetNumberMatchingMode.29// |
| == Parameters == | == Parameters == | ||
| * //dataPath// | * //dataPath// | ||
| Line 78: | Line 81: | ||
| ** {{wiki:PublicMethod.gif|}} Match(String,String) ** | ** {{wiki:PublicMethod.gif|}} Match(String,String) ** | ||
| - | This method matches the specified street address and zip code. | + | * //This method matches the specified street address and zip code.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#Match.28String.2C_String.29// |
| == Return Value == | == Return Value == | ||
| Line 98: | Line 101: | ||
| ** {{wiki:PublicMethod.gif|}} Match(String,String,String) ** | ** {{wiki:PublicMethod.gif|}} Match(String,String,String) ** | ||
| - | This method matches the specified street address, city and state. | + | * //This method matches the specified street address, city and state.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#Match.28String.2C_String.2C_String.29// |
| == Return Value == | == Return Value == | ||
| Line 122: | Line 125: | ||
| ** {{wiki:PublicMethod.gif|}} Open() ** | ** {{wiki:PublicMethod.gif|}} Open() ** | ||
| - | N/A | + | * //This method opens the Geocoder so that it is initialized and ready to use.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //This method is the concrete wrapper for the virtual method OpenCore.// |
| == Return Value == | == Return Value == | ||
| Line 134: | Line 137: | ||
| ** {{wiki:PublicMethod.gif|}} Close() ** | ** {{wiki:PublicMethod.gif|}} Close() ** | ||
| - | N/A | + | * //This method closes the Geocoder and releases all of its resources.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //This method is the concrete wrapper for the virtual method CloseCore.// |
| == Return Value == | == Return Value == | ||
| Line 146: | Line 149: | ||
| ** {{wiki:PublicMethod.gif|}} Match(String) ** | ** {{wiki:PublicMethod.gif|}} Match(String) ** | ||
| - | N/A | + | * //This method matches the input source text.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //This method is the concrete wrapper for the virtual method MatchCore.// |
| == Return Value == | == Return Value == | ||
| * Type:Collection<[[ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch|GeocoderMatch]]> | * Type:Collection<[[ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch|GeocoderMatch]]> | ||
| - | * Description:N/A | + | * Description:A collection of GeocoderMatch. |
| == Parameters == | == Parameters == | ||
| * //sourceText// | * //sourceText// | ||
| * Type:String | * Type:String | ||
| - | * Description:N/A | + | * Description:Source text to match. |
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#ToString.28.29// |
| == Return Value == | == Return Value == | ||
| Line 174: | Line 177: | ||
| ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#Equals.28Object.29// |
| == Return Value == | == Return Value == | ||
| Line 190: | Line 193: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#GetHashCode.28.29// |
| == Return Value == | == Return Value == | ||
| Line 202: | Line 205: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#GetType.28.29// |
| == Return Value == | == Return Value == | ||
| Line 215: | Line 218: | ||
| ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ||
| - | Opens all of the internal MatchingPlugins. | + | * //Opens all of the internal MatchingPlugins.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#OpenCore.28.29// |
| == Return Value == | == Return Value == | ||
| Line 227: | Line 230: | ||
| ** {{wiki:ProtectedMethod.gif|}} MatchCore(String) ** | ** {{wiki:ProtectedMethod.gif|}} MatchCore(String) ** | ||
| - | This method matches the source text. | + | * //This method matches the source text.// |
| == Remarks == | == 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. | + | * //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 Value == | ||
| Line 243: | Line 246: | ||
| ** {{wiki:ProtectedMethod.gif|}} EvaluateMatchResults(IEnumerable<GeocoderMatch>) ** | ** {{wiki:ProtectedMethod.gif|}} EvaluateMatchResults(IEnumerable<GeocoderMatch>) ** | ||
| - | This method evaluates the MatchItems from different MatchingPlugIns and gets the final MatchResult. This is a concrete wrapper for EvaluateMatchResultsCore. | + | * //This method evaluates the MatchItems from different MatchingPlugIns and gets the final MatchResult. This is a concrete wrapper for EvaluateMatchResultsCore.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:// |
| == Return Value == | == Return Value == | ||
| Line 259: | Line 262: | ||
| ** {{wiki:ProtectedMethod.gif|}} EvaluateMatchResultsCore(IEnumerable<GeocoderMatch>) ** | ** {{wiki:ProtectedMethod.gif|}} 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. | + | * //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 == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:// |
| == Return Value == | == Return Value == | ||
| Line 275: | Line 278: | ||
| ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ||
| - | N/A | + | * //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 == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#CloseCore.28.29// |
| == Return Value == | == Return Value == | ||
| Line 287: | Line 290: | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#Finalize.28.29// |
| == Return Value == | == Return Value == | ||
| Line 299: | Line 302: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#MemberwiseClone.28.29// |
| == Return Value == | == Return Value == | ||
| Line 314: | Line 317: | ||
| This parameter represents the match mode. | This parameter represents the match mode. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28String.2C_MatchMode.29 |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchMode|MatchMode]] | * Type:[[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchMode|MatchMode]] | ||
| Line 322: | Line 325: | ||
| This parameter represents the street number matching mode mode. | This parameter represents the street number matching mode mode. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28String.2C_StreetNumberMatchingMode.29 |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.MapSuiteGeocoder.StreetNumberMatchingMode|StreetNumberMatchingMode]] | * Type:[[ThinkGeo.MapSuite.MapSuiteGeocoder.StreetNumberMatchingMode|StreetNumberMatchingMode]] | ||
| Line 328: | Line 331: | ||
| ** {{wiki:PublicProperty.gif|}} DataPath ** | ** {{wiki:PublicProperty.gif|}} DataPath ** | ||
| - | N/A | + | The path to the Geocoder data folder. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#DataPath |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 336: | Line 339: | ||
| ** {{wiki:PublicProperty.gif|}} MatchingPlugIns ** | ** {{wiki:PublicProperty.gif|}} MatchingPlugIns ** | ||
| - | N/A | + | The collection of MatchingPlugIns. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#MatchingPlugIns |
| == Return Value == | == Return Value == | ||
| * Type:Collection<[[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin|MatchingPlugin]]> | * Type:Collection<[[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin|MatchingPlugin]]> | ||
thinkgeo.mapsuite.mapsuitegeocoder.usageocoder.1442819051.txt.gz · Last modified: 2015/09/21 07:04 by admin