com.esri.arcgis.location
Class IReferenceDataFieldProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.location.IReferenceDataFieldProxy
All Implemented Interfaces:
IReferenceDataField, Externalizable, Serializable
Direct Known Subclasses:
IReferenceDataFieldEditProxy

public class IReferenceDataFieldProxy
extends com.esri.arcgis.interop.Dispatch
implements IReferenceDataField, 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.

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

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IReferenceDataFieldProxy()
           
  IReferenceDataFieldProxy(Object obj)
           
protected IReferenceDataFieldProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IReferenceDataFieldProxy

public IReferenceDataFieldProxy()

IReferenceDataFieldProxy

public IReferenceDataFieldProxy(Object obj)
                         throws IOException
Throws:
IOException

IReferenceDataFieldProxy

protected IReferenceDataFieldProxy(Object obj,
                                   String iid)
                            throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

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.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException