thinkgeo.mapsuite.mapsuitegeocoder.geocoder
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.mapsuitegeocoder.geocoder [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | This class is the base class for Geocoding. | ||
| - | === Remarks === | ||
| - | This class provides a basic implementation for Geocoding that contains a MatchingPlugIn object collection. You can inherit from it for specific Geocoding requirements by adding MatchingPlugIn objects. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | **[[ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder]] | ||
| - | ***[[ThinkGeo.MapSuite.MapSuiteGeocoder.UsaGeocoder]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Geocoder()|Geocoder]] | | | Constructor of this class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Geocoder(String)|Geocoder]] | String | | Geocoder constructor. | | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Close()|Close]] | | | This method closes the Geocoder and releases all of its resources. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Match(String)|Match]] | String | | This method matches the input source text. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Open()|Open]] | | | This method opens the Geocoder so that it is initialized and ready to use. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | ||
| - | |||
| - | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloseCore()|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. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MatchCore(String)|MatchCore]] | String | | This method matches the input source text. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OpenCore()|OpenCore]] | | | This method opens the Geocoder so that it is initialized and ready to use. This method loops through each MatchingPlugIn object in the MatchingPlugIns collection to call their Open() method. | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DataPath|DataPath]] | String | | The path to the Geocoder data folder. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#MatchingPlugIns|MatchingPlugIns]] | Collection<[[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin|MatchingPlugin]]> | | The collection of MatchingPlugIns. | | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ==== Geocoder() ==== | ||
| - | Constructor of this class. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#Geocoder.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#Geocoder.28.29</a> | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== Geocoder(String) ==== | ||
| - | Geocoder constructor. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#Geocoder.28String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#Geocoder.28String.29</a> | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | dataPath | String<!-- System.String --> | The path to the Geocoder data folder. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | ==== 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 === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Equals(Object) ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#Equals.28Object.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHashCode() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#GetHashCode.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#GetType.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Match(String) ==== | ||
| - | This method matches the input source text. | ||
| - | === Remarks === | ||
| - | This method is the concrete wrapper for the virtual method MatchCore. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Collection<[[ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch|GeocoderMatch]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch} --> | A collection of GeocoderMatch. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | sourceText | String<!-- System.String --> | Source text to match. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== 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 === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToString() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#ToString.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#CloseCore.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#CloseCore.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== Finalize() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#Finalize.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MatchCore(String) ==== | ||
| - | This method matches the input source text. | ||
| - | === Remarks === | ||
| - | This method loops through each MatchingPlugIn objects in MatchingPlugIns collection, calls their Match() method and gets all GeocoderMatches. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Collection<[[ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch|GeocoderMatch]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch} --> | A collection of GeocoderMatch. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | sourceText | String<!-- System.String --> | Source text to match. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#MemberwiseClone.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OpenCore() ==== | ||
| - | This method opens the Geocoder so that it is initialized and ready to use. This method loops through each MatchingPlugIn object in the MatchingPlugIns collection to call their Open() method. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#OpenCore.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#OpenCore.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== DataPath ==== | ||
| - | The path to the Geocoder data folder. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#DataPath" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#DataPath</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== MatchingPlugIns ==== | ||
| - | The collection of MatchingPlugIns. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#MatchingPlugIns" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder#MatchingPlugIns</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Collection<[[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin|MatchingPlugin]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.Geocoder --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ===== Public Events ===== | ||
| - | __NOTOC__ | ||
| - | [[Category:MapSuiteGeocoder]] | ||
| - | [[Category:ThinkGeo.MapSuite.MapSuiteGeocoder]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.mapsuitegeocoder.geocoder.1440040131.txt.gz ยท Last modified: 2015/09/21 07:03 (external edit)
