com.esri.arcgis.geoprocessing
Class GPCodedValueDomain

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.GPCodedValueDomain
All Implemented Interfaces:
IGPCodedValueDomain, IGPDomain, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class GPCodedValueDomain
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPCodedValueDomain, IGPDomain, IClone, IXMLSerialize, IPersistStream, java.io.Externalizable

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

Description 'Geoprocessing Coded Value Domain.' 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.geodatabase.IGPCodedValueDomain
IID, IID41dc44a0_d2eb_11d5_933f_0080c71a3226, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IGPDomain
IID, IID0948f56f_9a99_4672_959e_3519f5676add, xxDummy
 
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
 
Constructor Summary
GPCodedValueDomain()
          Constructs a GPCodedValueDomain using ArcGIS Engine.
GPCodedValueDomain(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPCodedValueDomain theGPCodedValueDomain = (GPCodedValueDomain) obj;
 
Method Summary
 void addCode(IGPValue value, java.lang.String name)
          Adds a (value, name) code.
 void addStringCode(java.lang.String value, java.lang.String name)
          Adds a (value, name) code.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void deleteCode(IGPValue value)
          Deletes a code with the specified value.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 void empty()
          Deletes all the codes.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 java.lang.String findName(IGPValue value)
          Provides the name for the specified value.
 IGPValue findValue(java.lang.String name)
          Provides the value object for the specified code.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 int getCodeCount()
          The number of codes for the associated attribute.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getName(int index)
          The code name for the specified code index.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 IGPValue getValue(int index)
          The value object for the specified code index.
 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 isIdentical(IClone other)
          Indicates if the receiver and other are the same object.
 void load(IStream pstm)
          load
 IGPMessage memberOf(IGPValue value)
          Indicates if the value object is a member of the geoprocessing domain type.
 void populateDomain(java.lang.String values, java.lang.String names, IGPDataType gPDataType)
          Populate the domain codes.
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a GPCodedValueDomain.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 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

GPCodedValueDomain

public GPCodedValueDomain()
                   throws java.io.IOException,
                          java.net.UnknownHostException
Constructs a GPCodedValueDomain using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

GPCodedValueDomain

public GPCodedValueDomain(java.lang.Object obj)
                   throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPCodedValueDomain theGPCodedValueDomain = (GPCodedValueDomain) obj;

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

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

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getCodeCount

public int getCodeCount()
                 throws java.io.IOException,
                        AutomationException
The number of codes for the associated attribute.

Specified by:
getCodeCount in interface IGPCodedValueDomain
Returns:
The values
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName(int index)
                         throws java.io.IOException,
                                AutomationException
The code name for the specified code index.

Specified by:
getName in interface IGPCodedValueDomain
Parameters:
index - The index (in)
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValue

public IGPValue getValue(int index)
                  throws java.io.IOException,
                         AutomationException
The value object for the specified code index.

Specified by:
getValue in interface IGPCodedValueDomain
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findValue

public IGPValue findValue(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException
Provides the value object for the specified code.

Specified by:
findValue in interface IGPCodedValueDomain
Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addCode

public void addCode(IGPValue value,
                    java.lang.String name)
             throws java.io.IOException,
                    AutomationException
Adds a (value, name) code.

Specified by:
addCode in interface IGPCodedValueDomain
Parameters:
value - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addStringCode

public void addStringCode(java.lang.String value,
                          java.lang.String name)
                   throws java.io.IOException,
                          AutomationException
Adds a (value, name) code.

Specified by:
addStringCode in interface IGPCodedValueDomain
Parameters:
value - The value (in)
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteCode

public void deleteCode(IGPValue value)
                throws java.io.IOException,
                       AutomationException
Deletes a code with the specified value.

Specified by:
deleteCode in interface IGPCodedValueDomain
Parameters:
value - 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.

empty

public void empty()
           throws java.io.IOException,
                  AutomationException
Deletes all the codes.

Specified by:
empty in interface IGPCodedValueDomain
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

populateDomain

public void populateDomain(java.lang.String values,
                           java.lang.String names,
                           IGPDataType gPDataType)
                    throws java.io.IOException,
                           AutomationException
Populate the domain codes.

Specified by:
populateDomain in interface IGPCodedValueDomain
Parameters:
values - The values (in)
names - The names (in)
gPDataType - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findName

public java.lang.String findName(IGPValue value)
                          throws java.io.IOException,
                                 AutomationException
Provides the name for the specified value.

Specified by:
findName in interface IGPCodedValueDomain
Parameters:
value - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Returns:
The name
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.

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.

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