com.esri.sde.sdk.client
Class SeXmlColumn

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

public final class SeXmlColumn
extends java.lang.Object

This class represents an Xml column.

Since:

ArcSDE 9.0

Constructor Summary

SeXmlColumn(SeConnection conn)
This constructor creates a new SeXmlColumn object and is used to add an XML column to an existing ArcSDE table.

SeXmlColumn(SeConnection conn, java.lang.String table, java.lang.String column)
This constructor retrieves information about an existing XML column from an ArcSDE table.

Method Summary

void	alter() This method alters an existing XML column on an existing table.
void	create() This method creates an XML column on an existing table.
void	delete(java.lang.String table, java.lang.String column) This method deletes an XML column from an existing table.
java.lang.String	getCreationKeyword() This method returns the XML column's DBTUNE creation keyword.
SeXmlIndex	getIndex() This method retrieves an XML column's index information.
void	getInfo(java.lang.String table, java.lang.String column) Retrieves information about an existing XML column from an ArcSDE table.
int	getMinimumId() Return XML xmlcolumn's minimum id.
int	getStorageType() Returns xmlcolumn's storage type which can be either SE_XML_SDE_STORAGE_TYPE (sde custom type) or SE_XML_DB_STORAGE_TYPE (database native xml type).
java.lang.String[]	getXmlColumn() Returns a two dimensional string array containing the the ArcSDE table name and the XML column name.
java.lang.String	getXmlSchema() Get xmlcolumn's schema name
boolean	hasIndex() Returns true if this XML column has index information.
boolean	isInCompressedMode() Is the XML column in uncompressed mode.
void	setCreationKeyword(java.lang.String keyword) Sets the XML column's DBTUNE creation keyword.
void	setIndex(SeXmlIndex index) Sets the xmlcolumn's index.
void	setMinimumId(int minimumId) Sets the XML xmlcolumn's minimum id.
void	setStorageType(int storageType) Sets xmlcolumn's storage_type.
void	setUncompressMode() Sets XMLCOLUMN into uncompressed mode.
void	setXmlColumn(java.lang.String table, java.lang.String columnName) Sets the table and xml column name.
void	setXmlSchema(java.lang.String schemaName) Sets xmlcolumn's schema name

Methods inherited from class java.lang.Object

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

Constructor Detail

SeXmlColumn

public SeXmlColumn(SeConnection conn)

This constructor creates a new SeXmlColumn object and is used to add an XML column to an existing ArcSDE table.

SeXmlColumn

public SeXmlColumn(SeConnection conn,
                   java.lang.String table,
                   java.lang.String column)
            throws SeException

This constructor retrieves information about an existing XML column from an ArcSDE table.

Parameters:

conn - handle to an open SeConnection.

table - the name of the ArcSDE table containing the XML column.

column - the XML column name.

Throws:

SeException

Method Detail

alter

public void alter()
           throws SeException

This method alters an existing XML column on an existing table. The column's configuration keyword, minimum ID and XML index may be modified.

Throws:

SeException

create

public void create()
            throws SeException

This method creates an XML column on an existing table. To create a new XML column, create a new SeXmlColumn object, populate it with information describing the properties of the new XML column, and then call this function.

Throws:

SeException

delete

public void delete(java.lang.String table,
                   java.lang.String column)
            throws SeException

This method deletes an XML column from an existing table. The column's index, if any, is also deleted.

Parameters:

table - XML column's table name.

column - XML column name.

Throws:

SeException

getCreationKeyword

public java.lang.String getCreationKeyword()
                                    throws SeException

This method returns the XML column's DBTUNE creation keyword. This is the keyword that was (or will be) used to create the XML column.

Returns:

The configuration keyword of the XML column.

Throws:

SeException

setCreationKeyword

public void setCreationKeyword(java.lang.String keyword)
                        throws SeException

Sets the XML column's DBTUNE creation keyword.

Parameters:

keyword - The column's creation keyword.

Throws:

SeException

getMinimumId

public int getMinimumId()
                 throws SeException

Return XML xmlcolumn's minimum id.

Returns:

The minimum id of the xmlcolumn.

Throws:

SeException

setMinimumId

public void setMinimumId(int minimumId)
                  throws SeException

Sets the XML xmlcolumn's minimum id.

Parameters:

minimumId - The minimum id of the xmlcolumn.

Throws:

SeException

setUncompressMode

public void setUncompressMode()
                       throws SeException

Sets XMLCOLUMN into uncompressed mode. This routine configures the SE_XMLCOLUMNINFO object to be in uncompressed mode.

Throws:

SeException

isInCompressedMode

public boolean isInCompressedMode()
                           throws SeException

Is the XML column in uncompressed mode. This routine returns TRUE if the XML column object is configured to in uncompressed mode. All other conditions, including invalid XMLCOLUMN objects, will return FALSE.

Throws:

SeException

getXmlColumn

public java.lang.String[] getXmlColumn()
                                throws SeException

Returns a two dimensional string array containing the the ArcSDE table name and the XML column name.

Returns:

The ArcSDE table name and the XML column name.

Throws:

SeException

setXmlColumn

public void setXmlColumn(java.lang.String table,
                         java.lang.String columnName)
                  throws SeException

Sets the table and xml column name.

Parameters:

table - The column's table.

columnName - The xml column name.

Throws:

SeException

getInfo

public void getInfo(java.lang.String table,
                    java.lang.String column)
             throws SeException

Retrieves information about an existing XML column from an ArcSDE table.

Parameters:

table - the name of the ArcSDE table containing the XML column.

column - the XML column name.

Throws:

SeException

getIndex

public SeXmlIndex getIndex()
                    throws SeException

This method retrieves an XML column's index information. Before calling this method, call the hasIndex() method to determine if this XML column has any index information.

Returns:

The index of the xmlcolumn.

Throws:

SeException

setIndex

public void setIndex(SeXmlIndex index)
              throws SeException

Sets the xmlcolumn's index.

Parameters:

index - Index for the xmlcolumn.

Throws:

SeException

hasIndex

public boolean hasIndex()
                 throws SeException

Returns true if this XML column has index information. The index information can be retrieved using getIndex().

Returns:

true if there's an index, false otherwise.

Throws:

SeException

getStorageType

public int getStorageType()
                   throws SeException

Returns xmlcolumn's storage type which can be either SE_XML_SDE_STORAGE_TYPE (sde custom type) or SE_XML_DB_STORAGE_TYPE (database native xml type).

Returns:

the XML storage type.

Throws:

SeException

setStorageType

public void setStorageType(int storageType)
                    throws SeException

Sets xmlcolumn's storage_type.

Throws:

SeException

setXmlSchema

public void setXmlSchema(java.lang.String schemaName)
                  throws SeException

Sets xmlcolumn's schema name

Throws:

SeException

getXmlSchema

public java.lang.String getXmlSchema()
                              throws SeException

Get xmlcolumn's schema name

Throws:

SeException