====== ThinkGeo.MapSuite.Geocoding.DbfMatchingPlugin ======


===== Inheritance Hierarchy =====
  *System.Object
    *ThinkGeo.MapSuite.Geocoding.MatchingPlugin
      ***ThinkGeo.MapSuite.Geocoding.DbfMatchingPlugin**
        *[[ThinkGeo.MapSuite.Geocoding.CensusBlockDbfMatchingPlugin]]
        *[[ThinkGeo.MapSuite.Geocoding.CensusBlockGroupDbfMatchingPlugin]]
        *[[ThinkGeo.MapSuite.Geocoding.CensusTractsDbfMatchingPlugin]]
        *[[ThinkGeo.MapSuite.Geocoding.CountyDbfMatchingPlugin]]
        *[[ThinkGeo.MapSuite.Geocoding.SoundexDbfMatchingPlugin]]
        *[[ThinkGeo.MapSuite.Geocoding.CityDbfMatchingPlugin]]
        *[[ThinkGeo.MapSuite.Geocoding.StateDbfMatchingPlugin]]
        *[[ThinkGeo.MapSuite.Geocoding.ZipDbfMatchingPlugin]]
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} DbfMatchingPlugin() **

  * //This is the constructor of this class.//
== Remarks ==
  * //N/A//
== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} DbfMatchingPlugin(String) **

  * //This is the construcor of this class.//
== Remarks ==
  * //N/A//
== 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 ==
  * //N/A//
== Parameters ==
  * //pathFileName//
    * Type:String
    * Description:The path and file name of the index.

  * //readWriteMode//
    * Type:[[ThinkGeo.MapSuite.Geocoding.DbfMatchingPluginReadWriteMode|DbfMatchingPluginReadWriteMode]]
    * Description:The read/write mode for the DBF file.

<div newline></div>
==== Protected Constructors ====
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} GetRecord(Int32) **

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

== 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) **

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

== 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>) **

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

== 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() **

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

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

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

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

== Return Value ==
  * Type:Collection<[[ThinkGeo.MapSuite.Geocoding.GeocoderMatch|GeocoderMatch]]>
  * Description:N/A

== Parameters ==
  * //sourceText//
    * Type:String
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} Open() **

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

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

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

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

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

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

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

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

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Equals(Object) **

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

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

== Parameters ==
  * //obj//
    * Type:Object
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} GetHashCode() **

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

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

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

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

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

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} CreateDbf(String,IEnumerable<DbfMatchingPluginColumn>) **

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

== 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.Geocoding.DbfMatchingPluginColumn|DbfMatchingPluginColumn]]>
    * Description:This parameter is the collection of DbfColumnDefinition objects.

<div newline></div>
===== Protected Methods =====
** {{wiki:ProtectedMethod.gif|}} OpenCore() **

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

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

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

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

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

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

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

== Return Value ==
  * Type:Collection<[[ThinkGeo.MapSuite.Geocoding.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) **

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

== 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) **

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

== 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() **

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

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

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

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

== 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() **

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

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

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

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

== Return Value ==
  * Type:Collection<String>
  * Description:N/A

== Parameters ==
  * //sourceText//
    * Type:String
    * Description:N/A

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

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

== Return Value ==
  * Type:Collection<String>
  * Description:N/A

== Parameters ==
  * //sourceText//
    * Type:String
    * Description:N/A

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

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

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

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

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

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

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

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

  * //N/A//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:String

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

  * //N/A//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Geocoding.DbfMatchingPluginReadWriteMode|DbfMatchingPluginReadWriteMode]]

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

  * //N/A//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:Int32

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

  * //N/A//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:Int32

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