====== ThinkGeo.MapSuite.MapSuiteGeocoder.SoundexDbfMatchingPlugin ======

{{section>upgrade_map_suite_to_10.0}}

This class implements soundex matching operations. There are two columns in the DBF file that are necessary for soundex matching. The first is the soundex value generated by certain Soundex algorithms (by default this is implemented by SimplifiedSoundex). The second is the exact value.
===== Inheritance Hierarchy =====
  *System.Object
    *ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin
      *ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin
        ***ThinkGeo.MapSuite.MapSuiteGeocoder.SoundexDbfMatchingPlugin**
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} SoundexDbfMatchingPlugin() **

  * //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.SoundexDbfMatchingPlugin#SoundexDbfMatchingPlugin.28.29//
== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} SoundexDbfMatchingPlugin(String,String) **

  * //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.SoundexDbfMatchingPlugin#SoundexDbfMatchingPlugin.28String.2C_String.29//
== Parameters ==
  * //pathFileName//
    * Type:String
    * Description:This parameter is path and file name of the index.

  * //soundexRealValueColumnName//
    * Type:String
    * Description:This parameter is the column name for the real value.

<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.SoundexDbfMatchingPlugin#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.SoundexDbfMatchingPlugin#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.SoundexDbfMatchingPlugin#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.SoundexDbfMatchingPlugin#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.SoundexDbfMatchingPlugin#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.SoundexDbfMatchingPlugin#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.SoundexDbfMatchingPlugin#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.SoundexDbfMatchingPlugin#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.SoundexDbfMatchingPlugin#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.SoundexDbfMatchingPlugin#GetType.28.29//

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

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

  * //This method matches source text in corresponding index files. This function tries to get all MatchItems by using binary searching in MatchDbf, but there could be many inaccurate results returned because of Soundex. Thus, it loops through each MatchItem, calculates the ditance between the result and the source according to the Levenshteins algorithm, then finds the result with the shortest distance.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.SoundexDbfMatchingPlugin#MatchCore.28String.29//

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

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

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.SoundexDbfMatchingPlugin#OpenCore.28.29//

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

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.SoundexDbfMatchingPlugin#CloseCore.28.29//

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

== Parameters ==
<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.SoundexDbfMatchingPlugin#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.SoundexDbfMatchingPlugin#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.SoundexDbfMatchingPlugin#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.SoundexDbfMatchingPlugin#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() **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.SoundexDbfMatchingPlugin#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.SoundexDbfMatchingPlugin#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.SoundexDbfMatchingPlugin#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.SoundexDbfMatchingPlugin#MemberwiseClone.28.29//

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

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

This property is the column name for the real value.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.SoundexDbfMatchingPlugin#SoundexRealValueColumnName
== Return Value ==
  * Type:String

** {{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.SoundexDbfMatchingPlugin#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.SoundexDbfMatchingPlugin#ReadWriteMode
== 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.SoundexDbfMatchingPlugin#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.SoundexDbfMatchingPlugin#RankingMultiplier
== Return Value ==
  * Type:Int32

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