com.esri.arcgis.geodatabase

Class XMLIndex

java.lang.Object

com.esri.arcgis.geodatabase.XMLIndex

All Implemented Interfaces:

IGPDescribe, IGPValue, IIndex, IIndexEdit, IXMLIndex, IXMLIndexEdit, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class XMLIndex
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IIndex, IIndexEdit, IXMLIndex, IXMLIndexEdit, IPersist, IClone, IGPValue, IXMLSerialize, IPersistStream, IGPDescribe, java.io.Externalizable

COM Class 'XMLIndex'. Generated 9/21/2023 10:01:43 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description 'XML Index 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.IIndexEdit

IID, IID2063fd02_4ce0_11d1_89db_006097aff44e, xxDummy

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

IID2063fd01_4ce0_11d1_89db_006097aff44e

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

IID, IID537fc360_cc9b_4671_b155_07d141fe8d99, xxDummy

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

IID5240ceaa_366d_42ed_97fe_61dfb3c20248

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

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

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	assign(IClone src) Assigns the properties of src to the receiver.
java.lang.Object	describe(java.lang.String name) The description of the named object.
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.
java.lang.String	getDescription() A textual description of the XML Index.
IXMLIndexTags	getExcludedTags() The collection of excluded tags.
IFields	getFields() The fields collection for this index.
IXMLIndexTags	getIncludedTags() The collection of included tags.
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.
java.lang.String	getName() The name of the index.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getXMLIndexType() The type of XML Index.
int	hashCode() the hashcode for this object
IGPDataType	IGPValue_getDataType() The data type of the value object.
boolean	isAscending() Indicates if the index is based on ascending order.
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.
boolean	isUnique() Indicates if the index is unique.
void	load(IStream pstm) load
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.
IGPMessage	setAsText(java.lang.String text) Provides the value of the value object with the given string value.
void	setDescription(java.lang.String rhs1) A textual description of the XML Index.
void	setExcludedTagsByRef(IXMLIndexTags rhs1) The collection of excluded tags.
void	setFieldsByRef(IFields rhs1) The fields collection for this index.
void	setIncludedTagsByRef(IXMLIndexTags rhs1) The collection of included tags.
void	setIsAscending(boolean rhs1) Indicates if the index is to be ascending.
void	setIsUnique(boolean rhs1) Indicates if the index is to be unique.
void	setName(java.lang.String rhs1) The name of the index.
void	setXMLIndexType(int rhs1) The type of XML Index.
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

XMLIndex

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

Constructs a XMLIndex using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

XMLIndex

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

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

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

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

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the index.

Specified by:

getName in interface IIndex

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUnique

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

Indicates if the index is unique.

Specified by:

isUnique in interface IIndex

Returns:

The isUnique

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAscending

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

Indicates if the index is based on ascending order.

Specified by:

isAscending in interface IIndex

Returns:

The isAscending

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws java.io.IOException,
                         AutomationException

The fields collection for this index.

Specified by:

getFields in interface IIndex

Returns:

A reference to a com.esri.arcgis.geodatabase.IFields

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String rhs1)
             throws java.io.IOException,
                    AutomationException

The name of the index.

Specified by:

setName in interface IIndexEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsUnique

public void setIsUnique(boolean rhs1)
                 throws java.io.IOException,
                        AutomationException

Indicates if the index is to be unique.

Specified by:

setIsUnique in interface IIndexEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsAscending

public void setIsAscending(boolean rhs1)
                    throws java.io.IOException,
                           AutomationException

Indicates if the index is to be ascending.

Specified by:

setIsAscending in interface IIndexEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFieldsByRef

public void setFieldsByRef(IFields rhs1)
                    throws java.io.IOException,
                           AutomationException

The fields collection for this index.

Specified by:

setFieldsByRef in interface IIndexEdit

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getXMLIndexType

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

The type of XML Index.

Specified by:

getXMLIndexType in interface IXMLIndex

Returns:

A com.esri.arcgis.geodatabase.esriXMLIndexType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIncludedTags

public IXMLIndexTags getIncludedTags()
                              throws java.io.IOException,
                                     AutomationException

The collection of included tags.

Specified by:

getIncludedTags in interface IXMLIndex

Returns:

A reference to a com.esri.arcgis.geodatabase.IXMLIndexTags

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExcludedTags

public IXMLIndexTags getExcludedTags()
                              throws java.io.IOException,
                                     AutomationException

The collection of excluded tags.

Specified by:

getExcludedTags in interface IXMLIndex

Returns:

A reference to a com.esri.arcgis.geodatabase.IXMLIndexTags

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

A textual description of the XML Index.

Specified by:

getDescription in interface IXMLIndex

Returns:

The indexDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setXMLIndexType

public void setXMLIndexType(int rhs1)
                     throws java.io.IOException,
                            AutomationException

The type of XML Index.

Specified by:

setXMLIndexType in interface IXMLIndexEdit

Parameters:

rhs1 - A com.esri.arcgis.geodatabase.esriXMLIndexType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIncludedTagsByRef

public void setIncludedTagsByRef(IXMLIndexTags rhs1)
                          throws java.io.IOException,
                                 AutomationException

The collection of included tags.

Specified by:

setIncludedTagsByRef in interface IXMLIndexEdit

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExcludedTagsByRef

public void setExcludedTagsByRef(IXMLIndexTags rhs1)
                          throws java.io.IOException,
                                 AutomationException

The collection of excluded tags.

Specified by:

setExcludedTagsByRef in interface IXMLIndexEdit

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String rhs1)
                    throws java.io.IOException,
                           AutomationException

A textual description of the XML Index.

Specified by:

setDescription in interface IXMLIndexEdit

Parameters:

rhs1 - The rhs1 (in)

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.

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.

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.

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.

describe

public java.lang.Object describe(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException

The description of the named object.

Product Availability

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

Specified by:

describe in interface IGPDescribe

Parameters:

name - The name (in)

Returns:

A Variant

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