com.esri.arcgis.geodatabase
Class Field

java.lang.Object
  com.esri.arcgis.geodatabase.Field

All Implemented Interfaces:

IField, IField2, IFieldEdit, IFieldEdit2, IGPDescribe, IGPValue, IModelInfo, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class Field
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IField, IField2, IFieldEdit, IFieldEdit2, IModelInfo, IPersist, IClone, IGPValue, IXMLSerialize, IPersistStream, IGPDescribe, Externalizable

Esri Field object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

Field()
Constructs a Field using ArcGIS Engine.

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

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	checkValue(Object value) Indicates if the value is valid given the field definition.
Object	describe(String name) The description of the named object.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
void	empty() Clears the value object.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
String	getAliasName() The alias name of the field.
String	getAsText() Provides the value of the value object.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
Object	getDefaultValue() The default value of the field.
IDomain	getDomain() The default domain of the field.
IGeometryDef	getGeometryDef() The geometry definition for the field if IsGeometry is TRUE.
int	getLength() The maximum length, in bytes, for values described by the field.
String	getModelName() The model name of the field.
String	getName() The name of the field.
int	getPrecision() The precision for field values.
IRasterDef	getRasterDef() The raster column definition.
int	getScale() The scale for field values.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getType() The type of the field.
int	getVarType() The VARTYPE of the field (e.g.
int	hashCode() the hashcode for this object
IGPDataType	IGPValue_getDataType() The data type of the value object.
void	isDirty() isDirty
boolean	isDomainFixed() Indicates if the field's domain is fixed.
boolean	isEditable() Indicates if the field is editable.
boolean	isEmpty() Indicates if the value object is empty.
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isNullable() Indicates if the field can contain null values.
boolean	isRequired() Indicates if the field is required.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAliasName(String rhs1) The alias name of the field.
IGPMessage	setAsText(String text) Provides the value of the value object with the given string value.
void	setDefaultValue(Object rhs1) The default value of the field.
void	setDomainByRef(IDomain rhs1) The default domain of the field.
void	setDomainFixed(boolean rhs1) Indicates if the field's domain cannot be modified.
void	setEditable(boolean rhs1) Indicates if the field can be edited.
void	setGeometryDefByRef(IGeometryDef rhs1) The geometry definition if IsGeometry is TRUE.
void	setIsNullable(boolean rhs1) Indicates if field values can be null.
void	setLength(int rhs1) The maximum length, in bytes, for field values.
void	setModelName(String name) The model name of the field.
void	setName(String rhs1) The name of the field.
void	setPrecision(int rhs1) The precision for field values.
void	setRasterDefByRef(IRasterDef rasterDef) The raster column definition.
void	setRequired(boolean rhs1) Indicates if the field is required.
void	setScale(int rhs1) The scale for field values.
void	setType(int rhs1) The type for the field.
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

Field

public Field()
      throws IOException,
             UnknownHostException

Constructs a Field using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

Field

public Field(Object obj)
      throws IOException

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

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

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

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the field.

Remarks

Geodatabase feature classes, depending on their geometry type, may contain automatically generated fields for shape length and area. In personal and file geodatabases, these fields will be named using the name of the shape field suffixed with "_Length" and "_Area". In an SDE geodatabase, the names of these fields will be dependant on the underlying DBMS.

The IFeatureClass::ShapeFieldName property should be used to determine the name of the length and area fields for a feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IField

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAliasName

public String getAliasName()
                    throws IOException,
                           AutomationException

The alias name of the field.

Remarks

This is only supported on fields from object classes and feature classes that are registered with the geodatabase; Personal, File or ArcSDE geodatabases. For fields coming from other data sources (shapefiles, coverages, etc) the AliasName will be the same string as the field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAliasName in interface IField

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException

The type of the field.

Remarks

For more information on the relation between esriFieldType values and the underlying SDE and DBMS data types, see the following articles in the ArcGIS Help:

• "A comparison of ArcGIS, ArcSDE, and DB2 data types"
• "A comparison of ArcGIS, ArcSDE, and Informix data types"
• "A comparison of ArcGIS, ArcSDE, and PostgreSQL data types"
• "A comparison of ArcGIS, ArcSDE, and Oracle data types"
• "A comparison of ArcGIS, ArcSDE, and SQL Server data types"

The following table outlines the equivalent field data types in ArcCatalog, ArcObjects and .NET:

ArcCatalog	esriFieldType (IField::Type)	.NET Variable Type
Short Integer	esriFieldTypeSmallInteger	System.Int16
Long Integer	esriFieldTypeInteger	System.Int32
Float	esriFieldTypeSingle	System.Single
Double	esriFieldTypeDouble	System.Double
Text	esriFieldTypeString	System.String
Date	esriFieldTypeDate	System.DateTime
Object ID	esriFieldTypeOID	System.Int32
Geometry	esriFieldTypeGeometry	ESRI.ArcGIS.Geometry.IGeometry
Blob	esriFieldTypeBlob	ESRI.ArcGIS.esriSystem.IMemoryBlobStream
Raster	esriFieldTypeRaster	ESRI.ArcGIS.Geodatabase.IRasterValue
GUID	esriFieldTypeGUID	System.String
GlobalID	esriFieldTypeGlobalID	System.String

The following table outlines the Coverage, INFO Item to Geodatabase field mapping:

Item type	Item width	Geodatabase field type (esriFieldType)
B	4	esriFieldTypeInteger
C	1-320	esriFieldTypeString
D	8	esriFieldTypeDate
F	4	esriFieldTypeSingle
F	8	esriFieldTypeDouble
I	1-4	esriFieldTypeSmallInteger
I	5-9	esriFieldTypeInteger
I	10-16	esriFieldTypeDouble
N	1-9	esriFieldTypeSingle
N	10-16	esriFieldTypeDouble

The following table outlines the Shapefile, dBASE field to Geodatabase field mapping:

Field type	Field width	Geodatabase field type (esriFieldType)
Date	-	esriFieldTypeDate
String	1-255	esriFieldTypeString
Boolean	-	esriFieldTypeString
Number	1-16 (decimals = 0)	esriFieldTypeInteger
Number	1-16 (decimals > 0)	esriFieldTypeDouble

Note: Shapefiles only support date fields. Time is not supported. Geodatabases support date\time fields. If a shapefiles date field is queried for the time a default value of "12:00:00 AM" will be returned.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getType in interface IField

Returns:

A com.esri.arcgis.geodatabase.esriFieldType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDomain

public IDomain getDomain()
                  throws IOException,
                         AutomationException

The default domain of the field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDomain in interface IField

Returns:

A reference to a com.esri.arcgis.geodatabase.IDomain

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IField

getDefaultValue

public Object getDefaultValue()
                       throws IOException,
                              AutomationException

The default value of the field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultValue in interface IField

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLength

public int getLength()
              throws IOException,
                     AutomationException

The maximum length, in bytes, for values described by the field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLength in interface IField

Returns:

The length

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrecision

public int getPrecision()
                 throws IOException,
                        AutomationException

The precision for field values.

Remarks

Precision is the number of digits in a number. For example, the number 56.78 has a precision of 4. Precision is only valid for fields that are numeric. Precision is always returned as 0 from personal or File geodatabase fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPrecision in interface IField

Returns:

The length

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getScale

public int getScale()
             throws IOException,
                    AutomationException

The scale for field values.

Remarks

Scale is the number of digits to the right of the decimal point in a number. For example, the number 56.78 has a scale of 2. Scale applies only to fields that are double. Scale is always returned as 0 from personal or File geodatabase fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getScale in interface IField

Returns:

The length

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNullable

public boolean isNullable()
                   throws IOException,
                          AutomationException

Indicates if the field can contain null values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isNullable in interface IField

Returns:

The isNullable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometryDef

public IGeometryDef getGeometryDef()
                            throws IOException,
                                   AutomationException

The geometry definition for the field if IsGeometry is TRUE.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getGeometryDef in interface IField

Returns:

A reference to a com.esri.arcgis.geodatabase.IGeometryDef

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVarType

public int getVarType()
               throws IOException,
                      AutomationException

The VARTYPE of the field (e.g. VT_I4).

Description

Returns an Integer indicating the subtype of a variable.

Remarks

The following is a list of the VARTYPE constants that can be returned from this property.

Field type	VarType
esriFieldTypeSmallInteger esriFieldTypeInteger esriFieldTypeSingle esriFieldTypeDouble esriFieldTypeString esriFieldTypeDate esriFieldTypeOID esriFieldTypeGeometry esriFieldTypeBlob esriFieldTypeRaster esriFieldTypeGUID esriFieldTypeGlobalID	2 3 4 5 8 7 3 13 13 13 8 8

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getVarType in interface IField

Returns:

The varType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDomainFixed

public boolean isDomainFixed()
                      throws IOException,
                             AutomationException

Indicates if the field's domain is fixed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDomainFixed in interface IField

Returns:

The isFixed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IClassSchemaEdit.alterDomain(String, com.esri.arcgis.geodatabase.IDomain), IClassSchemaEdit

isRequired

public boolean isRequired()
                   throws IOException,
                          AutomationException

Indicates if the field is required.

Description

All tables and feature classes have a set of required fields that are necessary to record the state of any particular object in the table or feature class. These required fields are automatically created when you create a new feature class or table, and cannot be deleted. Required fields may also have required properties such as its domain property. You cannot modify the required property of a required field.

For example, in a simple feature class, OID and Shape are required fields. They do have properties such as their alias and geometry type that you can modify, but these fields cannot be deleted.

The Required property only applies to changes to modifying the schema of a Field's properties or blocking it from being deleted. It has no impact on the ability to update or add\delete the values within the field. Also, setting the Required field property to be True will block the user from deleting the field through the GUI, as well as through ArcObjects.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isRequired in interface IField

Returns:

The isRequired

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEditable

public boolean isEditable()
                   throws IOException,
                          AutomationException

Indicates if the field is editable.

Remarks

The Editable property of a field should always be set to TRUE. Setting it to FALSE will prevent all users from editing the contents of the field. To set a field to be read-only, use the IFieldInfo3.ReadOnly property.

It is best to loop through the fields of a feature and skip the fields that are not editable, rather than allowing users to attempt to edit fields that cannot be edited.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEditable in interface IField

Returns:

The isEditable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkValue

public boolean checkValue(Object value)
                   throws IOException,
                          AutomationException

Indicates if the value is valid given the field definition.

Description

CheckValue tests whether the specified value is valid for the current field, based upon the field type. For example, CheckValue will verify if the supplied value corresponds to field type of Small Integer or if the value corresponds to a string value.

The value is not checked against any existing domain.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

checkValue in interface IField

Parameters:

value - A Variant (in)

Returns:

The isValidValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterDef

public IRasterDef getRasterDef()
                        throws IOException,
                               AutomationException

The raster column definition.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRasterDef in interface IField2

Specified by:

getRasterDef in interface IFieldEdit2

Returns:

A reference to a com.esri.arcgis.geodatabase.IRasterDef

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String rhs1)
             throws IOException,
                    AutomationException

