====== ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder ======

{{section>upgrade_map_suite_to_10.0}}

This class is for United States Geocoding.
===== Inheritance Hierarchy =====
  *System.Object
    *ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder
      ***ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder**
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} UsaGeocoder() **

  * //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.UsaGeocoder#UsaGeocoder.28.29//
== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} UsaGeocoder(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.UsaGeocoder#UsaGeocoder.28String.29//
== Parameters ==
  * //dataPath//
    * Type:String
    * Description:The path to the Geocoder data folder.

<div newline></div>
** {{wiki:PublicMethod.gif|}} UsaGeocoder(String,MatchMode) **

  * //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.UsaGeocoder#UsaGeocoder.28String.2C_MatchMode.29//
== Parameters ==
  * //dataPath//
    * Type:String
    * Description:The path to the Geocoder data folder.

  * //matchMode//
    * Type:[[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchMode|MatchMode]]
    * Description:This parameter represents the match mode.

<div newline></div>
** {{wiki:PublicMethod.gif|}} UsaGeocoder(String,StreetNumberMatchingMode) **

  * //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.UsaGeocoder#UsaGeocoder.28String.2C_StreetNumberMatchingMode.29//
== Parameters ==
  * //dataPath//
    * Type:String
    * Description:The path to the Geocoder data folder.

  * //streetNumberMatchingMode//
    * Type:[[ThinkGeo.MapSuite.MapSuiteGeocoder.StreetNumberMatchingMode|StreetNumberMatchingMode]]
    * Description:This parameter represents the street number match mode.

<div newline></div>
** {{wiki:PublicMethod.gif|}} UsaGeocoder(String,MatchMode,StreetNumberMatchingMode) **

  * //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.UsaGeocoder#UsaGeocoder.28String.2C_MatchMode.2C_StreetNumberMatchingMode.29//
== Parameters ==
  * //dataPath//
    * Type:String
    * Description:The path to the Geocoder data folder.

  * //matchMode//
    * Type:[[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchMode|MatchMode]]
    * Description:This parameter represents the match mode.

  * //streetNumberMatchingMode//
    * Type:[[ThinkGeo.MapSuite.MapSuiteGeocoder.StreetNumberMatchingMode|StreetNumberMatchingMode]]
    * Description:This parameter represents the street number match mode.

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

  * //This method matches the specified street address and zip code.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#Match.28String.2C_String.29//

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

== Parameters ==
  * //streetAddress//
    * Type:String
    * Description:This parameter is the street address to match.

  * //zip//
    * Type:String
    * Description:This parameter is the zip code to match.

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

  * //This method matches the specified street address, city and state.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#Match.28String.2C_String.2C_String.29//

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

== Parameters ==
  * //streetAddress//
    * Type:String
    * Description:This parameter is the street address to match.

  * //city//
    * Type:String
    * Description:This parameter is the city to match.

  * //state//
    * Type:String
    * Description:This parameter is the state to match.

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

  * //This method opens the Geocoder so that it is initialized and ready to use.//
== Remarks ==
  * //This method is the concrete wrapper for the virtual method OpenCore.//

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

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

  * //This method closes the Geocoder and releases all of its resources.//
== Remarks ==
  * //This method is the concrete wrapper for the virtual method CloseCore.//

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

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

  * //This method matches the input source text.//
== Remarks ==
  * //This method is the concrete wrapper for the virtual method MatchCore.//

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

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

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

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

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

  * //Opens all of the internal MatchingPlugins.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#OpenCore.28.29//

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

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

  * //This method matches the source text.//
== Remarks ==
  * //This method calls the match method of each MatchingPlugIn object and then evaluates the match results from each MatchingPlugIn object to get the best match items.//

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

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

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

  * //This method evaluates the MatchItems from different MatchingPlugIns and gets the final MatchResult. This is a concrete wrapper for EvaluateMatchResultsCore.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here://

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

== Parameters ==
  * //sourceMatchItems//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch|GeocoderMatch]]>
    * Description:The collection of GeocoderMatch.

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

  * //This method evaluates the MatchItems from different MatchingPlugIns and gets the final MatchResult. This method adds all MatchItems into one list, then loops though and evaluates every two MatchItems, sorts the MatchItems by the MatchRanking property of the MatchItem, and finally adds them to MatchResult. When evaluating two MatchItems, if the name-value pairs of the two MatchItems have the same key and that key is in the compare key array, just compare the value. If the values are equal then use the MatchRanking plus the RankingMultiplier.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here://

== Return Value ==
  * Type:Collection<[[ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch|GeocoderMatch]]>
  * Description:MatchResult object.

== Parameters ==
  * //sourceMatchItems//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch|GeocoderMatch]]>
    * Description:The collection of MatchItems.

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

  * //This method closes the Geocoder and releases all of its resources. This method loops through each MatchingPlugIn object in the MatchingPlugIns collection to call their Close() method.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#CloseCore.28.29//

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

== Parameters ==
<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.UsaGeocoder#Finalize.28.29//

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

== Parameters ==
<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.UsaGeocoder#MemberwiseClone.28.29//

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

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

This parameter represents the match mode.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28String.2C_MatchMode.29
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchMode|MatchMode]]

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

This parameter represents the street number matching mode mode.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#UsaGeocoder.28String.2C_StreetNumberMatchingMode.29
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.MapSuiteGeocoder.StreetNumberMatchingMode|StreetNumberMatchingMode]]

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

The path to the Geocoder data folder.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#DataPath
== Return Value ==
  * Type:String

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

The collection of MatchingPlugIns.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder#MatchingPlugIns
== Return Value ==
  * Type:Collection<[[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin|MatchingPlugin]]>

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