This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.mapsuitegeocoder.censusblockgroupdbfmatchingplugin [2015/09/21 07:03] admin |
thinkgeo.mapsuite.mapsuitegeocoder.censusblockgroupdbfmatchingplugin [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.MapSuiteGeocoder.CensusBlockGroupDbfMatchingPlugin ====== | ====== ThinkGeo.MapSuite.MapSuiteGeocoder.CensusBlockGroupDbfMatchingPlugin ====== | ||
+ | |||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
+ | |||
This is the derived class of the class DbfMatchingPlugIn for matching Census Block Group areas. | This is the derived class of the class DbfMatchingPlugIn for matching Census Block Group areas. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
Line 10: | Line 13: | ||
** {{wiki:PublicMethod.gif|}} CensusBlockGroupDbfMatchingPlugin() ** | ** {{wiki:PublicMethod.gif|}} CensusBlockGroupDbfMatchingPlugin() ** | ||
- | 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.CensusBlockGroupDbfMatchingPlugin#CensusBlockGroupDbfMatchingPlugin.28.29// |
== Parameters == | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
** {{wiki:PublicMethod.gif|}} CensusBlockGroupDbfMatchingPlugin(String) ** | ** {{wiki:PublicMethod.gif|}} CensusBlockGroupDbfMatchingPlugin(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.CensusBlockGroupDbfMatchingPlugin#CensusBlockGroupDbfMatchingPlugin.28String.29// |
== Parameters == | == Parameters == | ||
* //pathFileName// | * //pathFileName// | ||
Line 30: | Line 33: | ||
** {{wiki:PublicMethod.gif|}} GetRecord(Int32) ** | ** {{wiki:PublicMethod.gif|}} GetRecord(Int32) ** | ||
- | N/A | + | * //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.CensusBlockGroupDbfMatchingPlugin#GetRecord.28Int32.29// |
== Return Value == | == Return Value == | ||
* Type:Dictionary<String,String> | * Type:Dictionary<String,String> | ||
- | * Description:N/A | + | * Description:The record value. |
== Parameters == | == Parameters == | ||
* //recordNumber// | * //recordNumber// | ||
* Type:Int32 | * Type:Int32 | ||
- | * Description:N/A | + | * Description:This parameter is the record number. |
<div newline></div> | <div newline></div> | ||
** {{wiki:PublicMethod.gif|}} GetRecords(Int32,Int32) ** | ** {{wiki:PublicMethod.gif|}} GetRecords(Int32,Int32) ** | ||
- | N/A | + | * //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.CensusBlockGroupDbfMatchingPlugin#GetRecords.28Int32.2C_Int32.29// |
== Return Value == | == Return Value == | ||
* Type:Collection<Dictionary<String,String>> | * Type:Collection<Dictionary<String,String>> | ||
- | * Description:N/A | + | * Description:The collection of record values. |
== Parameters == | == Parameters == | ||
* //firstRecordNumber// | * //firstRecordNumber// | ||
* Type:Int32 | * Type:Int32 | ||
- | * Description:N/A | + | * Description:This parameter is the first record number to get. |
* //count// | * //count// | ||
* Type:Int32 | * Type:Int32 | ||
- | * Description:N/A | + | * Description:This parameter is the record count to return. |
<div newline></div> | <div newline></div> | ||
** {{wiki:PublicMethod.gif|}} AddRecord(IEnumerable<Object>) ** | ** {{wiki:PublicMethod.gif|}} AddRecord(IEnumerable<Object>) ** | ||
- | N/A | + | * //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 77: | Line 80: | ||
* //values// | * //values// | ||
* Type:IEnumerable<Object> | * Type:IEnumerable<Object> | ||
- | * Description:N/A | + | * Description:This parameter represents a record in the DBF file. |
<div newline></div> | <div newline></div> | ||
** {{wiki:PublicMethod.gif|}} Dispose() ** | ** {{wiki:PublicMethod.gif|}} Dispose() ** | ||
- | N/A | + | * //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.CensusBlockGroupDbfMatchingPlugin#Dispose.28.29// |
== Return Value == | == Return Value == | ||
Line 94: | Line 97: | ||
** {{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.CensusBlockGroupDbfMatchingPlugin#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.CensusBlockGroupDbfMatchingPlugin#Open.28.29// |
== Return Value == | == Return Value == | ||
Line 122: | Line 125: | ||
** {{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.CensusBlockGroupDbfMatchingPlugin#Close.28.29// |
== Return Value == | == Return Value == | ||
Line 134: | Line 137: | ||
** {{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.CensusBlockGroupDbfMatchingPlugin#ToString.28.29// |
== Return Value == | == Return Value == | ||
Line 146: | Line 149: | ||
** {{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.CensusBlockGroupDbfMatchingPlugin#Equals.28Object.29// |
== Return Value == | == Return Value == | ||
Line 162: | Line 165: | ||
** {{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.CensusBlockGroupDbfMatchingPlugin#GetHashCode.28.29// |
== Return Value == | == Return Value == | ||
Line 174: | Line 177: | ||
** {{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.CensusBlockGroupDbfMatchingPlugin#GetType.28.29// |
== Return Value == | == Return Value == | ||
Line 187: | Line 190: | ||
** {{wiki:ProtectedMethod.gif|}} FormalizeCore(String) ** | ** {{wiki:ProtectedMethod.gif|}} FormalizeCore(String) ** | ||
- | This method formalizes source text to get possible census blocks. | + | * //This method formalizes source text to get possible census blocks.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.CensusBlockGroupDbfMatchingPlugin#FormalizeCore.28String.29// |
== Return Value == | == Return Value == | ||
Line 203: | Line 206: | ||
** {{wiki:ProtectedMethod.gif|}} MatchCore(String) ** | ** {{wiki:ProtectedMethod.gif|}} MatchCore(String) ** | ||
- | This method matches the source text and returns a result with a collection of GeocoderMatch. | + | * //This method matches the source text and returns a result with a 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.CensusBlockGroupDbfMatchingPlugin#MatchCore.28String.29// |
== Return Value == | == Return Value == | ||
Line 219: | Line 222: | ||
** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ||
- | 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.CensusBlockGroupDbfMatchingPlugin#OpenCore.28.29// |
== Return Value == | == Return Value == | ||
Line 231: | Line 234: | ||
** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ||
- | 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.CensusBlockGroupDbfMatchingPlugin#CloseCore.28.29// |
== Return Value == | == Return Value == | ||
Line 243: | Line 246: | ||
** {{wiki:ProtectedMethod.gif|}} SearchUpperBound(Int32,Int32,String,String) ** | ** {{wiki:ProtectedMethod.gif|}} SearchUpperBound(Int32,Int32,String,String) ** | ||
- | N/A | + | * //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.CensusBlockGroupDbfMatchingPlugin#SearchUpperBound.28Int32.2C_Int32.2C_String.2C_String.29// |
== Return Value == | == Return Value == | ||
* Type:Int32 | * Type:Int32 | ||
- | * Description:N/A | + | * Description:The record number of the upper boundary of the matched results. |
== Parameters == | == Parameters == | ||
* //firstRecordNumber// | * //firstRecordNumber// | ||
* Type:Int32 | * Type:Int32 | ||
- | * Description:N/A | + | * Description:The first record number for the search. |
* //lastRecordNumber// | * //lastRecordNumber// | ||
* Type:Int32 | * Type:Int32 | ||
- | * Description:N/A | + | * Description:The last record number for the search. |
* //sourceText// | * //sourceText// | ||
* Type:String | * Type:String | ||
- | * Description:N/A | + | * Description:The source text to search for. |
* //columnName// | * //columnName// | ||
* Type:String | * Type:String | ||
- | * Description:N/A | + | * Description:The name of the column on which the search is based. |
<div newline></div> | <div newline></div> | ||
** {{wiki:ProtectedMethod.gif|}} SearchLowerBound(Int32,Int32,String,String) ** | ** {{wiki:ProtectedMethod.gif|}} SearchLowerBound(Int32,Int32,String,String) ** | ||
- | N/A | + | * //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.CensusBlockGroupDbfMatchingPlugin#SearchLowerBound.28Int32.2C_Int32.2C_String.2C_String.29// |
== Return Value == | == Return Value == | ||
* Type:Int32 | * Type:Int32 | ||
- | * Description:N/A | + | * Description:The record number of the lower boundary of the matched results. |
== Parameters == | == Parameters == | ||
* //firstRecordNumber// | * //firstRecordNumber// | ||
* Type:Int32 | * Type:Int32 | ||
- | * Description:N/A | + | * Description:The first record number for the search. |
* //lastRecordNumber// | * //lastRecordNumber// | ||
* Type:Int32 | * Type:Int32 | ||
- | * Description:N/A | + | * Description:The last record number for the search. |
* //sourceText// | * //sourceText// | ||
* Type:String | * Type:String | ||
- | * Description:N/A | + | * Description:The source text to search for. |
* //columnName// | * //columnName// | ||
* Type:String | * Type:String | ||
- | * Description:N/A | + | * Description:The name of the column on which the search is based. |
<div newline></div> | <div newline></div> | ||
** {{wiki:ProtectedMethod.gif|}} GetKeyColumnName() ** | ** {{wiki:ProtectedMethod.gif|}} GetKeyColumnName() ** | ||
- | N/A | + | * //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.CensusBlockGroupDbfMatchingPlugin#GetKeyColumnName.28.29// |
== Return Value == | == Return Value == | ||
* Type:String | * Type:String | ||
- | * Description:N/A | + | * Description:The key column name. |
== Parameters == | == Parameters == | ||
Line 311: | Line 314: | ||
** {{wiki:ProtectedMethod.gif|}} BinarySearch(Int32,Int32,String,String) ** | ** {{wiki:ProtectedMethod.gif|}} BinarySearch(Int32,Int32,String,String) ** | ||
- | N/A | + | * //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.CensusBlockGroupDbfMatchingPlugin#BinarySearch.28Int32.2C_Int32.2C_String.2C_String.29// |
== Return Value == | == Return Value == | ||
* Type:Dictionary<String,String> | * Type:Dictionary<String,String> | ||
- | * Description:N/A | + | * Description:The record hits in the search. |
== Parameters == | == Parameters == | ||
* //firstRecordNumber// | * //firstRecordNumber// | ||
* Type:Int32 | * Type:Int32 | ||
- | * Description:N/A | + | * Description:The first record number for the search. |
* //lastRecordNumber// | * //lastRecordNumber// | ||
* Type:Int32 | * Type:Int32 | ||
- | * Description:N/A | + | * Description:The last record number for the search. |
* //sourceText// | * //sourceText// | ||
* Type:String | * Type:String | ||
- | * Description:N/A | + | * Description:The source text to match. |
* //columnName// | * //columnName// | ||
* Type:String | * Type:String | ||
- | * Description:N/A | + | * Description:The name of the column on which the binaray search is based. |
<div newline></div> | <div newline></div> | ||
** {{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.CensusBlockGroupDbfMatchingPlugin#Finalize.28.29// |
== Return Value == | == Return Value == | ||
Line 351: | Line 354: | ||
** {{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.CensusBlockGroupDbfMatchingPlugin#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 383: | Line 386: | ||
** {{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.CensusBlockGroupDbfMatchingPlugin#MemberwiseClone.28.29// |
== Return Value == | == Return Value == | ||
Line 396: | Line 399: | ||
** {{wiki:PublicProperty.gif|}} PathFileName ** | ** {{wiki:PublicProperty.gif|}} PathFileName ** | ||
- | N/A | + | 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.CensusBlockGroupDbfMatchingPlugin#PathFileName |
== Return Value == | == Return Value == | ||
* Type:String | * Type:String | ||
Line 404: | Line 407: | ||
** {{wiki:PublicProperty.gif|}} ReadWriteMode ** | ** {{wiki:PublicProperty.gif|}} ReadWriteMode ** | ||
- | N/A | + | 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.CensusBlockGroupDbfMatchingPlugin#ReadWriteMode |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPluginReadWriteMode|DbfMatchingPluginReadWriteMode]] | * Type:[[ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPluginReadWriteMode|DbfMatchingPluginReadWriteMode]] | ||
Line 412: | Line 415: | ||
** {{wiki:PublicProperty.gif|}} RecordCount ** | ** {{wiki:PublicProperty.gif|}} RecordCount ** | ||
- | N/A | + | 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.CensusBlockGroupDbfMatchingPlugin#RecordCount |
== Return Value == | == Return Value == | ||
* Type:Int32 | * Type:Int32 | ||
Line 420: | Line 423: | ||
** {{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.CensusBlockGroupDbfMatchingPlugin#RankingMultiplier |
== Return Value == | == Return Value == | ||
* Type:Int32 | * Type:Int32 |