ThinkGeo Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin ======



<!-- Class -->
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.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin</a>
===== Inheritance Hierarchy =====
*System.Object
**[[ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin]]
***[[ThinkGeo.MapSuite.MapSuiteGeocoder.CensusBlockDbfMatchingPlugin]]
***[[ThinkGeo.MapSuite.MapSuiteGeocoder.CensusBlockGroupDbfMatchingPlugin]]
***[[ThinkGeo.MapSuite.MapSuiteGeocoder.CensusTractsDbfMatchingPlugin]]
***[[ThinkGeo.MapSuite.MapSuiteGeocoder.CityDbfMatchingPlugin]]
***[[ThinkGeo.MapSuite.MapSuiteGeocoder.CoordinatesMatchingPlugin]]
***[[ThinkGeo.MapSuite.MapSuiteGeocoder.CountyDbfMatchingPlugin]]
***[[ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin]]
***[[ThinkGeo.MapSuite.MapSuiteGeocoder.IPAddressMatchingPlugin]]
***[[ThinkGeo.MapSuite.MapSuiteGeocoder.PostcodeDbfMatchingPlugin]]
***[[ThinkGeo.MapSuite.MapSuiteGeocoder.SoundexDbfMatchingPlugin]]
***[[ThinkGeo.MapSuite.MapSuiteGeocoder.StateDbfMatchingPlugin]]
***[[ThinkGeo.MapSuite.MapSuiteGeocoder.StreetMatchingPlugin]]
***[[ThinkGeo.MapSuite.MapSuiteGeocoder.ZipDbfMatchingPlugin]]
===== Members Summary =====
==== Public Constructors ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^

==== Protected Constructors ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MatchingPlugin()|MatchingPlugin]]   |    |    | This is the constructor of this class.   |

==== Public Methods ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:PublicMethod.gif|Public Method}}[[#Close()|Close]]   |    |    | This method closes the MatchingPlugin. This method is the concrete wrapper for CloseCore.   |
| {{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 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.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#Open()|Open]]   |    |    | This method opens the MatchingPlugin for use. This method is the concrete wrapper for OpenCore.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]]   |    | Object   |    |

==== Protected Methods ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:ProtectedMethod.gif|Protected Method}}{{wiki:Static.gif|Static Member}}[[#CleanSourceText(String, IEnumerable<String>)|CleanSourceText]]   | String, IEnumerable<String>   |    | Cleans all special symbols present in the source text.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloseCore()|CloseCore]]   |    |    | This method closes the MatchingPlugin.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Formalize(String)|Formalize]]   | String   |    | This method formalizes the source text. This method is the concrete wrapper of FormalizeCore.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#FormalizeCore(String)|FormalizeCore]]   | String   |    | This method formalizes the source text.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MatchCore(String)|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.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OpenCore()|OpenCore]]   |    |    | This method opens the MatchingPlugin for use.   |

==== Public Properties ====
^ Name ^ Return ^ DeclaringType ^ Summary ^
| {{wiki:PublicProperty.gif|Public Property}}[[#RankingMultiplier|RankingMultiplier]]   | Int32   |    | This property is the ranking multipier for GeocoderMatch.   |

==== Protected Properties ====
^ Name ^ Return ^ DeclaringType ^ Summary ^

==== Public Events ====
^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^

===== Public Constructors =====
===== Protected Constructors =====
==== MatchingPlugin() ====
This is the 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.MatchingPlugin#MatchingPlugin.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#MatchingPlugin.28.29</a>
=== Parameters ===
^  Name ^  Type ^  Description ^

[[#Protected Constructors|Go Back]]
===== Public Methods =====
==== Close() ====
This method closes the MatchingPlugin. This method is the concrete wrapper for CloseCore.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#Close.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#Close.28.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin -->
[[#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.MatchingPlugin#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#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.MatchingPlugin#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#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.MatchingPlugin#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#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 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 ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#Match.28String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#Match.28String.29</a>
=== 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 -->   | The source text to match.   |

<!-- ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin -->
[[#Public Methods|Go Back]]
==== Open() ====
This method opens the MatchingPlugin for use. This method is the concrete wrapper for OpenCore.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#Open.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#Open.28.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin -->
[[#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.MatchingPlugin#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#ToString.28.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| String<!-- System.String -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Public Methods|Go Back]]
===== Protected Methods =====
==== CleanSourceText(String, IEnumerable<String>) ====
<!-- static -->
Cleans all special symbols present in the source text.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a>
=== Return Value ===
^ Return Type ^ Description ^
| String<!-- System.String -->   | The clean text with the specified strings removed.   |

=== Parameters ===
^  Name ^  Type ^  Description ^
| sourceText   | String<!-- System.String -->   | The source text need to formalize.   |
| stringsToRemove   | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} -->   | The strings that need to be cleaned.   |

<!-- ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin -->
[[#Protected Methods|Go Back]]
==== CloseCore() ====
This method closes the MatchingPlugin.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#CloseCore.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#CloseCore.28.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin -->
[[#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.MatchingPlugin#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#Finalize.28.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Protected Methods|Go Back]]
==== Formalize(String) ====
This method formalizes the source text. This method is the concrete wrapper of FormalizeCore.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#Formalize.28String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#Formalize.28String.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} -->   | The collection of formalized strings.   |

=== Parameters ===
^  Name ^  Type ^  Description ^
| sourceText   | String<!-- System.String -->   | The source text to formalize.   |

<!-- ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin -->
[[#Protected Methods|Go Back]]
==== FormalizeCore(String) ====
This method formalizes the source text.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#FormalizeCore.28String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#FormalizeCore.28String.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} -->   | The collection of formalized strings.   |

=== Parameters ===
^  Name ^  Type ^  Description ^
| sourceText   | String<!-- System.String -->   | The source text to formalize.   |

<!-- ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin -->
[[#Protected Methods|Go Back]]
==== 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 ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#MatchCore.28String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#MatchCore.28String.29</a>
=== 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 -->   | The source text to match.   |

<!-- ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin -->
[[#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.MatchingPlugin#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#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 MatchingPlugin for use.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#OpenCore.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#OpenCore.28.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin -->
[[#Protected Methods|Go Back]]
===== Public Properties =====
==== RankingMultiplier ====
This property is the ranking multipier for GeocoderMatch.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#RankingMultiplier" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin#RankingMultiplier</a>
=== Return Value ===
^ Return Type ^
| Int32<!-- System.Int32 -->   |

<!-- ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin -->
[[#Public Properties|Go Back]]
===== Protected Properties =====
===== Public Events =====
__NOTOC__
[[Category:MapSuiteGeocoder]]
[[Category:ThinkGeo.MapSuite.MapSuiteGeocoder]]
[[Category:UpdateDocumentation]]
User Tools

Site Tools

Page Tools
