com.esri.sde.sdk.client
Class SeColumnDefinition

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

All Implemented Interfaces:

java.lang.Cloneable

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

This class represents the ArcSDE column definition. The columns of any ArcSDE table or layer are defined by instances of this class. This class also defines the available ArcSDE column data types.

Field Summary

static int	TYPE_BLOB ArcSDE data type for variable length binary data.
static int	TYPE_CLOB ArcSDE data type for Character Variable Length Data.
static int	TYPE_DATE ArcSDE data type for dates.
static int	TYPE_DOUBLE Deprecated. at ArcSDE v9.0, replaced by TYPE_FLOAT64
static int	TYPE_FLOAT Deprecated. at ArcSDE v9.0, replaced by TYPE_FLOAT32
static int	TYPE_FLOAT32 ArcSDE data type for 4 byte floating point data.
static int	TYPE_FLOAT64 ArcSDE data type for 8 byte floating point data.
static int	TYPE_INT16 ArcSDE data type for 2 byte integer data.
static int	TYPE_INT32 ArcSDE data type for 4 byte integer data.
static int	TYPE_INT64 ArcSDE data type for 8 byte integer data.
static int	TYPE_INTEGER Deprecated. at ArcSDE v9.0, replaced by TYPE_INT32
static int	TYPE_NCLOB ArcSDE data type for UNICODE Character Large Object.
static int	TYPE_NSTRING ArcSDE data type for UNICODE Null termindated character array.
static int	TYPE_RASTER ArcSDE data type for raster data.
static int	TYPE_SHAPE ArcSDE data type for geometric features.
static int	TYPE_SMALLINT Deprecated. at ArcSDE v9.0, replaced by TYPE_INT16
static int	TYPE_STRING ArcSDE data type for character data.
static int	TYPE_UUID ArcSDE data type for Universal Unique ID.
static int	TYPE_XML ArcSDE data type for XML data.

Constructor Summary

SeColumnDefinition()
Defines a blank column definition.

SeColumnDefinition(java.lang.String name, int type, int size, int scale, boolean isNullable)
Defines a column of a table.

Method Summary

boolean	allowsNulls() This method returns true if the column allows null values and false if it does not.
java.lang.Object	clone() Returns a new instance of this SeColumnDefinition.
java.lang.String	getName() Returns the name of the column as a String.
short	getRowIdType() Returns the registration row id column type.
short	getScale() Returns the scale of the column.
int	getSize() Returns the size of the column.
int	getType() Returns the SDE column type.
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

Field Detail

TYPE_SMALLINT

public static final int TYPE_SMALLINT

Deprecated. at ArcSDE v9.0, replaced by TYPE_INT16

ArcSDE data type for 2 byte integer data.

See Also:

Constant Field Values

TYPE_INTEGER

public static final int TYPE_INTEGER

Deprecated. at ArcSDE v9.0, replaced by TYPE_INT32

ArcSDE data type for 4 byte integer data.

See Also:

Constant Field Values

TYPE_FLOAT

public static final int TYPE_FLOAT

Deprecated. at ArcSDE v9.0, replaced by TYPE_FLOAT32

ArcSDE data type for 4 byte floating point data.

See Also:

Constant Field Values

TYPE_DOUBLE

public static final int TYPE_DOUBLE

Deprecated. at ArcSDE v9.0, replaced by TYPE_FLOAT64

ArcSDE data type for 8 byte floating point data.

See Also:

Constant Field Values

TYPE_INT16

public static final int TYPE_INT16

ArcSDE data type for 2 byte integer data.

See Also:

Constant Field Values

TYPE_INT32

public static final int TYPE_INT32

ArcSDE data type for 4 byte integer data.

See Also:

Constant Field Values

TYPE_FLOAT32

public static final int TYPE_FLOAT32

ArcSDE data type for 4 byte floating point data.

See Also:

Constant Field Values

TYPE_FLOAT64

public static final int TYPE_FLOAT64

ArcSDE data type for 8 byte floating point data.

See Also:

Constant Field Values

TYPE_STRING

public static final int TYPE_STRING

ArcSDE data type for character data.

See Also:

Constant Field Values

TYPE_BLOB

public static final int TYPE_BLOB

ArcSDE data type for variable length binary data.

See Also:

Constant Field Values

TYPE_DATE

public static final int TYPE_DATE

ArcSDE data type for dates.

See Also:

Constant Field Values

TYPE_SHAPE

public static final int TYPE_SHAPE

ArcSDE data type for geometric features.

See Also:

Constant Field Values

TYPE_RASTER

public static final int TYPE_RASTER

ArcSDE data type for raster data.

See Also:

Constant Field Values

TYPE_XML

public static final int TYPE_XML

ArcSDE data type for XML data.

See Also:

Constant Field Values

TYPE_INT64

public static final int TYPE_INT64

ArcSDE data type for 8 byte integer data.

See Also:

Constant Field Values

TYPE_UUID

public static final int TYPE_UUID

ArcSDE data type for Universal Unique ID.

See Also:

Constant Field Values

TYPE_CLOB

public static final int TYPE_CLOB

ArcSDE data type for Character Variable Length Data.

See Also:

Constant Field Values

TYPE_NSTRING

public static final int TYPE_NSTRING

ArcSDE data type for UNICODE Null termindated character array.

See Also:

Constant Field Values

TYPE_NCLOB

public static final int TYPE_NCLOB

ArcSDE data type for UNICODE Character Large Object.

See Also:

Constant Field Values

Constructor Detail

SeColumnDefinition

public SeColumnDefinition()

Defines a blank column definition.

SeColumnDefinition

public SeColumnDefinition(java.lang.String name,
                          int type,
                          int size,
                          int scale,
                          boolean isNullable)
                   throws SeException

Defines a column of a table.

Parameters:

name - The column name.

type - The SDE data type.

size - The size of the column values.

scale - Number of digits after decimal.

isNullable - Allow Null values.

Throws:

SeException

Method Detail

allowsNulls

public boolean allowsNulls()

This method returns true if the column allows null values and false if it does not.

getType

public int getType()

Returns the SDE column type.

The possible types are:

 TYPE_INT16
 TYPE_INT32
 TYPE_INT64
 TYPE_FLOAT32
 TYPE_FLOAT64
 TYPE_STRING
 TYPE_BLOB
 TYPE_DATE
 TYPE_SHAPE
 TYPE_RASTER
 TYPE_XML

 

getRowIdType

public short getRowIdType()

Returns the registration row id column type.

The possible types are:

 SeRegistration.SE_REGISTRATION_ROW_ID_COLUMN_TYPE_SDE
 SeRegistration.SE_REGISTRATION_ROW_ID_COLUMN_TYPE_USER
 SeRegistration.SE_REGISTRATION_ROW_ID_COLUMN_TYPE_NONE
 

getName

public java.lang.String getName()

Returns the name of the column as a String.

getSize

public int getSize()

Returns the size of the column.

getScale

public short getScale()

Returns the scale of the column.

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

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException