This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.mapsuitegeocoder.geocodermatch [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.mapsuitegeocoder.geocodermatch [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch ====== | ====== ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch ====== | ||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | |||
| - | <!-- Class --> | ||
| This class represents single match result. | This class represents single match result. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch</a> | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch]] | + | ***ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch** |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} GeocoderMatch() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GeocoderMatch()|GeocoderMatch]] | | | This parameter is the constructor of this class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GeocoderMatch(Dictionary<String, String>)|GeocoderMatch]] | Dictionary<String, String> | | This is the constructor of this class. | | + | |
| - | ==== Protected Constructors ==== | + | * //This parameter is the constructor of this class.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#GeocoderMatch.28.29// | ||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GeocoderMatch(Dictionary<String,String>) ** | ||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Parameters == | ||
| + | * //nameValuePairs// | ||
| + | * Type:Dictionary<String,String> | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ==== Protected Constructors ==== | ||
| ==== Public Methods ==== | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} GetCentroidWkt() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetBoundingBoxWkt()|GetBoundingBoxWkt]] | | | Gets the WKT for bounding box. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetCentroidWkt()|GetCentroidWkt]] | | | Gets the WKT for the centroid point. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object(overriden) | Returns a formatted String that represents the current object. | | + | |
| - | ==== Protected Methods ==== | + | * //Gets the WKT for the centroid point.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#GetCentroidWkt.28.29// |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
| - | ==== Public Properties ==== | + | == Return Value == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:String |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]] | String | | The name of the GeocoderMatch. | | + | * Description:N/A |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#NameValuePairs|NameValuePairs]] | Dictionary<String,String> | | This property represents a dictionary that includes the name-value pairs. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Ranking|Ranking]] | Int32 | | This parameter represents the Ranking for the GeocoderMatch. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RankingMultiplier|RankingMultiplier]] | Int32 | | This parameter represents the ranking multiplier. The different GeocoderMatches from different MatchingPlugIns could have different ranking multipliers. For example, the GeocoderMatch from StreetDbfMatchingPlugIn could have a multiplier of 2 and the GeocoderMatch from ZipDbfMatchingPlugIn could have a multiplier of 1. | | + | |
| - | ==== Protected Properties ==== | + | == Parameters == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetBoundingBoxWkt() ** | ||
| - | ==== Public Events ==== | + | * //Gets the WKT for bounding box.// |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#GetBoundingBoxWkt.28.29// | ||
| - | ===== Public Constructors ===== | + | == Return Value == |
| - | ==== GeocoderMatch() ==== | + | * Type:String |
| - | This parameter is the constructor of this class. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#GeocoderMatch.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#GeocoderMatch.28.29</a> | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ==== GeocoderMatch(Dictionary<String, String>) ==== | + | <div newline></div> |
| - | This is the constructor of this class. | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a> | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | nameValuePairs | Dictionary<String,String><!-- System.Collections.Generic.Dictionary{System.String,System.String} --> | This parameter is a dictionary that includes the name-value pairs. | | + | |
| - | [[#Public Constructors|Go Back]] | + | * //Returns a formatted String that represents the current object.// |
| - | ===== Protected Constructors ===== | + | == Remarks == |
| - | ===== Public Methods ===== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#ToString.28.29// |
| - | ==== 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.GeocoderMatch#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#Equals.28Object.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:String |
| - | | obj | Object<!-- System.Object --> | | | + | * Description:A String that represents the name-value pairs of the current GeocoderMatch. |
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ==== GetBoundingBoxWkt() ==== | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| - | Gets the WKT for bounding box. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#GetBoundingBoxWkt.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#GetBoundingBoxWkt.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#Equals.28Object.29// | ||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Boolean |
| - | ==== GetCentroidWkt() ==== | + | * Description:N/A |
| - | Gets the WKT for the centroid point. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#GetCentroidWkt.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#GetCentroidWkt.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //obj// |
| + | * Type:Object | ||
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | ==== GetHashCode() ==== | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#GetHashCode.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#GetHashCode.28.29// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ==== GetType() ==== | + | * Description:N/A |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#GetType.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Type<!-- System.Type --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== ToString() ==== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#GetType.28.29// |
| - | Returns a formatted String that represents the current object. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#ToString.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | A String that represents the name-value pairs of the current GeocoderMatch. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Type |
| + | * Description:N/A | ||
| - | <!-- System.Object(overriden) --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ===== Protected Methods ===== | + | ==== Protected Methods ==== |
| - | ==== Finalize() ==== | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#Finalize.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#Finalize.28.29// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Void |
| - | ==== MemberwiseClone() ==== | + | * Description:N/A |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#MemberwiseClone.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ===== Public Properties ===== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#MemberwiseClone.28.29// |
| - | ==== Name ==== | + | |
| - | The name of the GeocoderMatch. | + | == Return Value == |
| - | === Remarks === | + | * Type:Object |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#Name" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#Name</a> | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | == Parameters == |
| - | | String<!-- System.String --> | | + | <div newline></div> |
| + | ==== Public Properties ==== | ||
| + | ** {{wiki:PublicProperty.gif|}} NameValuePairs ** | ||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== NameValuePairs ==== | ||
| This property represents a dictionary that includes the name-value pairs. | This property represents a dictionary that includes the name-value pairs. | ||
| - | === Remarks === | + | == Remarks == |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#NameValuePairs" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#NameValuePairs</a> | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#NameValuePairs |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:Dictionary<String,String> |
| - | | Dictionary<String,String><!-- System.Collections.Generic.Dictionary{System.String,System.String} --> | | + | |
| + | ** {{wiki:PublicProperty.gif|}} Ranking ** | ||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Ranking ==== | ||
| This parameter represents the Ranking for the GeocoderMatch. | This parameter represents the Ranking for the GeocoderMatch. | ||
| - | === Remarks === | + | == Remarks == |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#Ranking" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#Ranking</a> | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#Ranking |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:Int32 |
| - | | Int32<!-- System.Int32 --> | | + | |
| + | ** {{wiki:PublicProperty.gif|}} RankingMultiplier ** | ||
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== RankingMultiplier ==== | ||
| This parameter represents the ranking multiplier. The different GeocoderMatches from different MatchingPlugIns could have different ranking multipliers. For example, the GeocoderMatch from StreetDbfMatchingPlugIn could have a multiplier of 2 and the GeocoderMatch from ZipDbfMatchingPlugIn could have a multiplier of 1. | This parameter represents the ranking multiplier. The different GeocoderMatches from different MatchingPlugIns could have different ranking multipliers. For example, the GeocoderMatch from StreetDbfMatchingPlugIn could have a multiplier of 2 and the GeocoderMatch from ZipDbfMatchingPlugIn could have a multiplier of 1. | ||
| - | === Remarks === | + | == Remarks == |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#RankingMultiplier" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#RankingMultiplier</a> | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#RankingMultiplier |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:Int32 |
| - | | Int32<!-- System.Int32 --> | | + | |
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch --> | + | ** {{wiki:PublicProperty.gif|}} Name ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ===== Protected Properties ===== | + | The name of the GeocoderMatch. |
| - | ===== Public Events ===== | + | == Remarks == |
| - | __NOTOC__ | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch#Name |
| - | [[Category:MapSuiteGeocoder]] | + | == Return Value == |
| - | [[Category:ThinkGeo.MapSuite.MapSuiteGeocoder]] | + | * Type:String |
| - | [[Category:UpdateDocumentation]] | + | |
| + | ==== Protected Properties ==== | ||
| + | ==== Public Events ==== | ||