com.esri.arcgis.geodatabase
Class XMLIndexTemplate

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

All Implemented Interfaces:

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

public class XMLIndexTemplate
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IXMLIndexTemplate

XML Index Template Object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

XMLIndexTemplate()
Constructs a XMLIndexTemplate using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
String	getDescription() A textual description of the template.
IXMLIndexTags	getExcludedTags() The set of tags to be used for the ExcludedTags property of an XML Index.
IXMLIndexTags	getIncludedTags() The set of tags to be used for the IncludedTags property of an XML Index.
String	getName() A user defineable name which must be globally unique to the Geodatabase instance.
int	hashCode() the hashcode for this object
void	setDescription(String templateDescription) A textual description of the template.
void	setExcludedTagsByRef(IXMLIndexTags tags) The set of tags to be used for the ExcludedTags property of an XML Index.
void	setIncludedTagsByRef(IXMLIndexTags tags) The set of tags to be used for the IncludedTags property of an XML Index.
void	setName(String templateName) A user defineable name which must be globally unique to the Geodatabase instance.

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

XMLIndexTemplate

public XMLIndexTemplate()
                 throws IOException,
                        UnknownHostException

Constructs a XMLIndexTemplate using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

XMLIndexTemplate

public XMLIndexTemplate(Object obj)
                 throws IOException

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

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

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

A user defineable name which must be globally unique to the Geodatabase instance.

Product Availability

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

Specified by:

getName in interface IXMLIndexTemplate

Returns:

The templateName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String templateName)
             throws IOException,
                    AutomationException

A user defineable name which must be globally unique to the Geodatabase instance.

Product Availability

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

Specified by:

setName in interface IXMLIndexTemplate

Parameters:

templateName - The templateName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIncludedTags

public IXMLIndexTags getIncludedTags()
                              throws IOException,
                                     AutomationException

The set of tags to be used for the IncludedTags property of an XML Index.

Product Availability

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

Specified by:

getIncludedTags in interface IXMLIndexTemplate

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.

setIncludedTagsByRef

public void setIncludedTagsByRef(IXMLIndexTags tags)
                          throws IOException,
                                 AutomationException

The set of tags to be used for the IncludedTags property of an XML Index.

Product Availability

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

Specified by:

setIncludedTagsByRef in interface IXMLIndexTemplate

Parameters:

tags - 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.

getExcludedTags

public IXMLIndexTags getExcludedTags()
                              throws IOException,
                                     AutomationException

The set of tags to be used for the ExcludedTags property of an XML Index.

Product Availability

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

Specified by:

getExcludedTags in interface IXMLIndexTemplate

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.

setExcludedTagsByRef

public void setExcludedTagsByRef(IXMLIndexTags tags)
                          throws IOException,
                                 AutomationException

The set of tags to be used for the ExcludedTags property of an XML Index.

Product Availability

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

Specified by:

setExcludedTagsByRef in interface IXMLIndexTemplate

Parameters:

tags - 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.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

A textual description of the template.

Product Availability

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

Specified by:

getDescription in interface IXMLIndexTemplate

Returns:

The templateDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String templateDescription)
                    throws IOException,
                           AutomationException

A textual description of the template.

Product Availability

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

Specified by:

setDescription in interface IXMLIndexTemplate

Parameters:

templateDescription - The templateDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.