User Tools

Site Tools


thinkgeo.mapsuite.mapsuitegeocoder.zipdbfmatchingplugin

This is an old revision of the document!


ThinkGeo.MapSuite.MapSuiteGeocoder.ZipDbfMatchingPlugin

<!– Class –> This class implements functions for matching zip codes.

Remarks

Inheritance Hierarchy

Members Summary

Public Constructors

Name Parameters DeclaringType Summary
Public MethodZipDbfMatchingPlugin This is the constructor of this class.
Public MethodZipDbfMatchingPlugin String This is the constructor of this class.

Protected Constructors

Name Parameters DeclaringType Summary

Public Methods

Name Parameters DeclaringType Summary
Public MethodAddRecord IEnumerable<Object> DbfMatchingPlugin This method adds one record to the DBF file.
Public MethodClose MatchingPlugin This method closes the MatchingPlugin. This method is the concrete wrapper for CloseCore.
Public MethodStatic MemberCreateDbf String, IEnumerable<DbfMatchingPluginColumn> DbfMatchingPlugin This method creates a DBF file according to the specified file name and column names.
Public MethodDispose DbfMatchingPlugin Releases all resources used by the DbfMatchingPlugin.
Public MethodEquals Object Object
Public MethodGetHashCode Object
Public MethodGetRecord Int32 DbfMatchingPlugin This method gets a record by record index from the DBF file.
Public MethodGetRecords Int32, Int32 DbfMatchingPlugin This method gets records by using the specified range.
Public MethodGetType Object
Public MethodMatch String MatchingPlugin 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.
Public MethodOpen MatchingPlugin This method opens the MatchingPlugin for use. This method is the concrete wrapper for OpenCore.
Public MethodToString Object

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodBinarySearch Int32, Int32, String, String DbfMatchingPlugin This method does a binary search on the DBF file and returns the record it hits.
Protected MethodCloseCore MatchingPlugin(overriden)
Protected MethodFinalize Object(overriden)
Protected MethodFormalize String MatchingPlugin This method formalizes the source text. This method is the concrete wrapper of FormalizeCore.
Protected MethodFormalizeCore String MatchingPlugin(overriden) This method formalizes the source text to get possible zip codes.
Protected MethodGetKeyColumnName DbfMatchingPlugin This method gets the key column name from the DBF file.
Protected MethodMatchCore String MatchingPlugin(overriden)
Protected MethodMemberwiseClone Object
Protected MethodOpenCore MatchingPlugin(overriden)
Protected MethodSearchLowerBound Int32, Int32, String, String DbfMatchingPlugin This method gets the record number of the lower boundary of the matched results.
Protected MethodSearchUpperBound Int32, Int32, String, String DbfMatchingPlugin This method gets the record number of the upper boundary of the matched results.

Public Properties

Name Return DeclaringType Summary
Public PropertyPathFileName String DbfMatchingPlugin Gets and sets the path and file name of the DBF file to be used for Geocoding.
Public PropertyRankingMultiplier Int32 MatchingPlugin This property is the ranking multipier for GeocoderMatch.
Public PropertyReadWriteMode DbfMatchingPluginReadWriteMode DbfMatchingPlugin The read/write mode for the DBF file.
Public PropertyRecordCount Int32 DbfMatchingPlugin This record count of the DBF file.

Protected Properties

Name Return DeclaringType Summary

Public Events

Name Event Arguments DeclaringType Summary

Public Constructors

ZipDbfMatchingPlugin()

This is the constructor of this class.

Remarks

Parameters

Name Type Description

Go Back

ZipDbfMatchingPlugin(String)

This is the constructor of this class.

Remarks

Parameters

Name Type Description
pathFileName String<!– System.String –> The path and file name of the DBF file to be used for Zip Code Geocoding.

Go Back

Protected Constructors

Public Methods

AddRecord(IEnumerable<Object>)

This method adds one record to the DBF file.

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
values IEnumerable<Object><!– System.Collections.Generic.IEnumerable{System.Object} –> This parameter represents a record in the DBF file.

<!– ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin –> Go Back

Close()

This method closes the MatchingPlugin. This method is the concrete wrapper for CloseCore.

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin –> Go Back

CreateDbf(String, IEnumerable<DbfMatchingPluginColumn>)

<!– static –> This method creates a DBF file according to the specified file name and column names.

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

Return Type Description
Void<!– System.Void –> The newly-created DbfMatchingPlugIn object.

Parameters

Name Type Description
pathFileName String<!– System.String –> This parameter is the path and file name of the DBF file.
columnNames IEnumerable<DbfMatchingPluginColumn><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPluginColumn} –> This parameter is the collection of DbfColumnDefinition objects.

<!– ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin –> Go Back

Dispose()

Releases all resources used by the DbfMatchingPlugin.

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin –> Go Back

Equals(Object)

Remarks

Return Value

Return Type Description
Boolean<!– System.Boolean –>

Parameters

Name Type Description
obj Object<!– System.Object –>

<!– System.Object –> Go Back

GetHashCode()

Remarks

Return Value

Return Type Description
Int32<!– System.Int32 –>

Parameters

Name Type Description

<!– System.Object –> Go Back

GetRecord(Int32)

This method gets a record by record index from the DBF file.

Remarks

