com.esri.arcgis.location
Class ReferenceDataField

java.lang.Object
  com.esri.arcgis.location.ReferenceDataField

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IReferenceDataField, IReferenceDataFieldEdit, ISupportErrorInfo, java.io.Serializable

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

COM Class 'ReferenceDataField'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriLocation.olb'

Description 'A reference data field definition for a reference data table.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.location.IReferenceDataFieldEdit

IID, IIDba6a5d84_10c7_11d4_9f7c_00c04f8ed1c4, xxDummy

Fields inherited from interface com.esri.arcgis.location.IReferenceDataField

IIDba6a5d83_10c7_11d4_9f7c_00c04f8ed1c4

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

ReferenceDataField(java.lang.Object obj)
Construct a ReferenceDataField using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
java.lang.Object	getDefaultNames() Recognized names for the reference data field in the reference data table.
java.lang.String	getDisplayName() Name for the reference data field to display in the user interface.
java.lang.String	getInternalName() Internal name for the reference data field.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.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	release() Release a ReferenceDataField.
void	setName(java.lang.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

Constructor Detail

ReferenceDataField

public ReferenceDataField(java.lang.Object obj)
                   throws java.io.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:

java.io.IOException - if there are interop problems ReferenceDataField theReferenceDataField = (ReferenceDataField) obj;

Method Detail

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a ReferenceDataField.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getDisplayName

public java.lang.String getDisplayName()
                                throws java.io.IOException,
                                       AutomationException

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

Specified by:

getDisplayName in interface IReferenceDataField

Returns:

The label

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInternalName

public java.lang.String getInternalName()
                                 throws java.io.IOException,
                                        AutomationException

Internal name for the reference data field.

Specified by:

getInternalName in interface IReferenceDataField

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isObjectID

public boolean isObjectID()
                   throws java.io.IOException,
                          AutomationException

Indicates if the field is the ObjectID field.

Specified by:

isObjectID in interface IReferenceDataField

Returns:

The bShape

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShape

public boolean isShape()
                throws java.io.IOException,
                       AutomationException

Indicates if the field is the Shape field.

Specified by:

isShape in interface IReferenceDataField

Returns:

The bShape

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Name of the field in the reference data table.

Specified by:

getName in interface IReferenceDataField

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRequired

public boolean isRequired()
                   throws java.io.IOException,
                          AutomationException

Indicates whether the field is a required by the locator.

Specified by:

isRequired in interface IReferenceDataField

Returns:

The bRequired

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultNames

public java.lang.Object getDefaultNames()
                                 throws java.io.IOException,
                                        AutomationException

Recognized names for the reference data field in the reference data table.

Specified by:

getDefaultNames in interface IReferenceDataFieldEdit

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String rhs1)
             throws java.io.IOException,
                    AutomationException

Name of the field in the reference data table.

Specified by:

setName in interface IReferenceDataFieldEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.