com.esri.arcgis.location
Interface IReferenceDataField

All Superinterfaces:

Serializable

All Known Subinterfaces:

IReferenceDataFieldEdit

All Known Implementing Classes:

IReferenceDataFieldEditProxy, IReferenceDataFieldProxy, ReferenceDataField

public interface IReferenceDataField
extends Serializable

Provides access to members for inspecting a reference data field.

When To Use

Use the IReferenceDataField interface to get information about the Field in the ReferenceDataTable used by the locator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

ReferenceDataIndex, IReferenceDataFieldEdit, ReferenceDataFieldsEnumerator, ReferenceDataTableEnumerator, IReferenceDataField, IReferenceDataTableEdit, ESRIFDOAddressLocator, IReferenceDataFile.getPathName(), StreetMapAddressLocator, IEnumReferenceDataField, IReferenceDataFile, IReferenceDataTable, IReferenceDataTables, IReferenceDataTables.getTables(), ReferenceDataField, IReferenceDataFile.getFilters(), IEnumReferenceDataTable, ReferenceDataTable, IAddressGeocoding.validate(), ReferenceDataIndexEnumerator, IEnumReferenceDataIndex

Method Summary

String	getDisplayName() Name for the reference data field to display in the user interface.
String	getInternalName() Internal name for the reference data field.
String	getName() Name of the field in the reference data table.
boolean	isObjectID() Indicates if the field is the ObjectID field.
boolean	isRequired() Indicates whether the field is a required by the locator.
boolean	isShape() Indicates if the field is the Shape field.

Method Detail

getDisplayName

String getDisplayName()
                      throws IOException,
                             AutomationException

Name for the reference data field to display in the user interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInternalName

String getInternalName()
                       throws IOException,
                              AutomationException

Internal name for the reference data field.

Description

The InternalName property returns the internal name for the ReferenceDataField used by the locator.

Remarks

The following is a listing of the internal names of the ReferenceDataFields used by the locators provided with ArcGIS 8:

• From - The beginning address number in a range of addresses.
• HouseNum - The street number of the address represented by the row in the reference data source; used by locators based on one of the US One Address locator styles.
• KeyField- For locators based on one of the Single Field locator styles, the field that contains the matchable attribute.
• LeftFrom - The beginning address number in a range of addreses for the left side of the street.
• LeftTo - The ending address number in a range of addreses for the left side of the street.
• LeftZone - The zone for the left side of the street.
• PreDir - The street prefix direction.
• PreType - The street prefix type.
• RightFrom - The beginning address number in a range of addreses for the right side of the street.
• RightTo - The ending address number in a range of addreses for the right side of the street.
• RightZone - The zone for the right side of the street.
• StreetName - The street name.
• StreetType - The street suffix type.
• SufDir - The street suffix direction.
• To - The ending address number in a range of addresses.
• ZIP - The ZIP code attribute for locators based on one of the ZIP locator styles.
• ZIP4 - The additional 4 digits of a ZIP+4 code for locators based on one of the ZIP+4 locator styles.
• ZIP4High - The maximum 4 digit code in a range of ZIP+4 codes.
• ZIP4Low - The minimum 4 digit code in a range of ZIP+4 codes.
• Zone - The zone attribute for locators that use zone information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isObjectID

boolean isObjectID()
                   throws IOException,
                          AutomationException

Indicates if the field is the ObjectID field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The bShape

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShape

boolean isShape()
                throws IOException,
                       AutomationException

Indicates if the field is the Shape field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The bShape

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

Name of the field in the reference data table.

Remarks

The Name property returns the actual name of the Field in the reference data source.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRequired

boolean isRequired()
                   throws IOException,
                          AutomationException

Indicates whether the field is a required by the locator.

Remarks

If the Required property is False, then the reference data source does not need to contain this Field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The bRequired

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.