com.esri.arcgis.geoprocessing
Class GPRAFieldDomain

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

All Implemented Interfaces:

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

public class GPRAFieldDomain
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IClone, IXMLSerialize, IPersistStream, IGPDomain, IGPFieldDomain, IGPFieldDomain2, IGPRAFieldDomain, java.io.Externalizable

COM Class 'GPRAFieldDomain'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description 'GP Raster Field Domain - Additional handling of shapefile's integer fields.' 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.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

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

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, 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

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

IID, IID0948f56f_9a99_4672_959e_3519f5676add, xxDummy

Fields inherited from interface com.esri.arcgis.geoprocessing.IGPFieldDomain

IID, IID638026f2_f9c4_4a39_a6c6_6932a0d51fe3, xxDummy

Fields inherited from interface com.esri.arcgis.geoprocessing.IGPFieldDomain2

IID, IIDb94013bd_8e40_4dcf_ac8b_29807f15d3bf, xxDummy

Fields inherited from interface com.esri.arcgis.geoprocessing.IGPRAFieldDomain

IID, IID2f135584_7063_4772_9f1c_144461876d2a, xxDummy

Constructor Summary

GPRAFieldDomain()
Constructs a GPRAFieldDomain using ArcGIS Engine.

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

Method Summary

void	addExcludeField(java.lang.String name) Add exclude field.
void	addKeyField(java.lang.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(java.lang.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 java.lang.String	getClsid() getClsid.
int	getCount() Count.
java.lang.String	getExcludeField(int index) Exclude field.
int	getExcludeFieldCount() Exclude field count.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.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(java.io.ObjectInput in)
void	release() Release a GPRAFieldDomain.
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	setDependValueByRef(IGPValue rhs1) Dependent value object.
void	setIndexFilter(boolean filter, boolean type) Set index filter.
void	setUseRasterFields(boolean bVAT) Enable raster attribute table for Mosaic dataset.
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

GPRAFieldDomain

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

Constructs a GPRAFieldDomain using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GPRAFieldDomain

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

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

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

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

Specified by:

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

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

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

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

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

Returns:

The identical

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

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

memberOf

public IGPMessage memberOf(IGPValue value)
                    throws java.io.IOException,
                           AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws java.io.IOException,
                    AutomationException

Count.

Specified by:

getCount in interface IGPFieldDomain

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

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

Field type.

Specified by:

getType in interface IGPFieldDomain

Parameters:

index - The index (in)

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.

addType

public void addType(int type)
             throws java.io.IOException,
                    AutomationException

Add a field type.

Specified by:

addType in interface IGPFieldDomain

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteType

public void deleteType(int type)
                throws java.io.IOException,
                       AutomationException

Remove a field type.

Specified by:

deleteType in interface IGPFieldDomain

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

makeList

public IArray makeList(IGPValue pValue)
                throws java.io.IOException,
                       AutomationException

Make list.

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:

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

AutomationException - If the ArcObject component throws an exception.

setIndexFilter

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

Set index filter.

Specified by:

setIndexFilter in interface IGPFieldDomain

Parameters:

filter - The filter (in)

type - The type (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFilterIndex

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

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

Specified by:

isFilterIndex in interface IGPFieldDomain

Returns:

The pFilter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFilterIndexType

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

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

Specified by:

isFilterIndexType in interface IGPFieldDomain

Returns:

The pType

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getKeyFieldCount

public int getKeyFieldCount()
                     throws java.io.IOException,
                            AutomationException

Key field count.

Specified by:

getKeyFieldCount in interface IGPFieldDomain

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getKeyField

public java.lang.String getKeyField(int index)
                             throws java.io.IOException,
                                    AutomationException

Key field.

Specified by:

getKeyField in interface IGPFieldDomain

Parameters:

index - The index (in)

Returns:

The pName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addKeyField

public void addKeyField(java.lang.String name)
                 throws java.io.IOException,
                        AutomationException

Add key field.

Specified by:

addKeyField in interface IGPFieldDomain

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeKeyField

public void removeKeyField(int index)
                    throws java.io.IOException,
                           AutomationException

Remove key field.

Specified by:

removeKeyField in interface IGPFieldDomain

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExcludeFieldCount

public int getExcludeFieldCount()
                         throws java.io.IOException,
                                AutomationException

Exclude field count.

Specified by:

getExcludeFieldCount in interface IGPFieldDomain

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExcludeField

public java.lang.String getExcludeField(int index)
                                 throws java.io.IOException,
                                        AutomationException

Exclude field.

Specified by:

getExcludeField in interface IGPFieldDomain

Parameters:

index - The index (in)

Returns:

The pName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addExcludeField

public void addExcludeField(java.lang.String name)
                     throws java.io.IOException,
                            AutomationException

Add exclude field.

Specified by:

addExcludeField in interface IGPFieldDomain

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeExcludeField

public void removeExcludeField(int index)
                        throws java.io.IOException,
                               AutomationException

Remove exclude field.

Specified by:

removeExcludeField in interface IGPFieldDomain

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseRasterFields

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

Enable raster attribute table for Mosaic dataset.

Specified by:

isUseRasterFields in interface IGPFieldDomain2

Returns:

The bVAT

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseRasterFields

public void setUseRasterFields(boolean bVAT)
                        throws java.io.IOException,
                               AutomationException

Enable raster attribute table for Mosaic dataset.

Specified by:

setUseRasterFields in interface IGPFieldDomain2

Parameters:

bVAT - The bVAT (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDependValueByRef

public void setDependValueByRef(IGPValue rhs1)
                         throws java.io.IOException,
                                AutomationException

Dependent value object.

Specified by:

setDependValueByRef in interface IGPRAFieldDomain

Parameters:

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

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