C# 클래스 ESRIUK.DynamicLocators.Core.LocatorWrapper

This class is the base class for all locators created with the SDK. It contains the implementations of all of the interfaces that are required for an ArcGIS locator to work Many of the method implementations minimal to enalbe basic functionality and to allow further customisation This class CANNOT be used on as is to create a locator. The methods CreateFields, Properties, FindAddressCandidates and ReverseGeocode must be overridden in a child class at a minimum to create a locator

상속: ILocator, IAddressInputs, IGeocodingProperties, IAddressGeocoding, IAddressCandidates, IClone, ISingleLineAddressInput, ILocatorImpl, ILocatorDataset, IESRILocatorReleaseInfo, IBatchGeocoding, IReverseGeocoding, IReverseGeocodingProperties, IGeocodeServerSingleLine

파일 보기 프로젝트 열기: EsriUK/dynamic-locator-sdk

보호된 프로퍼티들

프로퍼티	타입	설명
m_addXYCoordsToMatchFields	bool
m_addressFields	IFields
m_candidateFields	IFields
m_locatorProperties	IPropertySet
m_matchFields	IFields
m_searchTokenAlias	string
m_searchTokenName	String
m_spatialReference	ISpatialReference

공개 메소드들

메소드	설명
Assign ( IClone src ) : void	Assigns the properties of src to the receiver.
Clone ( ) : IClone	Clones the receiver and assigns the result to *clone.
FindAddressCandidates ( IPropertySet address ) : IArray	Generates candidates for an address.
GetDefaultInputFieldNames ( ) : object	Recognized names for the single line input field.
GetSingleLineAddressField ( ) : IField	Field needed to geocode a single line address.
IsEqual ( IClone other ) : bool	Returns TRUE when the receiver and other have the same properties.
IsIdentical ( IClone other ) : bool	Returns TRUE when the receiver and other are the same object.
LocatorWrapper ( ) : System	The constructor initialises the log4net configuration and calls the CreateFields method
MatchAddress ( IPropertySet address ) : IPropertySet	Uses the FindAddressCandidates method to geocode a single address
MatchRecordSet ( ICursor addressCursor, string addressFieldNames, IRecordSetInit outputRecordSet, string outputFieldNames, IPropertySet fieldsToCopy, ITrackCancel cancelTracker ) : void	Uses MatchAddress to geocode a cursor of addresses to a RecordSet This is called by ArcGIS Server Geocode Addresses
MatchTable ( ITable addressTable, String addressFieldNames, String whereClause, IFeatureClass outputFeatureClass, String outputFieldNames, IPropertySet fieldsToCopy, ITrackCancel cancelTracker ) : void	Geocodes a table of addresses
RematchTable ( ITable pInputTable, string inputFieldNames, string inputJoinFieldName, IFeatureClass resultTable, string outputFieldNames, string outputJoinFieldName, string whereClause, ITrackCancel cancelTracker ) : void	Uses MatchTable to rematch addresses in a feature class
ReverseGeocode ( IPoint location, bool returnIntersection ) : IPropertySet	Generate an address based on a point.
Validate ( ) : void	Checks that the locator properties and locator dataset are present and valid.
get_DefaultInputFieldNames ( string addressField ) : object	Recognized names for an input field.
set_DefaultInputFieldNames ( string addressField, object inputFieldNames ) : void	Recognized names for a required input field.

보호된 메소드들

메소드	설명
CreateFields ( ) : void	This initialises all of the different fields that are required for the locator to function It contains declarations for the Match and Candidate fields for the locator and so must be overridden in each child class
getProperty ( IPropertySet locatorProperties, String Name ) : object	Helper method for getting a property and returning null if it isn't found instead of throwing an exception.
isSameObject ( object a, object b ) : bool	Compare two objects to see if they are identical

비공개 메소드들

메소드	설명
createGDBWorkspace ( string path, string gdbType ) : IWorkspace	Create a workspace for a FGDB or PGDB
setupEditSession ( IClass table ) : IWorkspaceEdit	Setup an edit Session for a table
tokenizeConnectionProperties ( string connection ) : string[]	Get connection properties for FGDB and PGDB
tokenizeLocatorWorkspaceString ( string locatorWorkspaceString ) : string[]	Get the path for a locator stored in a file folder
tokenizeSDEProperties ( string connection ) : string	Builds a property set that contains the connection info for SDE

메소드 상세

Assign() 공개 메소드

Assigns the properties of src to the receiver.

public Assign ( IClone src ) : void
src	IClone
리턴	void

Clone() 공개 메소드

Clones the receiver and assigns the result to *clone.

public Clone ( ) : IClone
리턴	IClone

CreateFields() 보호된 메소드

This initialises all of the different fields that are required for the locator to function It contains declarations for the Match and Candidate fields for the locator and so must be overridden in each child class

protected CreateFields ( ) : void
리턴	void

FindAddressCandidates() 공개 메소드

Generates candidates for an address.

public FindAddressCandidates ( IPropertySet address ) : IArray
address	IPropertySet
리턴	IArray

GetDefaultInputFieldNames() 공개 메소드

