com.esri.sde.sdk.client
Class SeRegisteredColumn

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

All Implemented Interfaces:

java.lang.Cloneable

public class SeRegisteredColumn
extends java.lang.Object
implements java.lang.Cloneable

Represents the description of a table's column registration entry.

Constructor Summary

SeRegisteredColumn(SeConnection conn)
Defines a blank registered column object.

Method Summary

boolean	allowsNulls() Returns true if this column allows null values.
java.lang.Object	clone() Returns a new instance of this SeRegisteredColumn.
SeRegisteredColumn	duplicate() Deep copy a column object.
void	free() Free a column object.
int	getDecimalDigits() Returns the SDE_declared number of decimal places for this column, 0 if this type of column doesn't have decimal places.
java.lang.String	getDescription() Returns a copy of the column entry's description.
java.lang.String	getName() Returns the column entry's name.
SeObjectId	getObjectId() Gets the unique, system-assigned ID for column's associated object: for a column of SE_SHAPE_TYPE, it is the layer_id, for a column of SE_RASTER_TYPE it is the rastercolumn_id.
int	getRowIdType() Returns the row id type of this column.
int	getSize() Returns the size of the column as specified to SDE at column creation time, or, if the column was created outside of SDE and not altered within SDE, SDE's best guess at the "proper" size of the column.
java.lang.String	getTableName() Get column's table name.
int	getType() Get Column's sde type.
void	setAllowsNulls(boolean allowsNulls) Indicates whether or not this column accepts null values.
void	setDecimalDigits(int decimalDigits) Set the number of decimal digits allowed for a column.
void	setDescription(java.lang.String description) Sets the column entry's description string.
void	setSize(int size) Sets the width allowed for a column.
void	setType(int type) Sets the SDE column type for the column.
java.lang.String	toString() Returns the ColumnDefinition as a String.

Methods inherited from class java.lang.Object

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

Constructor Detail

SeRegisteredColumn

public SeRegisteredColumn(SeConnection conn)

Defines a blank registered column object.

Parameters:

conn - SDE connection object.

Method Detail

duplicate

public SeRegisteredColumn duplicate()
                             throws SeException

Deep copy a column object.

Returns:

SeRegisteredColumn The duplicate registered column object.

Throws:

SeException

free

public void free()

Free a column object.

allowsNulls

public boolean allowsNulls()
                    throws SeException

Returns true if this column allows null values.

Returns:

boolean True if this column allows null values.

Throws:

SeException

getDecimalDigits

public int getDecimalDigits()
                     throws SeException

Returns the SDE_declared number of decimal places for this column, 0 if this type of column doesn't have decimal places.

Returns:

int The number of decimal places.

Throws:

SeException

getDescription

public java.lang.String getDescription()
                                throws SeException

Returns a copy of the column entry's description.

Returns:

String The column entry's description.

Throws:

SeException

getName

public java.lang.String getName()
                         throws SeException

Returns the column entry's name.

Returns:

String The column entry's name.

Throws:

SeException

getObjectId

public SeObjectId getObjectId()
                       throws SeException

Gets the unique, system-assigned ID for column's associated object: for a column of SE_SHAPE_TYPE, it is the layer_id, for a column of SE_RASTER_TYPE it is the rastercolumn_id.

Returns:

SeObjectId This column's object id.

Throws:

SeException

getRowIdType

public int getRowIdType()
                 throws SeException

Returns the row id type of this column.

Returns:

int The row id type of this column.

Throws:

SeException

getSize

public int getSize()
            throws SeException

Returns the size of the column as specified to SDE at column creation time, or, if the column was created outside of SDE and not altered within SDE, SDE's best guess at the "proper" size of the column.

Returns:

int The size of the column.

Throws:

SeException

getTableName

public java.lang.String getTableName()
                              throws SeException

Get column's table name.

Throws:

SeException

getType

public int getType()
            throws SeException

Get Column's sde type.

Returns:

int The column's sde type.

Throws:

SeException

setAllowsNulls

public void setAllowsNulls(boolean allowsNulls)
                    throws SeException

Indicates whether or not this column accepts null values.

Parameters:

allowsNulls - The boolean value to set to.

Throws:

SeException

setDecimalDigits

public void setDecimalDigits(int decimalDigits)
                      throws SeException

Set the number of decimal digits allowed for a column. This value is ignored for column types that do not have digits.

Parameters:

decimalDigits - The number of decimal digits to this column to.

Throws:

SeException

setDescription

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

Sets the column entry's description string.

Parameters:

description - The description of this column.

Throws:

SeException

setSize

public void setSize(int size)
             throws SeException

Sets the width allowed for a column. The exact meaning of this value depends on the column type, and may be ignored for some.

Parameters:

size - The width for this column.

Throws:

SeException

setType

public void setType(int type)
             throws SeException

Sets the SDE column type for the column.

Parameters:

type - The column's sde type.

Throws:

SeException

toString

public java.lang.String toString()

Returns the ColumnDefinition as a String.

Overrides:

toString in class java.lang.Object

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Returns a new instance of this SeRegisteredColumn.

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException