com.esri.sde.sdk.client
Class SeXmlTag

java.lang.Object
  com.esri.sde.sdk.client.SeXmlTag

public final class SeXmlTag
extends java.lang.Object

Represents an XML Tag.

Constructor Summary

SeXmlTag()
Creates a new XML Tag object

Method Summary

int	getAlias() This method returns the numeric alias contained in this XML tag object.
int	getDataType() This method returns the data type contained in the XML tag object.
java.lang.String	getDescription() Return XML tag's description.
java.lang.String	getName() Return XML tag's name.
boolean	isExcluded() Return the XML tag's exclusion flag.
void	setAlias(int alias) Sets the XML tag's numeric alias.
void	setDataType(int dataType) Sets the XML tag's data type.
void	setDescription(java.lang.String description) Sets the XML tag's description.
void	setExclusion(boolean isExcluded) Sets the XML tag's exclusion.
void	setName(java.lang.String name) Sets the XML tag's name.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SeXmlTag

public SeXmlTag()

Creates a new XML Tag object

Method Detail

getName

public java.lang.String getName()
                         throws SeException

Return XML tag's name.

Returns:

The name of the tag.

Throws:

SeException

setName

public void setName(java.lang.String name)
             throws SeException

Sets the XML tag's name.

Parameters:

name - The name of the tag.

Throws:

SeException

getDescription

public java.lang.String getDescription()
                                throws SeException

Return XML tag's description.

Returns:

The tag's description.

Throws:

SeException

setDescription

public void setDescription(java.lang.String description)
                    throws SeException

Sets the XML tag's description.

Parameters:

description - The description of the tag.

Throws:

SeException

getDataType

public int getDataType()
                throws SeException

This method returns the data type contained in the XML tag object. The data type will be one of these values:

SeDefs.SE_XML_INDEX_DOUBLE_TYPE

SeDefs.SE_XML_INDEX_STRING_TYPE

Returns:

The data type of the tag.

Throws:

SeException

setDataType

public void setDataType(int dataType)
                 throws SeException

Sets the XML tag's data type. The data type must be one of these values.

SeDefs.SE_XML_INDEX_DOUBLE_TYPE

SeDefs.SE_XML_INDEX_STRING_TYPE

Parameters:

dataType - The data_type of the tag.

Throws:

SeException

getAlias

public int getAlias()
             throws SeException

This method returns the numeric alias contained in this XML tag object. When the value is zero, the tag is considered to not have an alias.

Returns:

The alias of the tag.

Throws:

SeException

setAlias

public void setAlias(int alias)
              throws SeException

Sets the XML tag's numeric alias.

Parameters:

alias - The alias of the tag.

Throws:

SeException

setExclusion

public void setExclusion(boolean isExcluded)
                  throws SeException

Sets the XML tag's exclusion.

Parameters:

isExcluded - True to exclude the tag from the index.

Throws:

SeException

isExcluded

public boolean isExcluded()
                   throws SeException

Return the XML tag's exclusion flag. If the flag is false, then the tag will be indexed. If the flag is true, then the tag will not be indexed

Returns:

exclusion flag contained in the XML tag object.

Throws:

SeException