com.esri.arcgis.geodatabase

Class CodedValueDomain

java.lang.Object

com.esri.arcgis.geodatabase.CodedValueDomain

All Implemented Interfaces:

ICodedValueDomain, ICodedValueDomain2, IDomain, ISchemaLock, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class CodedValueDomain
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDomain, ICodedValueDomain, ICodedValueDomain2, IClone, IPersist, IPersistStream, ISchemaLock, IXMLSerialize, java.io.Externalizable

COM Class 'CodedValueDomain'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description 'Esri Attribute set constraint 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

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

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

IID, IIDdf18fe0a_84ba_11d2_ab61_000000000000, xxDummy

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

IID, IID057e88c6_0e61_426e_b4bb_d192c481cf1f, xxDummy

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

IIDfcb6bf33_475d_11d2_9932_0000f80372b4

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

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, 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.ISchemaLock

IID, IIDdca648e5_0fbb_11d3_80a5_00c04f686238, xxDummy

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

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Constructor Summary

Constructors

Constructor and Description
CodedValueDomain() Constructs a CodedValueDomain using ArcGIS Engine.
CodedValueDomain(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. CodedValueDomain theCodedValueDomain = (CodedValueDomain) obj;

Method Summary

Modifier and Type	Method and Description
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	changeSchemaLock(int schemaLock) Changes a schema lock.
void	deleteCode(java.lang.Object value) Deletes a code with the specified value.
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	getCodeCount() The number of codes for the associated attribute.
void	getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo) The list of current locks.
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() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
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
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
boolean	memberOf(java.lang.Object value) Indicates whether the value is a valid member of the domain.
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
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	sortByName(boolean descending) Sort the codes in the coded value domain by name.
void	sortByValue(boolean descending) Sort the codes in the coded value domain by value.
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

CodedValueDomain

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

Constructs a CodedValueDomain using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

CodedValueDomain

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

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

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

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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

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 IDomain

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 IDomain

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 IDomain

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 IDomain

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 IDomain

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 IDomain

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 IDomain

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 IDomain

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 IDomain

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 IDomain

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 IDomain

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 IDomain

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 IDomain

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 IDomain

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 IDomain

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.

memberOf

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

Indicates whether the value is a valid member of the domain.

Specified by:

memberOf in interface IDomain

Parameters:

value - A Variant (in)

Returns:

The isMember

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 ICodedValueDomain

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 ICodedValueDomain

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 ICodedValueDomain

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 ICodedValueDomain

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 ICodedValueDomain

Parameters:

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

sortByName

public void sortByName(boolean descending)
                throws java.io.IOException,
                       AutomationException

Sort the codes in the coded value domain by name.

Specified by:

sortByName in interface ICodedValueDomain2

Parameters:

descending - The descending (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

sortByValue

public void sortByValue(boolean descending)
                 throws java.io.IOException,
                        AutomationException

Sort the codes in the coded value domain by value.

Specified by:

sortByValue in interface ICodedValueDomain2

Parameters:

descending - The descending (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.

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.

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.

changeSchemaLock

public void changeSchemaLock(int schemaLock)
                      throws java.io.IOException,
                             AutomationException

Changes a schema lock.

Specified by:

changeSchemaLock in interface ISchemaLock

Parameters:

schemaLock - A com.esri.arcgis.geodatabase.esriSchemaLock constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentSchemaLocks

public void getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)
                           throws java.io.IOException,
                                  AutomationException

The list of current locks.

Specified by:

getCurrentSchemaLocks in interface ISchemaLock

Parameters:

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

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