com.esri.arcgis.geodatabase
Class XMLIndex

java.lang.Object
  com.esri.arcgis.geodatabase.XMLIndex

All Implemented Interfaces:

IIndex, IIndexEdit, IXMLIndex, IXMLIndexEdit, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class XMLIndex
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IIndex, IIndexEdit, IXMLIndex, IXMLIndexEdit

XML Index Object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

XMLIndex()
Constructs a XMLIndex using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
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.
String	getName() The name of the index.
int	getXMLIndexType() The type of XML Index.
int	hashCode() the hashcode for this object
boolean	isAscending() Indicates if the index is based on ascending order.
boolean	isUnique() Indicates if the index is unique.
void	setDescription(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(String rhs1) The name of the index.
void	setXMLIndexType(int rhs1) The type of XML Index.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

XMLIndex

public XMLIndex()
         throws IOException,
                UnknownHostException

Constructs a XMLIndex using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

XMLIndex

public XMLIndex(Object obj)
         throws 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:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the index.

Remarks

ArcGIS imposes a limit on the length of 16 characters on the length of attribute index names. This limit is based on the smallest allowable length within supported databases in order to facilitate distribution and sharing of data between different geodatabases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IIndex

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUnique

public boolean isUnique()
                 throws IOException,
                        AutomationException

Indicates if the index is unique.

Remarks

If IsUnique is true, the field the Index was created for must not have duplicate values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isUnique in interface IIndex

Returns:

The isUnique

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAscending

public boolean isAscending()
                    throws IOException,
                           AutomationException

Indicates if the index is based on ascending order.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAscending in interface IIndex

Returns:

The isAscending

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws IOException,
                         AutomationException

The fields collection for this index.

Remarks

An Index cannot have more than 10 fields in an index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFields in interface IIndex

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String rhs1)
             throws IOException,
                    AutomationException

The name of the index.

Remarks

ArcGIS imposes a limit on the length of 16 characters on the length of attribute index names. This limit is based on the smallest allowable length within supported databases in order to facilitate distribution and sharing of data between different geodatabases.

Giving a shapefile index a name will apply the name to the index in memory, but the name will not be persisted to disk. On subsequent occasions when the indexes are opened, they will have system-defined names.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IIndexEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsUnique

public void setIsUnique(boolean rhs1)
                 throws IOException,
                        AutomationException

Indicates if the index is to be unique.

Remarks

Only non-versioned feature classes and tables can have unique indexes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIsUnique in interface IIndexEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsAscending

public void setIsAscending(boolean rhs1)
                    throws IOException,
                           AutomationException

Indicates if the index is to be ascending.

Remarks

Whether you can add an index that is ascending is dependent on the DBMS.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIsAscending in interface IIndexEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldsByRef

public void setFieldsByRef(IFields rhs1)
                    throws IOException,
                           AutomationException

The fields collection for this index.

Remarks

The number of fields in the fields collection of an index is DBMS dependent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFieldsByRef in interface IIndexEdit

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXMLIndexType

public int getXMLIndexType()
                    throws IOException,
                           AutomationException

The type of XML Index.

Product Availability

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

Specified by:

getXMLIndexType in interface IXMLIndex

Returns:

A com.esri.arcgis.geodatabase.esriXMLIndexType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIncludedTags

public IXMLIndexTags getIncludedTags()
                              throws IOException,
                                     AutomationException

The collection of included tags.

Product Availability

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

Specified by:

getIncludedTags in interface IXMLIndex

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExcludedTags

public IXMLIndexTags getExcludedTags()
                              throws IOException,
                                     AutomationException

The collection of excluded tags.

Product Availability

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

Specified by:

getExcludedTags in interface IXMLIndex

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

A textual description of the XML Index.

Product Availability

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

Specified by:

getDescription in interface IXMLIndex

Returns:

The indexDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXMLIndexType

public void setXMLIndexType(int rhs1)
                     throws IOException,
                            AutomationException

The type of XML Index.

Product Availability

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

Specified by:

setXMLIndexType in interface IXMLIndexEdit

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIncludedTagsByRef

public void setIncludedTagsByRef(IXMLIndexTags rhs1)
                          throws IOException,
                                 AutomationException

The collection of included tags.

Product Availability

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

Specified by:

setIncludedTagsByRef in interface IXMLIndexEdit

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExcludedTagsByRef

public void setExcludedTagsByRef(IXMLIndexTags rhs1)
                          throws IOException,
                                 AutomationException

The collection of excluded tags.

Product Availability

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

Specified by:

setExcludedTagsByRef in interface IXMLIndexEdit

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String rhs1)
                    throws IOException,
                           AutomationException

A textual description of the XML Index.

Product Availability

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

Specified by:

setDescription in interface IXMLIndexEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.