The name of the field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IFieldEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAliasName

public void setAliasName(String rhs1)
                  throws IOException,
                         AutomationException

The alias name of the field.

Remarks

This is only supported on fields from object classes and feature classes that are registered with a personal, File or ArcSDE geodatabase.

This is not supported for shapefiles, coverages, or other data sources.

You can register a table within the geodatabase to become an object class by right-clicking on the table in ArcCatalog and clicking on "Register with Geodatabase".

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAliasName in interface IFieldEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDomainByRef

public void setDomainByRef(IDomain rhs1)
                    throws IOException,
                           AutomationException

The default domain of the field.

Remarks

This is only supported on fields from object classes and feature classes that are registered with the geodatabase; Personal, File or ArcSDE.

This is not supported for shapefiles, coverages, or other data sources.

You can register a table within the geodatabase to become an object class by right-clicking on the table in ArcCatalog and clicking on "Register with Geodatabase".

The IFieldEdit::Domain method is used to associate domains when creating new fields. You should not use it to modify existing fields, for that purpose use IClassSchemaEdit::AlterDomain or ISubtypes::Domain.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDomainByRef in interface IFieldEdit

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.IDomain (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultValue

public void setDefaultValue(Object rhs1)
                     throws IOException,
                            AutomationException

The default value of the field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultValue in interface IFieldEdit

Parameters:

rhs1 - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setType

public void setType(int rhs1)
             throws IOException,
                    AutomationException

The type for the field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setType in interface IFieldEdit

Parameters:

rhs1 - A com.esri.arcgis.geodatabase.esriFieldType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLength

public void setLength(int rhs1)
               throws IOException,
                      AutomationException

The maximum length, in bytes, for field values.

Remarks

The length property of a field has meaning only for esriFieldTypeString fields. The length property for all other field types is not important and will be ignored if specified.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLength in interface IFieldEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPrecision

public void setPrecision(int rhs1)
                  throws IOException,
                         AutomationException

The precision for field values.

Description

Precision is the number of digits in a number. For example, the number 56.78 has a precision of 4. Precision is only valid for fields that are numeric.

Remarks

Precision is always returned as 0 from personal or File geodatabase fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPrecision in interface IFieldEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setScale

public void setScale(int rhs1)
              throws IOException,
                     AutomationException

The scale for field values.

Description

Scale is the number of digits to the right of the decimal point in a number. For example, the number 56.78 has a scale of 2. Scale applies only to fields that are double.

Remarks

Precision is always returned as 0 from personal or File geodatabase fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setScale in interface IFieldEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsNullable

public void setIsNullable(boolean rhs1)
                   throws IOException,
                          AutomationException

Indicates if field values can be null.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIsNullable in interface IFieldEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometryDefByRef

public void setGeometryDefByRef(IGeometryDef rhs1)
                         throws IOException,
                                AutomationException

The geometry definition if IsGeometry is TRUE.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setGeometryDefByRef in interface IFieldEdit

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.IGeometryDef (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDomainFixed

public void setDomainFixed(boolean rhs1)
                    throws IOException,
                           AutomationException

Indicates if the field's domain cannot be modified.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDomainFixed in interface IFieldEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRequired

public void setRequired(boolean rhs1)
                 throws IOException,
                        AutomationException

Indicates if the field is required.

Remarks

The Required property only applies to changes to modifying the schema of a Field's properties or blocking it from being deleted. It has no impact on the ability to update or add\delete the values within the field. Also, setting the Required field property to be True will block the user from deleting the field through the GUI, as well as through ArcObjects.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRequired in interface IFieldEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEditable

public void setEditable(boolean rhs1)
                 throws IOException,
                        AutomationException

Indicates if the field can be edited. This should always be set to true.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setEditable in interface IFieldEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterDefByRef

public void setRasterDefByRef(IRasterDef rasterDef)
                       throws IOException,
                              AutomationException

The raster column definition.

Remarks

RasterDef is required for creating a raster field.

Product Availability

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

Specified by:

setRasterDefByRef in interface IFieldEdit2

Parameters:

rasterDef - A reference to a com.esri.arcgis.geodatabase.IRasterDef (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getModelName

public String getModelName()
                    throws IOException,
                           AutomationException

The model name of the field.

Remarks

Returns the model name currently associated with the field or object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getModelName in interface IModelInfo

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IObjectClass, IField

setModelName

public void setModelName(String name)
                  throws IOException,
                         AutomationException

The model name of the field.

Remarks

Sets the model name for the field or object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setModelName in interface IModelInfo

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IObjectClass, IField

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.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IGPValue_getDataType

public IGPDataType IGPValue_getDataType()
                                 throws IOException,
                                        AutomationException

The data type of the value object.

Product Availability

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

Specified by:

IGPValue_getDataType in interface IGPValue

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPDataType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws IOException,
                       AutomationException

Indicates if the value object is empty.

Remarks

The IsEmpty method returns if this Value object has been set or not.

Product Availability

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

Specified by:

isEmpty in interface IGPValue

Returns:

The isEmpty

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

empty

public void empty()
           throws IOException,
                  AutomationException

Clears the value object.

Remarks

The Empty method clears this Value object and releases any associated objects.

Product Availability

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

Specified by:

empty in interface IGPValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAsText

public String getAsText()
                 throws IOException,
                        AutomationException

Provides the value of the value object.

Remarks

The GetAsText method returns this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string for the scalar value.

Product Availability

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

Specified by:

getAsText in interface IGPValue

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(String text)
                     throws IOException,
                            AutomationException

Provides the value of the value object with the given string value.

Remarks

The SetAsText method sets the value of this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string representing the scalar value.

Product Availability

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

Specified by:

setAsText in interface IGPValue

Parameters:

text - The text (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPMessage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (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.

describe

public Object describe(String name)
                throws IOException,
                       AutomationException

The description of the named object.

Product Availability

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

Specified by:

describe in interface IGPDescribe

Parameters:

name - The name (in)

Returns:

A Variant

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