thinkgeo.mapsuite.mapsuitegeocoder.matchingplugin
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.mapsuitegeocoder.matchingplugin [2015/09/21 07:03] admin |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin ====== | ||
| - | This class is the abstract class encapsulating matching operations. The MatchingPlugIn class is the key class in the Geocoder. It formalizes the source text using GeocoderFormalizer, tries to match in some kinds of datasets and returns a MatchResult object. MatchingPlugIn can work independently or can be combined to work together with others to accomplish complicated matching requirements. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | ***ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin** | ||
| - | *[[ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin]] | ||
| - | *[[ThinkGeo.MapSuite.MapSuiteGeocoder.IPAddressMatchingPlugin]] | ||
| - | *[[ThinkGeo.MapSuite.MapSuiteGeocoder.PostcodeDbfMatchingPlugin]] | ||
| - | *[[ThinkGeo.MapSuite.MapSuiteGeocoder.CoordinatesMatchingPlugin]] | ||
| - | *[[ThinkGeo.MapSuite.MapSuiteGeocoder.StreetMatchingPlugin]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ==== Protected Constructors ==== | ||
| - | ** {{wiki:ProtectedMethod.gif|}} MatchingPlugin() ** | ||
| - | |||
| - | This is the constructor of this class. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Public Methods ==== | ||
| - | ** {{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 == | ||
| - | N/A | ||
| - | |||
| - | == 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 == | ||
| - | N/A | ||
| - | |||
| - | == 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 == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //obj// | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Type | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Protected Methods ==== | ||
| - | ** {{wiki:ProtectedMethod.gif|}} MatchCore(String) ** | ||
| - | |||
| - | This method is an abstract method used to match source text. It will match the source text and return the result within a collection of GeocoderMatch. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == 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:ProtectedMethod.gif|}} Formalize(String) ** | ||
| - | |||
| - | This method formalizes the source text. This method is the concrete wrapper of FormalizeCore. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == 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 == | ||
| - | N/A | ||
| - | |||
| - | == 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|}} OpenCore() ** | ||
| - | |||
| - | This method opens the MatchingPlugin for use. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ||
| - | |||
| - | This method closes the MatchingPlugin. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <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|}} Finalize() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} CleanSourceText(String,IEnumerable<String>) ** | ||
| - | |||
| - | Cleans all special symbols present in the source text. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | * Description:The clean text with the specified strings removed. | ||
| - | |||
| - | == Parameters == | ||
| - | * //sourceText// | ||
| - | * Type:String | ||
| - | * Description:The source text need to formalize. | ||
| - | |||
| - | * //stringsToRemove// | ||
| - | * Type:IEnumerable<String> | ||
| - | * Description:The strings that need to be cleaned. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} pBM=(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> | ||
| - | ==== Public Properties ==== | ||
| - | ** {{wiki:PublicProperty.gif|}} RankingMultiplier ** | ||
| - | |||
| - | This property is the ranking multipier for GeocoderMatch. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ==== Public Events ==== | ||
thinkgeo.mapsuite.mapsuitegeocoder.matchingplugin.1442819029.txt.gz ยท Last modified: 2015/09/21 07:03 by admin
