thinkgeo.mapsuite.mapsuitegeocoder.dbfmatchingplugin
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.mapsuitegeocoder.dbfmatchingplugin [2015/08/20 03:08] 127.0.0.1 external edit |
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}} | ||
| - | |||
| - | <!-- Class --> | ||
| 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. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin</a> | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin]] | + | *ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin |
| - | ***[[ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin]] | + | ***ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin** |
| - | ****[[ThinkGeo.MapSuite.MapSuiteGeocoder.CensusBlockDbfMatchingPlugin]] | + | *[[ThinkGeo.MapSuite.MapSuiteGeocoder.CensusBlockDbfMatchingPlugin]] |
| - | ****[[ThinkGeo.MapSuite.MapSuiteGeocoder.CensusBlockGroupDbfMatchingPlugin]] | + | *[[ThinkGeo.MapSuite.MapSuiteGeocoder.CensusBlockGroupDbfMatchingPlugin]] |
| - | ****[[ThinkGeo.MapSuite.MapSuiteGeocoder.CensusTractsDbfMatchingPlugin]] | + | *[[ThinkGeo.MapSuite.MapSuiteGeocoder.CensusTractsDbfMatchingPlugin]] |
| - | ****[[ThinkGeo.MapSuite.MapSuiteGeocoder.CityDbfMatchingPlugin]] | + | *[[ThinkGeo.MapSuite.MapSuiteGeocoder.CountyDbfMatchingPlugin]] |
| - | ****[[ThinkGeo.MapSuite.MapSuiteGeocoder.CountyDbfMatchingPlugin]] | + | *[[ThinkGeo.MapSuite.MapSuiteGeocoder.SoundexDbfMatchingPlugin]] |
| - | ****[[ThinkGeo.MapSuite.MapSuiteGeocoder.SoundexDbfMatchingPlugin]] | + | *[[ThinkGeo.MapSuite.MapSuiteGeocoder.CityDbfMatchingPlugin]] |
| - | ****[[ThinkGeo.MapSuite.MapSuiteGeocoder.StateDbfMatchingPlugin]] | + | *[[ThinkGeo.MapSuite.MapSuiteGeocoder.StateDbfMatchingPlugin]] |
| - | ****[[ThinkGeo.MapSuite.MapSuiteGeocoder.ZipDbfMatchingPlugin]] | + | *[[ThinkGeo.MapSuite.MapSuiteGeocoder.ZipDbfMatchingPlugin]] |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} DbfMatchingPlugin() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#DbfMatchingPlugin()|DbfMatchingPlugin]] | | | This is the constructor of this class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#DbfMatchingPlugin(String)|DbfMatchingPlugin]] | String | | This is the construcor of this class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#DbfMatchingPlugin(String, DbfMatchingPluginReadWriteMode)|DbfMatchingPlugin]] | String, [[ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPluginReadWriteMode|DbfMatchingPluginReadWriteMode]] | | This is the construcor of this class. | | + | |
| - | ==== Protected Constructors ==== | + | * //This is the constructor of this class.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //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 == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} DbfMatchingPlugin(String) ** | ||
| + | * //This is the construcor of this class.// | ||
| + | == Remarks == | ||
| + | * //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 == | ||
| + | * //pathFileName// | ||
| + | * Type:String | ||
| + | * Description:The path and file name of the DBF file to be used for Geocoding. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} DbfMatchingPlugin(String,DbfMatchingPluginReadWriteMode) ** | ||
| + | |||
| + | * //This is the construcor of this class.// | ||
| + | == Remarks == | ||
| + | * //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 == | ||
| + | * //pathFileName// | ||
| + | * Type:String | ||
| + | * Description:The path and file name of the index. | ||
| + | |||
| + | * //readWriteMode// | ||
| + | * Type:[[ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPluginReadWriteMode|DbfMatchingPluginReadWriteMode]] | ||
| + | * Description:The read/write mode for the DBF file. | ||
| + | |||
| + | <div newline></div> | ||
| + | ==== Protected Constructors ==== | ||
| ==== Public Methods ==== | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} GetRecord(Int32) ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#AddRecord(IEnumerable<Object>)|AddRecord]] | IEnumerable<Object> | | This method adds one record to the DBF file. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Close()|Close]] | | [[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin|MatchingPlugin]] | This method closes the MatchingPlugin. This method is the concrete wrapper for CloseCore. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#CreateDbf(String, IEnumerable<DbfMatchingPluginColumn>)|CreateDbf]] | String, IEnumerable<[[ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPluginColumn|DbfMatchingPluginColumn]]> | | This method creates a DBF file according to the specified file name and column names. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Dispose()|Dispose]] | | | Releases all resources used by the DbfMatchingPlugin. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetRecord(Int32)|GetRecord]] | Int32 | | This method gets a record by record index from the DBF file. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetRecords(Int32, Int32)|GetRecords]] | Int32, Int32 | | This method gets records by using the specified range. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Match(String)|Match]] | String | [[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin|MatchingPlugin]] | 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. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Open()|Open]] | | [[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin|MatchingPlugin]] | This method opens the MatchingPlugin for use. This method is the concrete wrapper for OpenCore. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | + | |
| + | * //This method gets a record by record index from the DBF file.// | ||
| + | == Remarks == | ||
| + | * //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 == | ||
| + | * Type:Dictionary<String,String> | ||
| + | * Description:The record value. | ||
| + | |||
| + | == Parameters == | ||
| + | * //recordNumber// | ||
| + | * Type:Int32 | ||
| + | * Description:This parameter is the record number. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetRecords(Int32,Int32) ** | ||
| + | |||
| + | * //This method gets records by using the specified range.// | ||
| + | == Remarks == | ||
| + | * //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 == | ||
| + | * Type:Collection<Dictionary<String,String>> | ||
| + | * Description:The collection of record values. | ||
| + | |||
| + | == Parameters == | ||
| + | * //firstRecordNumber// | ||
| + | * Type:Int32 | ||
| + | * Description:This parameter is the first record number to get. | ||
| + | |||
| + | * //count// | ||
| + | * Type:Int32 | ||
| + | * Description:This parameter is the record count to return. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} AddRecord(IEnumerable<Object>) ** | ||
| + | |||
| + | * //This method adds one record to the DBF file.// | ||
| + | == Remarks == | ||
| + | * //For the most updated Info for this topic, please check it here:// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //values// | ||
| + | * Type:IEnumerable<Object> | ||
| + | * Description:This parameter represents a record in the DBF file. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Dispose() ** | ||
| + | |||
| + | * //Releases all resources used by the DbfMatchingPlugin.// | ||
| + | == Remarks == | ||
| + | * //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 == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Match(String) ** | ||
| + | |||
| + | * //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 == | ||
| + | * //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 == | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch|GeocoderMatch]]> | ||
| + | * Description:A collection of GeocoderMatch. | ||
| + | |||
| + | == Parameters == | ||
| + | * //sourceText// | ||
| + | * Type:String | ||
| + | * Description:The source text to match. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Open() ** | ||
| + | |||
| + | * //This method opens the MatchingPlugin for use. This method is the concrete wrapper for OpenCore.// | ||
| + | == Remarks == | ||
| + | * //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 == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Close() ** | ||
| + | |||
| + | * //This method closes the MatchingPlugin. This method is the concrete wrapper for CloseCore.// | ||
| + | == Remarks == | ||
| + | * //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 == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //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 == | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //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 == | ||
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //obj// | ||
| + | * Type:Object | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //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 == | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //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 == | ||
| + | * Type:Type | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{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.// | ||
| + | == Remarks == | ||
| + | * //For the most updated Info for this topic, please check it here:// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:The newly-created DbfMatchingPlugIn object. | ||
| + | |||
| + | == Parameters == | ||
| + | * //pathFileName// | ||
| + | * Type:String | ||
| + | * Description:This parameter is the path and file name of the DBF file. | ||
| + | |||
| + | * //columnNames// | ||
| + | * Type:IEnumerable<[[ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPluginColumn|DbfMatchingPluginColumn]]> | ||
| + | * Description:This parameter is the collection of DbfColumnDefinition objects. | ||
| + | |||
| + | <div newline></div> | ||
| ==== Protected Methods ==== | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#BinarySearch(Int32, Int32, String, String)|BinarySearch]] | Int32, Int32, String, String | | This method does a binary search on the DBF file and returns the record it hits. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloseCore()|CloseCore]] | | [[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin|MatchingPlugin]](overriden) | This method closes the DbfMatchingPlugin. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object(overriden) | This method is automatically called after an object becomes inaccessible, unless the object has been exempted from finalization by a call to SuppressFinalize. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Formalize(String)|Formalize]] | String | [[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin|MatchingPlugin]] | This method formalizes the source text. This method is the concrete wrapper of FormalizeCore. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#FormalizeCore(String)|FormalizeCore]] | String | [[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin|MatchingPlugin]] | This method formalizes the source text. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetKeyColumnName()|GetKeyColumnName]] | | | This method gets the key column name from the DBF file. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MatchCore(String)|MatchCore]] | String | [[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin|MatchingPlugin]](overriden) | This method matches the source text and returns the collection of GeocoderMatch. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OpenCore()|OpenCore]] | | [[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin|MatchingPlugin]](overriden) | This method opens and initializes the DbfMatchingPlugin. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#SearchLowerBound(Int32, Int32, String, String)|SearchLowerBound]] | Int32, Int32, String, String | | This method gets the record number of the lower boundary of the matched results. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#SearchUpperBound(Int32, Int32, String, String)|SearchUpperBound]] | Int32, Int32, String, String | | This method gets the record number of the upper boundary of the matched results. | | + | |
| - | ==== Public Properties ==== | + | * //This method opens and initializes the DbfMatchingPlugin.// |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#PathFileName|PathFileName]] | String | | Gets and sets the path and file name of the DBF file to be used for Geocoding. | | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#OpenCore.28.29// |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RankingMultiplier|RankingMultiplier]] | Int32 | [[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin|MatchingPlugin]] | This property is the ranking multipier for GeocoderMatch. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ReadWriteMode|ReadWriteMode]] | [[ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPluginReadWriteMode|DbfMatchingPluginReadWriteMode]] | | The read/write mode for the DBF file. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RecordCount|RecordCount]] | Int32 | | This record count of the DBF file. | | + | |
| - | ==== Protected Properties ==== | + | == Return Value == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:Void |
| + | * Description:N/A | ||
| - | ==== Public Events ==== | + | == Parameters == |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ||
| - | ===== Public Constructors ===== | + | * //This method closes the DbfMatchingPlugin.// |
| - | ==== DbfMatchingPlugin() ==== | + | == Remarks == |
| - | This is the constructor of this class. | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#CloseCore.28.29// |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#DbfMatchingPlugin.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#DbfMatchingPlugin.28.29</a> | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | [[#Public Constructors|Go Back]] | + | == Return Value == |
| - | ==== DbfMatchingPlugin(String) ==== | + | * Type:Void |
| - | This is the construcor of this class. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#DbfMatchingPlugin.28String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#DbfMatchingPlugin.28String.29</a> | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | pathFileName | String<!-- System.String --> | The path and file name of the DBF file to be used for Geocoding. | | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ==== DbfMatchingPlugin(String, DbfMatchingPluginReadWriteMode) ==== | + | <div newline></div> |
| - | This is the construcor of this class. | + | ** {{wiki:ProtectedMethod.gif|}} MatchCore(String) ** |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#DbfMatchingPlugin.28String.2C_DbfMatchingPluginReadWriteMode.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#DbfMatchingPlugin.28String.2C_DbfMatchingPluginReadWriteMode.29</a> | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | pathFileName | String<!-- System.String --> | The path and file name of the index. | | + | |
| - | | readWriteMode | [[ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPluginReadWriteMode|DbfMatchingPluginReadWriteMode]]<!-- ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPluginReadWriteMode --> | The read/write mode for the DBF file. | | + | |
| - | [[#Public Constructors|Go Back]] | + | * //This method matches the source text and returns the collection of GeocoderMatch.// |
| - | ===== Protected Constructors ===== | + | == Remarks == |
| - | ===== Public Methods ===== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#MatchCore.28String.29// |
| - | ==== AddRecord(IEnumerable<Object>) ==== | + | |
| - | This method adds one record to the DBF file. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch|GeocoderMatch]]> |
| - | | values | IEnumerable<Object><!-- System.Collections.Generic.IEnumerable{System.Object} --> | This parameter represents a record in the DBF file. | | + | * Description:The collection of GeocoderMatch. |
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //sourceText// |
| - | ==== Close() ==== | + | * Type:String |
| - | This method closes the MatchingPlugin. This method is the concrete wrapper for CloseCore. | + | * Description:The source text to match. |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#Close.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#Close.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} SearchUpperBound(Int32,Int32,String,String) ** |
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin --> | + | * //This method gets the record number of the upper boundary of the matched results.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== CreateDbf(String, IEnumerable<DbfMatchingPluginColumn>) ==== | + | * //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// |
| - | <!-- static --> | + | |
| - | This method creates a DBF file according to the specified file name and column names. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | The newly-created DbfMatchingPlugIn object. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Int32 |
| - | | pathFileName | String<!-- System.String --> | This parameter is the path and file name of the DBF file. | | + | * Description:The record number of the upper boundary of the matched results. |
| - | | columnNames | IEnumerable<[[ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPluginColumn|DbfMatchingPluginColumn]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPluginColumn} --> | This parameter is the collection of DbfColumnDefinition objects. | | + | |
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //firstRecordNumber// |
| - | ==== Dispose() ==== | + | * Type:Int32 |
| - | Releases all resources used by the DbfMatchingPlugin. | + | * Description:The first record number for the search. |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#Dispose.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#Dispose.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //lastRecordNumber// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Int32 |
| + | * Description:The last record number for the search. | ||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin --> | + | * //sourceText// |
| - | [[#Public Methods|Go Back]] | + | * Type:String |
| - | ==== Equals(Object) ==== | + | * Description:The source text to search for. |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#Equals.28Object.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | * //columnName// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:String |
| - | | obj | Object<!-- System.Object --> | | | + | * Description:The name of the column on which the search is based. |
| - | <!-- System.Object --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} SearchLowerBound(Int32,Int32,String,String) ** |
| - | ==== GetHashCode() ==== | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#GetHashCode.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | | | + | |
| - | === Parameters === | + | * //This method gets the record number of the lower boundary of the matched results.// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //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// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ==== GetRecord(Int32) ==== | + | * Description:The record number of the lower boundary of the matched results. |
| - | This method gets a record by record index from the DBF file. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#GetRecord.28Int32.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#GetRecord.28Int32.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Dictionary<String,String><!-- System.Collections.Generic.Dictionary{System.String,System.String} --> | The record value. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //firstRecordNumber// |
| - | | recordNumber | Int32<!-- System.Int32 --> | This parameter is the record number. | | + | * Type:Int32 |
| + | * Description:The first record number for the search. | ||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin --> | + | * //lastRecordNumber// |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ==== GetRecords(Int32, Int32) ==== | + | * Description:The last record number for the search. |
| - | This method gets records by using the specified range. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#GetRecords.28Int32.2C_Int32.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#GetRecords.28Int32.2C_Int32.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<Dictionary<String,String>><!-- System.Collections.ObjectModel.Collection{System.Collections.Generic.Dictionary{System.String,System.String}} --> | The collection of record values. | | + | |
| - | === Parameters === | + | * //sourceText// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:String |
| - | | firstRecordNumber | Int32<!-- System.Int32 --> | This parameter is the first record number to get. | | + | * Description:The source text to search for. |
| - | | count | Int32<!-- System.Int32 --> | This parameter is the record count to return. | | + | |
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin --> | + | * //columnName// |
| - | [[#Public Methods|Go Back]] | + | * Type:String |
| - | ==== GetType() ==== | + | * Description:The name of the column on which the search is based. |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#GetType.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Type<!-- System.Type --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} GetKeyColumnName() ** |
| - | <!-- System.Object --> | + | * //This method gets the key column name from the DBF file.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== Match(String) ==== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#GetKeyColumnName.28.29// |
| - | 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 === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#Match.28String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#Match.28String.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch|GeocoderMatch]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch} --> | A collection of GeocoderMatch. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:String |
| - | | sourceText | String<!-- System.String --> | The source text to match. | | + | * Description:The key column name. |
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ==== Open() ==== | + | ** {{wiki:ProtectedMethod.gif|}} BinarySearch(Int32,Int32,String,String) ** |
| - | This method opens the MatchingPlugin for use. This method is the concrete wrapper for OpenCore. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#Open.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#Open.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //This method does a binary search on the DBF file and returns the record it hits.// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //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// | ||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Dictionary<String,String> |
| - | ==== ToString() ==== | + | * Description:The record hits in the search. |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#ToString.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //firstRecordNumber// |
| + | * Type:Int32 | ||
| + | * Description:The first record number for the search. | ||
| - | <!-- System.Object --> | + | * //lastRecordNumber// |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ===== Protected Methods ===== | + | * Description:The last record number for the search. |
| - | ==== BinarySearch(Int32, Int32, String, String) ==== | + | |
| - | This method does a binary search on the DBF file and returns the record it hits. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#BinarySearch.28Int32.2C_Int32.2C_String.2C_String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#BinarySearch.28Int32.2C_Int32.2C_String.2C_String.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Dictionary<String,String><!-- System.Collections.Generic.Dictionary{System.String,System.String} --> | The record hits in the search. | | + | |
| - | === Parameters === | + | * //sourceText// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:String |
| - | | firstRecordNumber | Int32<!-- System.Int32 --> | The first record number for the search. | | + | * Description:The source text to match. |
| - | | lastRecordNumber | Int32<!-- System.Int32 --> | The last record number for the search. | | + | |
| - | | sourceText | String<!-- System.String --> | The source text to match. | | + | |
| - | | columnName | String<!-- System.String --> | The name of the column on which the binaray search is based. | | + | |
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin --> | + | * //columnName// |
| - | [[#Protected Methods|Go Back]] | + | * Type:String |
| - | ==== CloseCore() ==== | + | * Description:The name of the column on which the binaray search is based. |
| - | This method closes the DbfMatchingPlugin. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#CloseCore.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#CloseCore.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin(overriden) --> | + | * //This method is automatically called after an object becomes inaccessible, unless the object has been exempted from finalization by a call to SuppressFinalize.// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== Finalize() ==== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#Finalize.28.29// |
| - | This method is automatically called after an object becomes inaccessible, unless the object has been exempted from finalization by a call to SuppressFinalize. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#Finalize.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| + | * Description:N/A | ||
| - | <!-- System.Object(overriden) --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | <div newline></div> |
| - | ==== Formalize(String) ==== | + | ** {{wiki:ProtectedMethod.gif|}} Formalize(String) ** |
| - | This method formalizes the source text. This method is the concrete wrapper of FormalizeCore. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#Formalize.28String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#Formalize.28String.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | The collection of formalized strings. | | + | |
| - | === Parameters === | + | * //This method formalizes the source text. This method is the concrete wrapper of FormalizeCore.// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | sourceText | String<!-- System.String --> | The source text to formalize. | | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#Formalize.28String.29// |
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Collection<String> |
| - | ==== FormalizeCore(String) ==== | + | * Description:The collection of formalized strings. |
| - | This method formalizes the source text. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#FormalizeCore.28String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#FormalizeCore.28String.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | The collection of formalized strings. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //sourceText// |
| - | | sourceText | String<!-- System.String --> | The source text to formalize. | | + | * Type:String |
| + | * Description:The source text to formalize. | ||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin --> | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} FormalizeCore(String) ** |
| - | ==== GetKeyColumnName() ==== | + | |
| - | This method gets the key column name from the DBF file. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#GetKeyColumnName.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#GetKeyColumnName.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | The key column name. | | + | |
| - | === Parameters === | + | * //This method formalizes the source text.// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#FormalizeCore.28String.29// | ||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Collection<String> |
| - | ==== MatchCore(String) ==== | + | * Description:The collection of formalized strings. |
| - | This method matches the source text and returns the collection of GeocoderMatch. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#MatchCore.28String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#MatchCore.28String.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch|GeocoderMatch]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch} --> | The collection of GeocoderMatch. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //sourceText// |
| - | | sourceText | String<!-- System.String --> | The source text to match. | | + | * Type:String |
| + | * Description:The source text to formalize. | ||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin(overriden) --> | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} oxM=(GeocoderMatch) ** |
| - | ==== MemberwiseClone() ==== | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#MemberwiseClone.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Void |
| - | ==== OpenCore() ==== | + | * Description:N/A |
| - | This method opens and initializes the DbfMatchingPlugin. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#OpenCore.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#OpenCore.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //geocoderMatch// |
| + | * Type:[[ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch|GeocoderMatch]] | ||
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin(overriden) --> | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
| - | ==== SearchLowerBound(Int32, Int32, String, String) ==== | + | |
| - | This method gets the record number of the lower boundary of the matched results. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#SearchLowerBound.28Int32.2C_Int32.2C_String.2C_String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#SearchLowerBound.28Int32.2C_Int32.2C_String.2C_String.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | The record number of the lower boundary of the matched results. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | firstRecordNumber | Int32<!-- System.Int32 --> | The first record number for the search. | | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#MemberwiseClone.28.29// |
| - | | lastRecordNumber | Int32<!-- System.Int32 --> | The last record number for the search. | | + | |
| - | | sourceText | String<!-- System.String --> | The source text to search for. | | + | |
| - | | columnName | String<!-- System.String --> | The name of the column on which the search is based. | | + | |
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Object |
| - | ==== SearchUpperBound(Int32, Int32, String, String) ==== | + | * Description:N/A |
| - | This method gets the record number of the upper boundary of the matched results. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#SearchUpperBound.28Int32.2C_Int32.2C_String.2C_String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#SearchUpperBound.28Int32.2C_Int32.2C_String.2C_String.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | The record number of the upper boundary of the matched results. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| - | | firstRecordNumber | Int32<!-- System.Int32 --> | The first record number for the search. | | + | ==== Public Properties ==== |
| - | | lastRecordNumber | Int32<!-- System.Int32 --> | The last record number for the search. | | + | ** {{wiki:PublicProperty.gif|}} PathFileName ** |
| - | | sourceText | String<!-- System.String --> | The source text to search for. | | + | |
| - | | columnName | String<!-- System.String --> | The name of the column on which the search is based. | | + | |
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== PathFileName ==== | ||
| 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 == |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#PathFileName" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#PathFileName</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 == |
| - | ^ Return Type ^ | + | * Type:String |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin --> | + | ** {{wiki:PublicProperty.gif|}} ReadWriteMode ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== RankingMultiplier ==== | + | |
| - | This property is the ranking multipier for GeocoderMatch. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#RankingMultiplier" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#RankingMultiplier</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Int32<!-- System.Int32 --> | | + | |
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== ReadWriteMode ==== | ||
| The read/write mode for the DBF file. | The read/write mode for the DBF file. | ||
| - | === Remarks === | + | == Remarks == |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#DbfMatchingPlugin.28String.2C_DbfMatchingPluginReadWriteMode.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#DbfMatchingPlugin.28String.2C_DbfMatchingPluginReadWriteMode.29</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 == |
| - | ^ Return Type ^ | + | * Type:[[ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPluginReadWriteMode|DbfMatchingPluginReadWriteMode]] |
| - | | [[ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPluginReadWriteMode|DbfMatchingPluginReadWriteMode]]<!-- ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPluginReadWriteMode --> | | + | |
| + | ** {{wiki:PublicProperty.gif|}} RecordCount ** | ||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== RecordCount ==== | ||
| This record count of the DBF file. | This record count of the DBF file. | ||
| - | === Remarks === | + | == Remarks == |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#RecordCount" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#RecordCount</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 == |
| - | ^ Return Type ^ | + | * Type:Int32 |
| - | | Int32<!-- System.Int32 --> | | + | |
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin --> | + | ** {{wiki:PublicProperty.gif|}} RankingMultiplier ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ===== Protected Properties ===== | + | This property is the ranking multipier for GeocoderMatch. |
| - | ===== Public Events ===== | + | == Remarks == |
| - | __NOTOC__ | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#RankingMultiplier |
| - | [[Category:MapSuiteGeocoder]] | + | == Return Value == |
| - | [[Category:ThinkGeo.MapSuite.MapSuiteGeocoder]] | + | * Type:Int32 |
| - | [[Category:UpdateDocumentation]] | + | |
| + | ==== Protected Properties ==== | ||
| + | ==== Public Events ==== | ||
thinkgeo.mapsuite.mapsuitegeocoder.dbfmatchingplugin.1440040131.txt.gz · Last modified: 2015/09/21 07:03 (external edit)