Recognized names for the single line input field.

public GetDefaultInputFieldNames ( ) : object
리턴	object

GetSingleLineAddressField() 공개 메소드

Field needed to geocode a single line address.

public GetSingleLineAddressField ( ) : IField
리턴	IField

IsEqual() 공개 메소드

Returns TRUE when the receiver and other have the same properties.

public IsEqual ( IClone other ) : bool
other	IClone
리턴	bool

IsIdentical() 공개 메소드

Returns TRUE when the receiver and other are the same object.

public IsIdentical ( IClone other ) : bool
other	IClone
리턴	bool

LocatorWrapper() 공개 메소드

The constructor initialises the log4net configuration and calls the CreateFields method

public LocatorWrapper ( ) : System
리턴	System

MatchAddress() 공개 메소드

Uses the FindAddressCandidates method to geocode a single address

public MatchAddress ( IPropertySet address ) : IPropertySet
address	IPropertySet	Input address
리턴	IPropertySet

MatchRecordSet() 공개 메소드

Uses MatchAddress to geocode a cursor of addresses to a RecordSet This is called by ArcGIS Server Geocode Addresses

public MatchRecordSet ( ICursor addressCursor, string addressFieldNames, IRecordSetInit outputRecordSet, string outputFieldNames, IPropertySet fieldsToCopy, ITrackCancel cancelTracker ) : void
addressCursor	ICursor	Cursor containing address to be geocoded
addressFieldNames	string	The address fields that make up a record in the cursor
outputRecordSet	IRecordSetInit	The output record set
outputFieldNames	string	The output field names
fieldsToCopy	IPropertySet
cancelTracker	ITrackCancel
리턴	void

MatchTable() 공개 메소드

Geocodes a table of addresses

public MatchTable ( ITable addressTable, String addressFieldNames, String whereClause, IFeatureClass outputFeatureClass, String outputFieldNames, IPropertySet fieldsToCopy, ITrackCancel cancelTracker ) : void
addressTable	ITable	Input address table
addressFieldNames	String	Fields defined in the table
whereClause	String	Query filter where clause
outputFeatureClass	IFeatureClass	Output feature class for matched addresses
outputFieldNames	String	Output field names
fieldsToCopy	IPropertySet
cancelTracker	ITrackCancel
리턴	void

RematchTable() 공개 메소드

Uses MatchTable to rematch addresses in a feature class

public RematchTable ( ITable pInputTable, string inputFieldNames, string inputJoinFieldName, IFeatureClass resultTable, string outputFieldNames, string outputJoinFieldName, string whereClause, ITrackCancel cancelTracker ) : void
pInputTable	ITable	Input table containing addresses
inputFieldNames	string	In put tables fields
inputJoinFieldName	string	Input join field name
resultTable	IFeatureClass	The rematch result table
outputFieldNames	string	Output field names
outputJoinFieldName	string	Output join field name
whereClause	string	Where Clause for the Match Table method
cancelTracker	ITrackCancel
리턴	void

ReverseGeocode() 공개 메소드

Generate an address based on a point.

public ReverseGeocode ( IPoint location, bool returnIntersection ) : IPropertySet
location	IPoint
returnIntersection	bool
리턴	IPropertySet

Validate() 공개 메소드

Checks that the locator properties and locator dataset are present and valid.

public Validate ( ) : void
리턴	void

getProperty() 보호된 메소드

Helper method for getting a property and returning null if it isn't found instead of throwing an exception.

protected getProperty ( IPropertySet locatorProperties, String Name ) : object
locatorProperties	IPropertySet
Name	String
리턴	object

get_DefaultInputFieldNames() 공개 메소드

Recognized names for an input field.

public get_DefaultInputFieldNames ( string addressField ) : object
addressField	string
리턴	object

isSameObject() 보호된 메소드

Compare two objects to see if they are identical

protected isSameObject ( object a, object b ) : bool
a	object
b	object
리턴	bool

set_DefaultInputFieldNames() 공개 메소드

Recognized names for a required input field.

public set_DefaultInputFieldNames ( string addressField, object inputFieldNames ) : void
addressField	string
inputFieldNames	object
리턴	void

프로퍼티 상세

m_addXYCoordsToMatchFields 보호되어 있는 프로퍼티

protected bool m_addXYCoordsToMatchFields
리턴	bool

m_addressFields 보호되어 있는 프로퍼티

protected IFields m_addressFields
리턴	IFields

m_candidateFields 보호되어 있는 프로퍼티

protected IFields m_candidateFields
리턴	IFields

m_locatorProperties 보호되어 있는 프로퍼티

protected IPropertySet m_locatorProperties
리턴	IPropertySet

m_matchFields 보호되어 있는 프로퍼티

protected IFields m_matchFields
리턴	IFields

m_searchTokenAlias 보호되어 있는 프로퍼티

protected string m_searchTokenAlias
리턴	string

m_searchTokenName 보호되어 있는 프로퍼티

protected String m_searchTokenName
리턴	String

m_spatialReference 보호되어 있는 프로퍼티

protected ISpatialReference m_spatialReference
리턴	ISpatialReference