com.esri.arcgis.carto
Class FieldInfo

java.lang.Object
  com.esri.arcgis.carto.FieldInfo

All Implemented Interfaces:

IFieldInfo, IFieldInfo2, IFieldInfo3, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class FieldInfo
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IFieldInfo, IFieldInfo2, IFieldInfo3, IPersistStream, IPersist, java.io.Externalizable

COM Class 'FieldInfo'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'Stores extended field information.' 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

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.geodatabase.IFieldInfo

IID, IIDa2baae2c_969b_11d2_ae77_080009ec732a, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IFieldInfo2

IID, IID8fea7378_8bb3_4a2f_8a61_338b17a1e661, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IFieldInfo3

IID, IIDca074ae5_0c07_4548_b228_cb0abdd68098, xxDummy

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

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

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

IID0000010c_0000_0000_c000_000000000046

Constructor Summary

FieldInfo()
Constructs a FieldInfo using ArcGIS Engine.

FieldInfo(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FieldInfo theFieldInfo = (FieldInfo) obj;

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getAlias() The alias for the field.
java.lang.String	getAsString(java.lang.Object value) The string representation of a given value based on the current field information.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
INumberFormat	getNumberFormat() The number format for the field (invalid if non-numeric field).
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isHighlight() Indicates how the field should be presented.
boolean	isReadonly() Indicates how the field should be presented.
boolean	isValueAsRatio() Indicates if the field value should be the ratio of itself.
boolean	isVisible() Indicates if the field is visible.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a FieldInfo.
void	save(IStream pstm, int fClearDirty) save
void	setAlias(java.lang.String aliasName) The alias for the field.
void	setHighlight(boolean highlight) Indicates how the field should be presented.
void	setNumberFormatByRef(INumberFormat format) The number format for the field (invalid if non-numeric field).
void	setReadonly(boolean readonlyField) Indicates how the field should be presented.
void	setValueAsRatio(boolean ratio) Indicates if the field value should be the ratio of itself.
void	setVisible(boolean visible) Indicates if the field is visible.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

FieldInfo

public FieldInfo()
          throws java.io.IOException,
                 java.net.UnknownHostException

Constructs a FieldInfo using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

FieldInfo

public FieldInfo(java.lang.Object obj)
          throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FieldInfo theFieldInfo = (FieldInfo) obj;

Construct a FieldInfo using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to FieldInfo.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

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 FieldInfo.

Specified by:

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

isVisible

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

Indicates if the field is visible.

Specified by:

isVisible in interface IFieldInfo

Specified by:

isVisible in interface IFieldInfo2

Specified by:

isVisible in interface IFieldInfo3

Returns:

The visible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException

Indicates if the field is visible.

Specified by:

setVisible in interface IFieldInfo

Specified by:

setVisible in interface IFieldInfo2

Specified by:

setVisible in interface IFieldInfo3

Parameters:

visible - The visible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAlias

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

The alias for the field.

Specified by:

getAlias in interface IFieldInfo

Specified by:

getAlias in interface IFieldInfo2

Specified by:

getAlias in interface IFieldInfo3

Returns:

The aliasName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAlias

public void setAlias(java.lang.String aliasName)
              throws java.io.IOException,
                     AutomationException

The alias for the field.

Specified by:

setAlias in interface IFieldInfo

Specified by:

setAlias in interface IFieldInfo2

Specified by:

setAlias in interface IFieldInfo3

Parameters:

aliasName - The aliasName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNumberFormat

public INumberFormat getNumberFormat()
                              throws java.io.IOException,
                                     AutomationException

The number format for the field (invalid if non-numeric field).

Specified by:

getNumberFormat in interface IFieldInfo

Specified by:

getNumberFormat in interface IFieldInfo2

Specified by:

getNumberFormat in interface IFieldInfo3

Returns:

A reference to a com.esri.arcgis.system.INumberFormat

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNumberFormatByRef

public void setNumberFormatByRef(INumberFormat format)
                          throws java.io.IOException,
                                 AutomationException

The number format for the field (invalid if non-numeric field).

Specified by:

setNumberFormatByRef in interface IFieldInfo

Specified by:

setNumberFormatByRef in interface IFieldInfo2

Specified by:

setNumberFormatByRef in interface IFieldInfo3

Parameters:

format - A reference to a com.esri.arcgis.system.INumberFormat (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAsString

public java.lang.String getAsString(java.lang.Object value)
                             throws java.io.IOException,
                                    AutomationException

The string representation of a given value based on the current field information.

Specified by:

getAsString in interface IFieldInfo

Specified by:

getAsString in interface IFieldInfo2

Specified by:

getAsString in interface IFieldInfo3

Parameters:

value - A Variant (in)

Returns:

The stringRep

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isValueAsRatio

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

Indicates if the field value should be the ratio of itself.

Specified by:

isValueAsRatio in interface IFieldInfo2

Specified by:

isValueAsRatio in interface IFieldInfo3

Returns:

The ratio

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setValueAsRatio

public void setValueAsRatio(boolean ratio)
                     throws java.io.IOException,
                            AutomationException

Indicates if the field value should be the ratio of itself.

Specified by:

setValueAsRatio in interface IFieldInfo2

Specified by:

setValueAsRatio in interface IFieldInfo3

Parameters:

ratio - The ratio (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHighlight

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

Indicates how the field should be presented.

Specified by:

isHighlight in interface IFieldInfo3

Returns:

The highlight

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHighlight

public void setHighlight(boolean highlight)
                  throws java.io.IOException,
                         AutomationException

Indicates how the field should be presented.

Specified by:

setHighlight in interface IFieldInfo3

Parameters:

highlight - The highlight (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReadonly

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

Indicates how the field should be presented.

Specified by:

isReadonly in interface IFieldInfo3

Returns:

The readonlyField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReadonly

public void setReadonly(boolean readonlyField)
                 throws java.io.IOException,
                        AutomationException

Indicates how the field should be presented.

Specified by:

setReadonly in interface IFieldInfo3

Parameters:

readonlyField - The readonlyField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException