This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.mapsuitegeocoder.coordinatesmatchingplugin [2015/09/21 07:03] admin |
thinkgeo.mapsuite.mapsuitegeocoder.coordinatesmatchingplugin [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.MapSuiteGeocoder.CoordinatesMatchingPlugin ====== | ====== ThinkGeo.MapSuite.MapSuiteGeocoder.CoordinatesMatchingPlugin ====== | ||
- | This class implements coordinate matching functions. The CoordinatesMatchingPlugin uses serveral DBF and R-Tree index files to accomplish matching operations. street.dbf: Contains non-geographic information for streets. rt2.dbf: Contains coordinate information for streets. tlid.dbf: Contains street TIGER line ID (TLID) and index in street.dbf. Sorted by TLID. zip.dbf: Contains zip code information. rt2.ids and rt2.idx: R-Tree index files for streets by zip. | + | |
+ | {{section>upgrade_map_suite_to_10.0}} | ||
+ | |||
+ | This class implements coordinate matching functions. The CoordinatesMatchingPlugin uses serveral DBF and R-Tree index files to accomplish matching operations. street.dbf: Contains non-geographic information for streets. rt2.dbf: Contains coordinate information for streets. tlid.dbf: Contains street TIGER line ID (TLID) and index in street.dbf. Sorted by TLID. zip.dbf: Contains zip code information. rt2.ids and rt2.idx: R-Tree index files for streets by zip. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
*System.Object | *System.Object | ||
Line 9: | Line 12: | ||
** {{wiki:PublicMethod.gif|}} CoordinatesMatchingPlugin() ** | ** {{wiki:PublicMethod.gif|}} CoordinatesMatchingPlugin() ** | ||
- | 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.CoordinatesMatchingPlugin#CoordinatesMatchingPlugin.28.29// |
== Parameters == | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
** {{wiki:PublicMethod.gif|}} CoordinatesMatchingPlugin(String) ** | ** {{wiki:PublicMethod.gif|}} CoordinatesMatchingPlugin(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.CoordinatesMatchingPlugin#CoordinatesMatchingPlugin.28String.29// |
== Parameters == | == Parameters == | ||
* //dataPath// | * //dataPath// | ||
Line 29: | Line 32: | ||
** {{wiki:PublicMethod.gif|}} Dispose() ** | ** {{wiki:PublicMethod.gif|}} Dispose() ** | ||
- | Releases all resources used by the CoordinatesMatchingPlugin. | + | * //Releases all resources used by the CoordinatesMatchingPlugin.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.CoordinatesMatchingPlugin#Dispose.28.29// |
== Return Value == | == Return Value == | ||
Line 41: | Line 44: | ||
** {{wiki:PublicMethod.gif|}} Match(String) ** | ** {{wiki:PublicMethod.gif|}} Match(String) ** | ||
- | N/A | + | * //This method matches the source text and returns a collection of GeocoderMatch. This method is the concrete wrapper for MatchCore. It firstly formalizes the input sourceText, gets the formalized results and matches them using MatchCore one by one, then returns all of the results within a collection.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.CoordinatesMatchingPlugin#Match.28String.29// |
== 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:The source text to match. |
<div newline></div> | <div newline></div> | ||
** {{wiki:PublicMethod.gif|}} Open() ** | ** {{wiki:PublicMethod.gif|}} Open() ** | ||
- | N/A | + | * //This method opens the MatchingPlugin for use. This method is the concrete wrapper for OpenCore.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.CoordinatesMatchingPlugin#Open.28.29// |
== Return Value == | == Return Value == | ||
Line 69: | Line 72: | ||
** {{wiki:PublicMethod.gif|}} Close() ** | ** {{wiki:PublicMethod.gif|}} Close() ** | ||
- | N/A | + | * //This method closes the MatchingPlugin. This method is the concrete wrapper for CloseCore.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.CoordinatesMatchingPlugin#Close.28.29// |
== Return Value == | == Return Value == | ||
Line 81: | Line 84: | ||
** {{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.CoordinatesMatchingPlugin#ToString.28.29// |
== Return Value == | == Return Value == | ||
Line 93: | Line 96: | ||
** {{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.CoordinatesMatchingPlugin#Equals.28Object.29// |
== Return Value == | == Return Value == | ||
Line 109: | Line 112: | ||
** {{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.CoordinatesMatchingPlugin#GetHashCode.28.29// |
== Return Value == | == Return Value == | ||
Line 121: | Line 124: | ||
** {{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.CoordinatesMatchingPlugin#GetType.28.29// |
== Return Value == | == Return Value == | ||
Line 134: | Line 137: | ||
** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ||
- | This method opens the CoordinatesMatchingPlugin. | + | * //This method opens the CoordinatesMatchingPlugin.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.CoordinatesMatchingPlugin#OpenCore.28.29// |
== Return Value == | == Return Value == | ||
Line 146: | Line 149: | ||
** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ||
- | This method close the CoordinatesMatchingPlugin. | + | * //This method close the CoordinatesMatchingPlugin.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.CoordinatesMatchingPlugin#CloseCore.28.29// |
== Return Value == | == Return Value == | ||
Line 158: | Line 161: | ||
** {{wiki:ProtectedMethod.gif|}} MatchCore(String) ** | ** {{wiki:ProtectedMethod.gif|}} MatchCore(String) ** | ||
- | This method matches the source text representing coordinates. It initializes the bounding box list for zip codes and tries to find which zip code area contains the coordinates by looping through that list. Next, it gets a street list from the R-Tree index file according to the zip bounding box that was found. It then calculates the distance between the point and the streets, and gets the street that is the shortest distance from the point. | + | * //This method matches the source text representing coordinates. It initializes the bounding box list for zip codes and tries to find which zip code area contains the coordinates by looping through that list. Next, it gets a street list from the R-Tree index file according to the zip bounding box that was found. It then calculates the distance between the point and the streets, and gets the street that is the shortest distance from the point.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.CoordinatesMatchingPlugin#MatchCore.28String.29// |
== Return Value == | == Return Value == | ||
Line 174: | Line 177: | ||
** {{wiki:ProtectedMethod.gif|}} FormalizeCore(String) ** | ** {{wiki:ProtectedMethod.gif|}} FormalizeCore(String) ** | ||
- | This method formalizes the source text to get possible coordinates. | + | * //This method formalizes the source text to get possible coordinates.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.CoordinatesMatchingPlugin#FormalizeCore.28String.29// |
== Return Value == | == Return Value == | ||
Line 190: | Line 193: | ||
** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
- | This method is automatically called after an object becomes inaccessible, unless the object has been exempted from finalization by a call to SuppressFinalize. | + | * //This method is automatically called after an object becomes inaccessible, unless the object has been exempted from finalization by a call to SuppressFinalize.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.CoordinatesMatchingPlugin#Finalize.28.29// |
== Return Value == | == Return Value == | ||
Line 202: | Line 205: | ||
** {{wiki:ProtectedMethod.gif|}} Formalize(String) ** | ** {{wiki:ProtectedMethod.gif|}} Formalize(String) ** | ||
- | N/A | + | * //This method formalizes the source text. This method is the concrete wrapper of FormalizeCore.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.CoordinatesMatchingPlugin#Formalize.28String.29// |
== Return Value == | == Return Value == | ||
* Type:Collection<String> | * Type:Collection<String> | ||
- | * Description:N/A | + | * Description:The collection of formalized strings. |
== Parameters == | == Parameters == | ||
* //sourceText// | * //sourceText// | ||
* Type:String | * Type:String | ||
- | * Description:N/A | + | * Description:The source text to formalize. |
<div newline></div> | <div newline></div> | ||
** {{wiki:ProtectedMethod.gif|}} oxM=(GeocoderMatch) ** | ** {{wiki:ProtectedMethod.gif|}} oxM=(GeocoderMatch) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 234: | Line 237: | ||
** {{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.CoordinatesMatchingPlugin#MemberwiseClone.28.29// |
== Return Value == | == Return Value == | ||
Line 249: | Line 252: | ||
This property is the path to the Geocoder data folder. | This property is 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.CoordinatesMatchingPlugin#DataPath |
== Return Value == | == Return Value == | ||
* Type:String | * Type:String | ||
Line 255: | Line 258: | ||
** {{wiki:PublicProperty.gif|}} RankingMultiplier ** | ** {{wiki:PublicProperty.gif|}} RankingMultiplier ** | ||
- | N/A | + | This property is the ranking multipier for GeocoderMatch. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.CoordinatesMatchingPlugin#RankingMultiplier |
== Return Value == | == Return Value == | ||
* Type:Int32 | * Type:Int32 |