com.esri.arcgis.geoprocessing
Class GPFieldDomain

java.lang.Object
  com.esri.arcgis.geoprocessing.GPFieldDomain

All Implemented Interfaces:

IGPDomain, IGPFieldDomain, IGPFieldDomain2, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class GPFieldDomain
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IClone, IXMLSerialize, IPersistStream, IGPDomain, IGPFieldDomain, IGPFieldDomain2, Externalizable

Geoprocessing Field Domain.

Product Availability

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

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

GPFieldDomain()
Constructs a GPFieldDomain using ArcGIS Engine.

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

Method Summary

void	addExcludeField(String name) Add exclude field.
void	addKeyField(String name) Add key field.
void	addType(int type) Add a field type.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	deleteType(int type) Remove a field type.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getCount() Count.
String	getExcludeField(int index) Exclude field.
int	getExcludeFieldCount() Exclude field count.
String	getKeyField(int index) Key field.
int	getKeyFieldCount() Key field count.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getType(int index) Field type.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isFilterIndex() Indicates whether or not to filter fields based on whether or not they have an index.
boolean	isFilterIndexType() Indicates whether to filter fields that have or do not have an index.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isUseRasterFields() Enable raster attribute table for Mosaic dataset.
void	load(IStream pstm) load
IArray	makeList(IGPValue pValue) Make list.
IGPMessage	memberOf(IGPValue value) Indicates if the value object is a member of the geoprocessing domain type.
void	readExternal(ObjectInput in)
void	removeExcludeField(int index) Remove exclude field.
void	removeKeyField(int index) Remove key field.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setIndexFilter(boolean filter, boolean type) Set index filter.
void	setUseRasterFields(boolean bVAT) Enable raster attribute table for Mosaic dataset.
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

GPFieldDomain

public GPFieldDomain()
              throws IOException,
                     UnknownHostException

Constructs a GPFieldDomain using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GPFieldDomain

public GPFieldDomain(Object obj)
              throws IOException

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

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

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

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.

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.

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.

memberOf

public IGPMessage memberOf(IGPValue value)
                    throws IOException,
                           AutomationException

Indicates if the value object is a member of the geoprocessing domain type.

Product Availability

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

Specified by:

memberOf in interface IGPDomain

Parameters:

value - A reference to a com.esri.arcgis.geodatabase.IGPValue (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.

getCount

public int getCount()
             throws IOException,
                    AutomationException

Count.

Product Availability

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

Supported Platforms

Windows

Specified by:

getCount in interface IGPFieldDomain

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public int getType(int index)
            throws IOException,
                   AutomationException

Field type.

Product Availability

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

Specified by:

getType in interface IGPFieldDomain

Parameters:

index - The index (in)

Returns:

A com.esri.arcgis.geodatabase.esriFieldType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addType

public void addType(int type)
             throws IOException,
                    AutomationException

Add a field type.

Product Availability

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

Supported Platforms

Windows

Specified by:

addType in interface IGPFieldDomain

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteType

public void deleteType(int type)
                throws IOException,
                       AutomationException

Remove a field type.

Product Availability

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

Supported Platforms

Windows

Specified by:

deleteType in interface IGPFieldDomain

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

makeList

public IArray makeList(IGPValue pValue)
                throws IOException,
                       AutomationException

Make list.

Product Availability

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

Supported Platforms

Windows

Specified by:

makeList in interface IGPFieldDomain

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIndexFilter

public void setIndexFilter(boolean filter,
                           boolean type)
                    throws IOException,
                           AutomationException

Set index filter.

Product Availability

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

Supported Platforms

Windows

Specified by:

setIndexFilter in interface IGPFieldDomain

Parameters:

filter - The filter (in)

type - The type (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFilterIndex

public boolean isFilterIndex()
                      throws IOException,
                             AutomationException

Indicates whether or not to filter fields based on whether or not they have an index.

Product Availability

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

Supported Platforms

Windows

Specified by:

isFilterIndex in interface IGPFieldDomain

Returns:

The pFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFilterIndexType

public boolean isFilterIndexType()
                          throws IOException,
                                 AutomationException

Indicates whether to filter fields that have or do not have an index.

Product Availability

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

Supported Platforms

Windows

Specified by:

isFilterIndexType in interface IGPFieldDomain

Returns:

The pType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeyFieldCount

public int getKeyFieldCount()
                     throws IOException,
                            AutomationException

Key field count.

Product Availability

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

Supported Platforms

Windows

Specified by:

getKeyFieldCount in interface IGPFieldDomain

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeyField

public String getKeyField(int index)
                   throws IOException,
                          AutomationException

Key field.

Product Availability

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

Specified by:

getKeyField in interface IGPFieldDomain

Parameters:

index - The index (in)

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addKeyField

public void addKeyField(String name)
                 throws IOException,
                        AutomationException

Add key field.

Product Availability

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

Supported Platforms

Windows

Specified by:

addKeyField in interface IGPFieldDomain

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeKeyField

public void removeKeyField(int index)
                    throws IOException,
                           AutomationException

Remove key field.

Product Availability

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

Supported Platforms

Windows

Specified by:

removeKeyField in interface IGPFieldDomain

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExcludeFieldCount

public int getExcludeFieldCount()
                         throws IOException,
                                AutomationException

Exclude field count.

Product Availability

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

Supported Platforms

Windows

Specified by:

getExcludeFieldCount in interface IGPFieldDomain

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExcludeField

public String getExcludeField(int index)
                       throws IOException,
                              AutomationException

Exclude field.

Product Availability

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

Specified by:

getExcludeField in interface IGPFieldDomain

Parameters:

index - The index (in)

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addExcludeField

public void addExcludeField(String name)
                     throws IOException,
                            AutomationException

Add exclude field.

Product Availability

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

Supported Platforms

Windows

Specified by:

addExcludeField in interface IGPFieldDomain

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeExcludeField

public void removeExcludeField(int index)
                        throws IOException,
                               AutomationException

Remove exclude field.

Product Availability

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

Supported Platforms

Windows

Specified by:

removeExcludeField in interface IGPFieldDomain

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseRasterFields

public boolean isUseRasterFields()
                          throws IOException,
                                 AutomationException

Enable raster attribute table for Mosaic dataset.

Product Availability

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

Specified by:

isUseRasterFields in interface IGPFieldDomain2

Returns:

The bVAT

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseRasterFields

public void setUseRasterFields(boolean bVAT)
                        throws IOException,
                               AutomationException

Enable raster attribute table for Mosaic dataset.

Product Availability

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

Specified by:

setUseRasterFields in interface IGPFieldDomain2

Parameters:

bVAT - The bVAT (in)

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