Return Value

Return Type Description
Dictionary<String,String><!– System.Collections.Generic.Dictionary{System.String,System.String} –> The record value.

Parameters

Name Type Description
recordNumber Int32<!– System.Int32 –> This parameter is the record number.

<!– ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin –> Go Back

GetRecords(Int32, Int32)

This method gets records by using the specified range.

Remarks

Return Value

Return Type Description
Collection<Dictionary<String,String»<!– System.Collections.ObjectModel.Collection{System.Collections.Generic.Dictionary{System.String,System.String}} –> The collection of record values.

Parameters

Name Type Description
firstRecordNumber Int32<!– System.Int32 –> This parameter is the first record number to get.
count Int32<!– System.Int32 –> This parameter is the record count to return.

<!– ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin –> Go Back

GetType()

Remarks

Return Value

Return Type Description
Type<!– System.Type –>

Parameters

Name Type Description

<!– System.Object –> 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

Return Value

Return Type Description
Collection<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 –> Go Back

Open()

This method opens the MatchingPlugin for use. This method is the concrete wrapper for OpenCore.

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin –> Go Back

ToString()

Remarks

Return Value

Return Type Description
String<!– System.String –>

Parameters

Name Type Description

<!– System.Object –> Go Back

Protected Methods

BinarySearch(Int32, Int32, String, String)

This method does a binary search on the DBF file and returns the record it hits.

Remarks

Return Value

Return Type Description
Dictionary<String,String><!– System.Collections.Generic.Dictionary{System.String,System.String} –> The record hits in the search.

Parameters

Name Type Description
firstRecordNumber Int32<!– System.Int32 –> The first record number for the search.
lastRecordNumber Int32<!– System.Int32 –> The last record number for the search.
sourceText String<!– System.String –> The source text to match.
columnName String<!– System.String –> The name of the column on which the binaray search is based.

<!– ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin –> Go Back

CloseCore()

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin(overriden) –> Go Back

Finalize()

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– System.Object(overriden) –> Go Back

Formalize(String)

This method formalizes the source text. This method is the concrete wrapper of FormalizeCore.

Remarks

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 –> Go Back

FormalizeCore(String)

This method formalizes the source text to get possible zip codes.

Remarks

Return Value

Return Type Description
Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> The collection containing possible zip codes.

Parameters

Name Type Description
sourceText String<!– System.String –> The source text to formalize.

<!– ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin(overriden) –> Go Back

GetKeyColumnName()

This method gets the key column name from the DBF file.

Remarks

Return Value

Return Type Description
String<!– System.String –> The key column name.

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin –> Go Back

MatchCore(String)

Remarks

Return Value

Return Type Description
Collection<GeocoderMatch><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MapSuiteGeocoder.GeocoderMatch} –>

Parameters

Name Type Description
sourceText String<!– System.String –>

<!– ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin(overriden) –> Go Back

MemberwiseClone()

Remarks

Return Value

Return Type Description
Object<!– System.Object –>

Parameters

Name Type Description

<!– System.Object –> Go Back

OpenCore()

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin(overriden) –> Go Back

SearchLowerBound(Int32, Int32, String, String)

This method gets the record number of the lower boundary of the matched results.

Remarks

Return Value

Return Type Description
Int32<!– System.Int32 –> The record number of the lower boundary of the matched results.

Parameters

Name Type Description
firstRecordNumber Int32<!– System.Int32 –> The first record number for the search.
lastRecordNumber Int32<!– System.Int32 –> The last record number for the search.
sourceText String<!– System.String –> The source text to search for.
columnName String<!– System.String –> The name of the column on which the search is based.

<!– ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin –> Go Back

SearchUpperBound(Int32, Int32, String, String)

This method gets the record number of the upper boundary of the matched results.

Remarks

Return Value

Return Type Description
Int32<!– System.Int32 –> The record number of the upper boundary of the matched results.

Parameters

Name Type Description
firstRecordNumber Int32<!– System.Int32 –> The first record number for the search.
lastRecordNumber Int32<!– System.Int32 –> The last record number for the search.
sourceText String<!– System.String –> The source text to search for.
columnName String<!– System.String –> The name of the column on which the search is based.

<!– ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin –> Go Back

Public Properties

PathFileName

Gets and sets the path and file name of the DBF file to be used for Geocoding.

Remarks

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin –> Go Back

RankingMultiplier

This property is the ranking multipier for GeocoderMatch.

Remarks

Return Value

Return Type
Int32<!– System.Int32 –>

<!– ThinkGeo.MapSuite.MapSuiteGeocoder.MatchingPlugin –> Go Back

ReadWriteMode

The read/write mode for the DBF file.

Remarks

Return Value

Return Type
DbfMatchingPluginReadWriteMode<!– ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPluginReadWriteMode –>

<!– ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin –> Go Back

RecordCount

This record count of the DBF file.

Remarks

Return Value

Return Type
Int32<!– System.Int32 –>

<!– ThinkGeo.MapSuite.MapSuiteGeocoder.DbfMatchingPlugin –> Go Back

Protected Properties

Public Events

thinkgeo.mapsuite.mapsuitegeocoder.zipdbfmatchingplugin.1440040131.txt.gz · Last modified: 2015/09/21 07:04 (external edit)