User Tools

Site Tools


thinkgeo.mapsuite.mapsuitegeocoder.usageocoder

ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder

Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.

This class is for United States Geocoding.

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder
      • ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder

Members Summary

Public Constructors

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

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.

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:MatchMode
    • Description:This parameter represents the match mode.

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

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:MatchMode
    • Description:This parameter represents the match mode.
  • streetNumberMatchingMode

Protected Constructors

Public Methods

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<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.

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<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.

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

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

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<GeocoderMatch>
  • Description:A collection of GeocoderMatch.
Parameters
  • sourceText
    • Type:String
    • Description:Source text to match.

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

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

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

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

Protected Methods

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

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<GeocoderMatch>
  • Description:The matched results within a collection of GeocoderMatch.
Parameters
  • sourceText
    • Type:String
    • Description:The source text to match.

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<GeocoderMatch>
  • Description:The evaluated results within a collection of GeocoderMatch.
Parameters
  • sourceMatchItems
    • Type:IEnumerable<GeocoderMatch>
    • Description:The collection of GeocoderMatch.

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
Parameters
  • sourceMatchItems
    • Type:IEnumerable<GeocoderMatch>
    • Description:The collection of MatchItems.

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

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

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

Public Properties

MatchMode

This parameter represents the match mode.

Remarks
Return Value

StreetNumberMatchingMode

This parameter represents the street number matching mode mode.

Remarks
Return Value

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

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

Protected Properties

Public Events

thinkgeo.mapsuite.mapsuitegeocoder.usageocoder.txt · Last modified: 2017/03/16 21:59 (external edit)