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, Externalizable, Serializable

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

Stores extended field information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

FieldInfo()
Constructs a FieldInfo using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
String	getAlias() The alias for the field.
String	getAsString(Object value) The string representation of a given value based on the current field information.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
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(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setAlias(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(ObjectOutput out)

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

FieldInfo

public FieldInfo()
          throws IOException,
                 UnknownHostException

Constructs a FieldInfo using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

FieldInfo

public FieldInfo(Object obj)
          throws 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:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

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

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the field is visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isVisible in interface IFieldInfo

Specified by:

isVisible in interface IFieldInfo2

Specified by:

isVisible in interface IFieldInfo3

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws IOException,
                       AutomationException

Indicates if the field is visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVisible in interface IFieldInfo

Specified by:

setVisible in interface IFieldInfo2

Specified by:

setVisible in interface IFieldInfo3

Parameters:

visible - The visible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlias

public String getAlias()
                throws IOException,
                       AutomationException

The alias for the field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAlias in interface IFieldInfo

Specified by:

getAlias in interface IFieldInfo2

Specified by:

getAlias in interface IFieldInfo3

Returns:

The aliasName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlias

public void setAlias(String aliasName)
              throws IOException,
                     AutomationException

The alias for the field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAlias in interface IFieldInfo

Specified by:

setAlias in interface IFieldInfo2

Specified by:

setAlias in interface IFieldInfo3

Parameters:

aliasName - The aliasName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumberFormat

public INumberFormat getNumberFormat()
                              throws IOException,
                                     AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumberFormatByRef

public void setNumberFormatByRef(INumberFormat format)
                          throws IOException,
                                 AutomationException

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

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAsString

public String getAsString(Object value)
                   throws IOException,
                          AutomationException

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

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValueAsRatio

public boolean isValueAsRatio()
                       throws IOException,
                              AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isValueAsRatio in interface IFieldInfo2

Specified by:

isValueAsRatio in interface IFieldInfo3

Returns:

The ratio

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValueAsRatio

public void setValueAsRatio(boolean ratio)
                     throws IOException,
                            AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setValueAsRatio in interface IFieldInfo2

Specified by:

setValueAsRatio in interface IFieldInfo3

Parameters:

ratio - The ratio (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHighlight

public boolean isHighlight()
                    throws IOException,
                           AutomationException

Indicates how the field should be presented.

Description

This property determines if the field is highlighted in clients that choose to implement it.

Remarks

Setting the value to true highlights the field name in yellow within the ArcMap identify and attributes window.

In the Arcmap UI this is set in the layer field properties dialog.

Product Availability

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

Specified by:

isHighlight in interface IFieldInfo3

Returns:

The highlight

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHighlight

public void setHighlight(boolean highlight)
                  throws IOException,
                         AutomationException

Indicates how the field should be presented.

Product Availability

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

Specified by:

setHighlight in interface IFieldInfo3

Parameters:

highlight - The highlight (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReadonly

public boolean isReadonly()
                   throws IOException,
                          AutomationException

Indicates how the field should be presented.

Description

This property determines if the field is read only in clients that choose to implement it.

Remarks

Setting the value to true will make the field read only in clients such as the ArcMap editor attribute window. This property only applies to clients that choose to implement it.

In the Arcmap UI this is set in the layer field properties dialog.

Product Availability

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

Specified by:

isReadonly in interface IFieldInfo3

Returns:

The readonlyField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReadonly

public void setReadonly(boolean readonlyField)
                 throws IOException,
                        AutomationException

Indicates how the field should be presented.

Product Availability

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

Specified by:

setReadonly in interface IFieldInfo3

Parameters:

readonlyField - The readonlyField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

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

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException