====== 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.
===== Inheritance Hierarchy =====
  *System.Object
    *ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin
      ***ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin**
        *[[ThinkGeo.MapSuite.MapSuiteGeocoder.CensusBlockDbfMatchingPlugin]]
        *[[ThinkGeo.MapSuite.MapSuiteGeocoder.CensusBlockGroupDbfMatchingPlugin]]
        *[[ThinkGeo.MapSuite.MapSuiteGeocoder.CensusTractsDbfMatchingPlugin]]
        *[[ThinkGeo.MapSuite.MapSuiteGeocoder.CountyDbfMatchingPlugin]]
        *[[ThinkGeo.MapSuite.MapSuiteGeocoder.SoundexDbfMatchingPlugin]]
        *[[ThinkGeo.MapSuite.MapSuiteGeocoder.CityDbfMatchingPlugin]]
        *[[ThinkGeo.MapSuite.MapSuiteGeocoder.StateDbfMatchingPlugin]]
        *[[ThinkGeo.MapSuite.MapSuiteGeocoder.ZipDbfMatchingPlugin]]
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} DbfMatchingPlugin() **

  * //This is the constructor 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.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 ====
** {{wiki:PublicMethod.gif|}} GetRecord(Int32) **

  * //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 ====
** {{wiki:ProtectedMethod.gif|}} OpenCore() **

  * //This method opens and initializes the DbfMatchingPlugin.//
== Remarks ==
  * //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 ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} CloseCore() **

  * //This method closes the DbfMatchingPlugin.//
== Remarks ==
  * //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 ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} MatchCore(String) **

  * //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:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#MatchCore.28String.29//

== Return Value ==
  * Type:Collection<[[ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch|GeocoderMatch]]>
  * Description:The collection of GeocoderMatch.

== Parameters ==
  * //sourceText//
    * Type:String
    * Description:The source text to match.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} SearchUpperBound(Int32,Int32,String,String) **

  * //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:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#SearchUpperBound.28Int32.2C_Int32.2C_String.2C_String.29//

== Return Value ==
  * Type:Int32
  * Description:The record number of the upper boundary of the matched results.

== Parameters ==
  * //firstRecordNumber//
    * Type:Int32
    * Description:The first record number for the search.

  * //lastRecordNumber//
    * Type:Int32
    * Description:The last record number for the search.

  * //sourceText//
    * Type:String
    * Description:The source text to search for.

  * //columnName//
    * Type:String
    * Description:The name of the column on which the search is based.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} 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:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#SearchLowerBound.28Int32.2C_Int32.2C_String.2C_String.29//

== Return Value ==
  * Type:Int32
  * Description:The record number of the lower boundary of the matched results.

== Parameters ==
  * //firstRecordNumber//
    * Type:Int32
    * Description:The first record number for the search.

  * //lastRecordNumber//
    * Type:Int32
    * Description:The last record number for the search.

  * //sourceText//
    * Type:String
    * Description:The source text to search for.

  * //columnName//
    * Type:String
    * Description:The name of the column on which the search is based.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} 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:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#GetKeyColumnName.28.29//

== Return Value ==
  * Type:String
  * Description:The key column name.

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} 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:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#BinarySearch.28Int32.2C_Int32.2C_String.2C_String.29//

== Return Value ==
  * Type:Dictionary<String,String>
  * Description:The record hits in the search.

== Parameters ==
  * //firstRecordNumber//
    * Type:Int32
    * Description:The first record number for the search.

  * //lastRecordNumber//
    * Type:Int32
    * Description:The last record number for the search.

  * //sourceText//
    * Type:String
    * Description:The source text to match.

  * //columnName//
    * Type:String
    * Description:The name of the column on which the binaray search is based.

<div newline></div>
** {{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.//
== Remarks ==
  * //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 ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{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:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#Formalize.28String.29//

== Return Value ==
  * Type:Collection<String>
  * Description:The collection of formalized strings.

== Parameters ==
  * //sourceText//
    * Type:String
    * Description:The source text to formalize.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} FormalizeCore(String) **

  * //This method formalizes the source text.//
== 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//

== Return Value ==
  * Type:Collection<String>
  * Description:The collection of formalized strings.

== Parameters ==
  * //sourceText//
    * Type:String
    * Description:The source text to formalize.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} oxM=(GeocoderMatch) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //geocoderMatch//
    * Type:[[ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch|GeocoderMatch]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **

  * //N/A//
== Remarks ==
  * //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 ==
  * Type:Object
  * Description:N/A

== Parameters ==
<div newline></div>
==== Public Properties ====
** {{wiki:PublicProperty.gif|}} PathFileName **

Gets and sets the path and file name of the DBF file to be used for Geocoding.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#PathFileName
== Return Value ==
  * Type:String

** {{wiki:PublicProperty.gif|}} ReadWriteMode **

The read/write mode for 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#DbfMatchingPlugin.28String.2C_DbfMatchingPluginReadWriteMode.29
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPluginReadWriteMode|DbfMatchingPluginReadWriteMode]]

** {{wiki:PublicProperty.gif|}} RecordCount **

This record count of 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#RecordCount
== Return Value ==
  * Type:Int32

** {{wiki:PublicProperty.gif|}} RankingMultiplier **

This property is the ranking multipier for GeocoderMatch.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin#RankingMultiplier
== Return Value ==
  * Type:Int32

==== Protected Properties ====
==== Public Events ====