com.esri.arcgis.geodatabase
Class XMLIndexTag

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

All Implemented Interfaces:

IXMLIndexTag, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class XMLIndexTag
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IXMLIndexTag

XML Index Tag Object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

XMLIndexTag()
Constructs a XMLIndexTag using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getDataType() The data type classification of the index tag.
String	getDescription() A textual description of the index tag.
int	getLocationAlias() An optional property which associates a number with the index tag.
String	getName() The name formatted as the full locational path of the XML schema.
int	hashCode() the hashcode for this object
void	setDataType(int dataType) The data type classification of the index tag.
void	setDescription(String tagDescription) A textual description of the index tag.
void	setLocationAlias(int alias) An optional property which associates a number with the index tag.
void	setName(String indexName) The name formatted as the full locational path of the XML schema.

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

XMLIndexTag

public XMLIndexTag()
            throws IOException,
                   UnknownHostException

Constructs a XMLIndexTag using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

XMLIndexTag

public XMLIndexTag(Object obj)
            throws IOException

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

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

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 formatted as the full locational path of the XML schema.

Product Availability

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

Specified by:

getName in interface IXMLIndexTag

Returns:

The indexName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String indexName)
             throws IOException,
                    AutomationException

The name formatted as the full locational path of the XML schema.

Product Availability

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

Specified by:

setName in interface IXMLIndexTag

Parameters:

indexName - The indexName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataType

public int getDataType()
                throws IOException,
                       AutomationException

The data type classification of the index tag.

Product Availability

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

Specified by:

getDataType in interface IXMLIndexTag

Returns:

A com.esri.arcgis.geodatabase.esriXMLIndexTagDataType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataType

public void setDataType(int dataType)
                 throws IOException,
                        AutomationException

The data type classification of the index tag.

Product Availability

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

Specified by:

setDataType in interface IXMLIndexTag

Parameters:

dataType - A com.esri.arcgis.geodatabase.esriXMLIndexTagDataType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocationAlias

public int getLocationAlias()
                     throws IOException,
                            AutomationException

An optional property which associates a number with the index tag.

Product Availability

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

Specified by:

getLocationAlias in interface IXMLIndexTag

Returns:

The alias

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocationAlias

public void setLocationAlias(int alias)
                      throws IOException,
                             AutomationException

An optional property which associates a number with the index tag.

Product Availability

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

Specified by:

setLocationAlias in interface IXMLIndexTag

Parameters:

alias - The alias (in)

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 index tag.

Product Availability

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

Specified by:

getDescription in interface IXMLIndexTag

Returns:

The tagDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String tagDescription)
                    throws IOException,
                           AutomationException

A textual description of the index tag.

Product Availability

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

Specified by:

setDescription in interface IXMLIndexTag

Parameters:

tagDescription - The tagDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.