com.esri.arcgis.geodatabase
Interface IXMLIndex

All Superinterfaces:

Serializable

All Known Subinterfaces:

IXMLIndexEdit

All Known Implementing Classes:

XMLIndex

public interface IXMLIndex
extends Serializable

A XML Index defines the searchable tags of an XML document stored in an XML field.

Product Availability

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

Method Summary

String	getDescription() A textual description of the XML Index.
IXMLIndexTags	getExcludedTags() The collection of excluded tags.
IXMLIndexTags	getIncludedTags() The collection of included tags.
int	getXMLIndexType() The type of XML Index.

Method Detail

getXMLIndexType

int getXMLIndexType()
                    throws IOException,
                           AutomationException

The type of XML Index.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriXMLIndexType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIncludedTags

IXMLIndexTags getIncludedTags()
                              throws IOException,
                                     AutomationException

The collection of included tags.

Product Availability

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

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

IXMLIndexTags getExcludedTags()
                              throws IOException,
                                     AutomationException

The collection of excluded tags.

Product Availability

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

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

String getDescription()
                      throws IOException,
                             AutomationException

A textual description of the XML Index.

Product Availability

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

Returns:

The indexDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.