com.esri.arcgis.geodatabase

Class XMLIndexTemplate

java.lang.Object

com.esri.arcgis.geodatabase.XMLIndexTemplate

All Implemented Interfaces:

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

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

COM Class 'XMLIndexTemplate'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description 'XML Index Template 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 inherited from interface com.esri.arcgis.geodatabase.IXMLIndexTemplate

IID, IID5c2b7178_119e_4d2d_bad6_57769f9a2eec, xxDummy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
java.lang.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.
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() A user defineable name which must be globally unique to the Geodatabase instance.
int	hashCode() the hashcode for this object
void	release() Release this COM object reference
void	setDescription(java.lang.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(java.lang.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

Constructor Detail

XMLIndexTemplate

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

Constructs a XMLIndexTemplate using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

XMLIndexTemplate

public XMLIndexTemplate(java.lang.Object obj)
                 throws java.io.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:

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

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

Specified by:

getName in interface IXMLIndexTemplate

Returns:

The templateName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

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

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

Specified by:

setName in interface IXMLIndexTemplate

Parameters:

templateName - The templateName (in)

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 set of tags to be used for the IncludedTags property of an XML Index.

Specified by:

getIncludedTags in interface IXMLIndexTemplate

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.

setIncludedTagsByRef

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

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

Specified by:

setIncludedTagsByRef in interface IXMLIndexTemplate

Parameters:

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

getExcludedTags

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

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

Specified by:

getExcludedTags in interface IXMLIndexTemplate

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.

setExcludedTagsByRef

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

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

Specified by:

setExcludedTagsByRef in interface IXMLIndexTemplate

Parameters:

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

getDescription

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

A textual description of the template.

Specified by:

getDescription in interface IXMLIndexTemplate

Returns:

The templateDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

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

A textual description of the template.

Specified by:

setDescription in interface IXMLIndexTemplate

Parameters:

templateDescription - The templateDescription (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.