com.esri.arcgis.location
Class ReferenceDataField

java.lang.Object
  extended by com.esri.arcgis.location.ReferenceDataField
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IReferenceDataField, IReferenceDataFieldEdit, ISupportErrorInfo, Serializable

public class ReferenceDataField
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IReferenceDataField, IReferenceDataFieldEdit, ISupportErrorInfo

A reference data field definition for a reference data table.

Description

A ReferenceDataField describes a Field in the ReferenceDataTable used the the locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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, Serialized Form

Constructor Summary
ReferenceDataField(Object obj)
          Construct a ReferenceDataField using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 Object getDefaultNames()
          Recognized names for the reference data field in the reference data table.
 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.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 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.
 void setName(String rhs1)
          Name of the field in the reference data table.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

ReferenceDataField

public ReferenceDataField(Object obj)
                   throws IOException
Construct a ReferenceDataField using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ReferenceDataField.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ReferenceDataField o = (ReferenceDataField)obj; // will not work

ReferenceDataField o = new ReferenceDataField(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
IOException - if there are interop problems ReferenceDataField theReferenceDataField = (ReferenceDataField) obj;
Method Detail

equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getDisplayName

public 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

Specified by:
getDisplayName in interface IReferenceDataField
Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInternalName

public 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:

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getInternalName in interface IReferenceDataField
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isObjectID

public 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

Specified by:
isObjectID in interface IReferenceDataField
Returns:
The bShape
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShape

public 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

Specified by:
isShape in interface IReferenceDataField
Returns:
The bShape
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public 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

Specified by:
getName in interface IReferenceDataField
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRequired

public 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

Specified by:
isRequired in interface IReferenceDataField
Returns:
The bRequired
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultNames

public Object getDefaultNames()
                       throws IOException,
                              AutomationException
Recognized names for the reference data field in the reference data table.

Remarks

The DefaultNames property returns an array of strings that contain possible names for this ReferenceDataField in the ReferenceDataTable. You can use these possible names to seach a reference data source for the appropriate field for the ReferenceDataField.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDefaultNames in interface IReferenceDataFieldEdit
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String rhs1)
             throws IOException,
                    AutomationException
Name of the field in the reference data table.

Description

The Name property specifies the name of the Field in the reference data source used by the locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setName in interface IReferenceDataFieldEdit
Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.