com.esri.arcgis.geodatabase
Class GPCodedValueDomain2

java.lang.Object
  extended by com.esri.arcgis.geodatabase.GPCodedValueDomain2
All Implemented Interfaces:
IGPCodedValueDomain2, IGPDomain2, IGPValue, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class GPCodedValueDomain2
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPDomain2, IGPCodedValueDomain2, IGPValue, IPersistStream, IXMLSerialize, IClone, java.io.Externalizable

COM Class 'GPCodedValueDomain2'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description 'The (GP) Coded Value Domain Object.' 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.IGPDomain2
IID, IID1060ab89_dc4a_4a63_ae01_e1f2da1de886, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IGPCodedValueDomain2
IID, IID4bc49489_93a3_4945_9c24_e3e1bca04664, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IGPValue
IID, IID92ee08b6_c757_4178_803c_67cd665ac801, 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.system.IXMLSerialize
IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IClone
IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy
 
Constructor Summary
GPCodedValueDomain2()
          Constructs a GPCodedValueDomain2 using ArcGIS Engine.
GPCodedValueDomain2(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPCodedValueDomain2 theGPCodedValueDomain2 = (GPCodedValueDomain2) obj;
 
Method Summary
 void addCode(java.lang.Object value, java.lang.String name)
          Adds a (value, name) code.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void deleteCode(java.lang.Object value)
          Deletes a code with the specified value.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 void empty()
          Clears the value object.
 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 getAsText()
          Provides the value of the value object.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 int getCodeCount()
          The number of codes for the associated attribute.
 java.lang.String getDescription()
          The description of the domain.
 int getDomainID()
          The ID of the domain.
 int getFieldType()
          The field type of the field.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int getMergePolicy()
          The merge policy.
 java.lang.String getName()
          The name of the domain.
 java.lang.String getName(int index)
          The code name for the specified code index.
 java.lang.String getOwner()
          The owner of the domain.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int getSplitPolicy()
          The split policy.
 int getType()
          The domain type.
 java.lang.Object getValue(int index)
          The value for the specified code index.
 int hashCode()
          the hashcode for this object
 IGPDataType IGPValue_getDataType()
          The data type of the value object.
 void isDirty()
          isDirty
 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.
 void load(IStream pstm)
          load
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a GPCodedValueDomain2.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 IGPMessage setAsText(java.lang.String text)
          Provides the value of the value object with the given string value.
 void setDescription(java.lang.String description)
          The description of the domain.
 void setDomainID(int iD)
          The ID of the domain.
 void setFieldType(int fieldType)
          The field type of the field.
 void setMergePolicy(int policy)
          The merge policy.
 void setName(java.lang.String name)
          The name of the domain.
 void setOwner(java.lang.String owner)
          The owner of the domain.
 void setSplitPolicy(int policy)
          The split policy.
 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

GPCodedValueDomain2

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

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

GPCodedValueDomain2

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

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

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

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

getDomainID

public int getDomainID()
                throws java.io.IOException,
                       AutomationException
The ID of the domain.

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

setDomainID

public void setDomainID(int iD)
                 throws java.io.IOException,
                        AutomationException
The ID of the domain.

Specified by:
setDomainID in interface IGPDomain2
Parameters:
iD - The iD (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException
The description of the domain.

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

setDescription

public void setDescription(java.lang.String description)
                    throws java.io.IOException,
                           AutomationException
The description of the domain.

Specified by:
setDescription in interface IGPDomain2
Parameters:
description - The description (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldType

public int getFieldType()
                 throws java.io.IOException,
                        AutomationException
The field type of the field.

Specified by:
getFieldType in interface IGPDomain2
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.

setFieldType

public void setFieldType(int fieldType)
                  throws java.io.IOException,
                         AutomationException
The field type of the field.

Specified by:
setFieldType in interface IGPDomain2
Parameters:
fieldType - 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.

getMergePolicy

public int getMergePolicy()
                   throws java.io.IOException,
                          AutomationException
The merge policy.

Specified by:
getMergePolicy in interface IGPDomain2
Returns:
A com.esri.arcgis.geodatabase.esriMergePolicyType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMergePolicy

public void setMergePolicy(int policy)
                    throws java.io.IOException,
                           AutomationException
The merge policy.

Specified by:
setMergePolicy in interface IGPDomain2
Parameters:
policy - A com.esri.arcgis.geodatabase.esriMergePolicyType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSplitPolicy

public int getSplitPolicy()
                   throws java.io.IOException,
                          AutomationException
The split policy.

Specified by:
getSplitPolicy in interface IGPDomain2
Returns:
A com.esri.arcgis.geodatabase.esriSplitPolicyType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSplitPolicy

public void setSplitPolicy(int policy)
                    throws java.io.IOException,
                           AutomationException
The split policy.

Specified by:
setSplitPolicy in interface IGPDomain2
Parameters:
policy - A com.esri.arcgis.geodatabase.esriSplitPolicyType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The name of the domain.

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

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException
The name of the domain.

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

getOwner

public java.lang.String getOwner()
                          throws java.io.IOException,
                                 AutomationException
The owner of the domain.

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

setOwner

public void setOwner(java.lang.String owner)
              throws java.io.IOException,
                     AutomationException
The owner of the domain.

Specified by:
setOwner in interface IGPDomain2
Parameters:
owner - The owner (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws java.io.IOException,
                   AutomationException
The domain type.

Specified by:
getType in interface IGPDomain2
Returns:
A com.esri.arcgis.geodatabase.esriDomainType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCodeCount

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

Specified by:
getCodeCount in interface IGPCodedValueDomain2
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 IGPCodedValueDomain2
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 java.lang.Object getValue(int index)
                          throws java.io.IOException,
                                 AutomationException
The value for the specified code index.

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

addCode

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

Specified by:
addCode in interface IGPCodedValueDomain2
Parameters:
value - A Variant (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(java.lang.Object value)
                throws java.io.IOException,
                       AutomationException
Deletes a code with the specified value.

Specified by:
deleteCode in interface IGPCodedValueDomain2
Parameters:
value - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

IGPValue_getDataType

public IGPDataType IGPValue_getDataType()
                                 throws java.io.IOException,
                                        AutomationException
The data type of the value object.

Specified by:
IGPValue_getDataType in interface IGPValue
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPDataType
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws java.io.IOException,
                       AutomationException
Indicates if the value object is empty.

Specified by:
isEmpty in interface IGPValue
Returns:
The isEmpty
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
Clears the value object.

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

getAsText

public java.lang.String getAsText()
                           throws java.io.IOException,
                                  AutomationException
Provides the value of the value object.

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

setAsText

public IGPMessage setAsText(java.lang.String text)
                     throws java.io.IOException,
                            AutomationException
Provides the value of the value object with the given string value.

Specified by:
setAsText in interface IGPValue
Parameters:
text - The text (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.

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.

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.

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.

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