thinkgeo.mapsuite.mapsuitegeocoder.dbfmatchingplugin
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.dbfmatchingplugin [2015/09/21 07:03] admin |
thinkgeo.mapsuite.mapsuitegeocoder.dbfmatchingplugin [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin ====== | ====== ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This class encapsulates the matching operations in a DBF dataset. This class provides functions for creating and adding records and matching for DBF index files. The DBF file could contain one key column whose column name starts with "ID_" and additional columns whose column names start with "DT_". Each DBF file should also contain two columns named "BB_CX" and "BB_CY", which represent the longitude and latitude. If there is bounding box information, it should consist of four columns: "BB_ULX", "BB_ULY", "BB_LRX", "BB_LRY" representing upper left X, upper left Y, lower right X and lower right Y. To take advantange of binary searching, records should be sorted before insertion into the DBF file. | This class encapsulates the matching operations in a DBF dataset. This class provides functions for creating and adding records and matching for DBF index files. The DBF file could contain one key column whose column name starts with "ID_" and additional columns whose column names start with "DT_". Each DBF file should also contain two columns named "BB_CX" and "BB_CY", which represent the longitude and latitude. If there is bounding box information, it should consist of four columns: "BB_ULX", "BB_ULY", "BB_LRX", "BB_LRY" representing upper left X, upper left Y, lower right X and lower right Y. To take advantange of binary searching, records should be sorted before insertion into the DBF file. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 17: | Line 20: | ||
| ** {{wiki:PublicMethod.gif|}} DbfMatchingPlugin() ** | ** {{wiki:PublicMethod.gif|}} DbfMatchingPlugin() ** | ||
| - | 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.DbfMatchingPlugin#DbfMatchingPlugin.28.29// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} DbfMatchingPlugin(String) ** | ** {{wiki:PublicMethod.gif|}} DbfMatchingPlugin(String) ** | ||
| - | This is the construcor of this class. | + | * //This is the construcor 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.DbfMatchingPlugin#DbfMatchingPlugin.28String.29// |
| == Parameters == | == Parameters == | ||
| * //pathFileName// | * //pathFileName// | ||
| Line 35: | Line 38: | ||
| ** {{wiki:PublicMethod.gif|}} DbfMatchingPlugin(String,DbfMatchingPluginReadWriteMode) ** | ** {{wiki:PublicMethod.gif|}} DbfMatchingPlugin(String,DbfMatchingPluginReadWriteMode) ** | ||
| - | This is the construcor of this class. | + | * //This is the construcor 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.DbfMatchingPlugin#DbfMatchingPlugin.28String.2C_DbfMatchingPluginReadWriteMode.29// |
| == Parameters == | == Parameters == | ||
| * //pathFileName// | * //pathFileName// | ||
| Line 52: | Line 55: | ||
| ** {{wiki:PublicMethod.gif|}} GetRecord(Int32) ** | ** {{wiki:PublicMethod.gif|}} GetRecord(Int32) ** | ||
| - | This method gets a record by record index from the DBF file. | + | * //This method gets a record by record index from the DBF file.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#GetRecord.28Int32.29// |
| == Return Value == | == Return Value == | ||
| Line 68: | Line 71: | ||
| ** {{wiki:PublicMethod.gif|}} GetRecords(Int32,Int32) ** | ** {{wiki:PublicMethod.gif|}} GetRecords(Int32,Int32) ** | ||
| - | This method gets records by using the specified range. | + | * //This method gets records by using the specified range.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#GetRecords.28Int32.2C_Int32.29// |
| == Return Value == | == Return Value == | ||
| Line 88: | Line 91: | ||
| ** {{wiki:PublicMethod.gif|}} AddRecord(IEnumerable<Object>) ** | ** {{wiki:PublicMethod.gif|}} AddRecord(IEnumerable<Object>) ** | ||
| - | This method adds one record to the DBF file. | + | * //This method adds one record to the DBF file.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:// |
| == Return Value == | == Return Value == | ||
| Line 104: | Line 107: | ||
| ** {{wiki:PublicMethod.gif|}} Dispose() ** | ** {{wiki:PublicMethod.gif|}} Dispose() ** | ||
| - | Releases all resources used by the DbfMatchingPlugin. | + | * //Releases all resources used by the DbfMatchingPlugin.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#Dispose.28.29// |
| == Return Value == | == Return Value == | ||
| Line 116: | Line 119: | ||
| ** {{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.DbfMatchingPlugin#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.DbfMatchingPlugin#Open.28.29// |
| == Return Value == | == Return Value == | ||
| Line 144: | Line 147: | ||
| ** {{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.DbfMatchingPlugin#Close.28.29// |
| == Return Value == | == Return Value == | ||
| Line 156: | Line 159: | ||
| ** {{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.DbfMatchingPlugin#ToString.28.29// |
| == Return Value == | == Return Value == | ||
| Line 168: | Line 171: | ||
| ** {{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.DbfMatchingPlugin#Equals.28Object.29// |
| == Return Value == | == Return Value == | ||
| Line 184: | Line 187: | ||
| ** {{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.DbfMatchingPlugin#GetHashCode.28.29// |
| == Return Value == | == Return Value == | ||
| Line 196: | Line 199: | ||
| ** {{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.DbfMatchingPlugin#GetType.28.29// |
| == Return Value == | == Return Value == | ||
| Line 208: | Line 211: | ||
| ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} CreateDbf(String,IEnumerable<DbfMatchingPluginColumn>) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} CreateDbf(String,IEnumerable<DbfMatchingPluginColumn>) ** | ||
| - | This method creates a DBF file according to the specified file name and column names. | + | * //This method creates a DBF file according to the specified file name and column names.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:// |
| == Return Value == | == Return Value == | ||
| Line 229: | Line 232: | ||
| ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ||
| - | This method opens and initializes the DbfMatchingPlugin. | + | * //This method opens and initializes the DbfMatchingPlugin.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#OpenCore.28.29// |
| == Return Value == | == Return Value == | ||
| Line 241: | Line 244: | ||
| ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ||
| - | This method closes the DbfMatchingPlugin. | + | * //This method closes the DbfMatchingPlugin.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#CloseCore.28.29// |
| == Return Value == | == Return Value == | ||
| Line 253: | Line 256: | ||
| ** {{wiki:ProtectedMethod.gif|}} MatchCore(String) ** | ** {{wiki:ProtectedMethod.gif|}} MatchCore(String) ** | ||
| - | This method matches the source text and returns the collection of GeocoderMatch. | + | * //This method matches the source text and returns the collection of 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.DbfMatchingPlugin#MatchCore.28String.29// |
| == Return Value == | == Return Value == | ||
| Line 269: | Line 272: | ||
| ** {{wiki:ProtectedMethod.gif|}} SearchUpperBound(Int32,Int32,String,String) ** | ** {{wiki:ProtectedMethod.gif|}} SearchUpperBound(Int32,Int32,String,String) ** | ||
| - | This method gets the record number of the upper boundary of the matched results. | + | * //This method gets the record number of the upper boundary of the matched results.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#SearchUpperBound.28Int32.2C_Int32.2C_String.2C_String.29// |
| == Return Value == | == Return Value == | ||
| Line 297: | Line 300: | ||
| ** {{wiki:ProtectedMethod.gif|}} SearchLowerBound(Int32,Int32,String,String) ** | ** {{wiki:ProtectedMethod.gif|}} SearchLowerBound(Int32,Int32,String,String) ** | ||
| - | This method gets the record number of the lower boundary of the matched results. | + | * //This method gets the record number of the lower boundary of the matched results.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#SearchLowerBound.28Int32.2C_Int32.2C_String.2C_String.29// |
| == Return Value == | == Return Value == | ||
| Line 325: | Line 328: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetKeyColumnName() ** | ** {{wiki:ProtectedMethod.gif|}} GetKeyColumnName() ** | ||
| - | This method gets the key column name from the DBF file. | + | * //This method gets the key column name from the DBF file.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#GetKeyColumnName.28.29// |
| == Return Value == | == Return Value == | ||
| Line 337: | Line 340: | ||
| ** {{wiki:ProtectedMethod.gif|}} BinarySearch(Int32,Int32,String,String) ** | ** {{wiki:ProtectedMethod.gif|}} BinarySearch(Int32,Int32,String,String) ** | ||
| - | This method does a binary search on the DBF file and returns the record it hits. | + | * //This method does a binary search on the DBF file and returns the record it hits.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#BinarySearch.28Int32.2C_Int32.2C_String.2C_String.29// |
| == Return Value == | == Return Value == | ||
| Line 365: | Line 368: | ||
| ** {{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.DbfMatchingPlugin#Finalize.28.29// |
| == Return Value == | == Return Value == | ||
| Line 377: | Line 380: | ||
| ** {{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.DbfMatchingPlugin#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|}} FormalizeCore(String) ** | ** {{wiki:ProtectedMethod.gif|}} FormalizeCore(String) ** | ||
| - | N/A | + | * //This method formalizes the source text.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#FormalizeCore.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 425: | Line 428: | ||
| ** {{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.DbfMatchingPlugin#MemberwiseClone.28.29// |
| == Return Value == | == Return Value == | ||
| Line 440: | Line 443: | ||
| Gets and sets the path and file name of the DBF file to be used for Geocoding. | Gets and sets the path and file name of the DBF file to be used for Geocoding. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#PathFileName |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 448: | Line 451: | ||
| The read/write mode for the DBF file. | The read/write mode for the DBF file. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#DbfMatchingPlugin.28String.2C_DbfMatchingPluginReadWriteMode.29 |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPluginReadWriteMode|DbfMatchingPluginReadWriteMode]] | * Type:[[ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPluginReadWriteMode|DbfMatchingPluginReadWriteMode]] | ||
| Line 456: | Line 459: | ||
| This record count of the DBF file. | This record count of the DBF file. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#RecordCount |
| == Return Value == | == Return Value == | ||
| * Type:Int32 | * Type:Int32 | ||
| Line 462: | Line 465: | ||
| ** {{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.DbfMatchingPlugin#RankingMultiplier |
| == Return Value == | == Return Value == | ||
| * Type:Int32 | * Type:Int32 | ||
thinkgeo.mapsuite.mapsuitegeocoder.dbfmatchingplugin.1442819017.txt.gz · Last modified: 2015/09/21 07:03 by admin