com.esri.arcgis.geodatabase

Interface IField

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IFieldEdit

All Known Implementing Classes:

Field, IFieldEditProxy, IFieldProxy

public interface IField
extends java.io.Serializable

COM Interface 'IField'. Generated 9/21/2023 10:01:46 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description: 'Provides access to members that return information about the field.' 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 =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IIDfcb01cb3_9f0b_11d0_bec7_00805f7c4268
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
boolean	checkValue(java.lang.Object value) Indicates if the value is valid given the field definition.
java.lang.String	getAliasName() The alias name of the field.
java.lang.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.
java.lang.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.
int	getType() The type of the field.
int	getVarType() The VARTYPE of the field (e.g.
boolean	isDomainFixed() Indicates if the field's domain is fixed.
boolean	isEditable() Indicates if the field is editable.
boolean	isNullable() Indicates if the field can contain null values.
boolean	isRequired() Indicates if the field is required.

Field Detail

IIDfcb01cb3_9f0b_11d0_bec7_00805f7c4268

static final int IIDfcb01cb3_9f0b_11d0_bec7_00805f7c4268

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getName

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

The name of the field.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAliasName

java.lang.String getAliasName()
                       throws java.io.IOException,
                              AutomationException

The alias name of the field.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

int getType()
     throws java.io.IOException,
            AutomationException

The type of the field.

Returns:

A com.esri.arcgis.geodatabase.esriFieldType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDomain

IDomain getDomain()
           throws java.io.IOException,
                  AutomationException

The default domain of the field.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultValue

java.lang.Object getDefaultValue()
                          throws java.io.IOException,
                                 AutomationException

The default value of the field.

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLength

int getLength()
       throws java.io.IOException,
              AutomationException

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

Returns:

The length

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPrecision

int getPrecision()
          throws java.io.IOException,
                 AutomationException

The precision for field values.

Returns:

The length

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getScale

int getScale()
      throws java.io.IOException,
             AutomationException

The scale for field values.

Returns:

The length

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isNullable

boolean isNullable()
            throws java.io.IOException,
                   AutomationException

Indicates if the field can contain null values.

Returns:

The isNullable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeometryDef

IGeometryDef getGeometryDef()
                     throws java.io.IOException,
                            AutomationException

The geometry definition for the field if IsGeometry is TRUE.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVarType

int getVarType()
        throws java.io.IOException,
               AutomationException

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

Returns:

The varType

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDomainFixed

boolean isDomainFixed()
               throws java.io.IOException,
                      AutomationException

Indicates if the field's domain is fixed.

Returns:

The isFixed

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRequired

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

Indicates if the field is required.

Returns:

The isRequired

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEditable

boolean isEditable()
            throws java.io.IOException,
                   AutomationException

Indicates if the field is editable.

Returns:

The isEditable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

checkValue

boolean checkValue(java.lang.Object value)
            throws java.io.IOException,
                   AutomationException

Indicates if the value is valid given the field definition.

Parameters:

value - A Variant (in)

Returns:

The isValidValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRasterDef

IRasterDef getRasterDef()
                 throws java.io.IOException,
                        AutomationException

The raster column definition.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.