|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.derby.iapi.sql.dictionary.TupleDescriptor
org.apache.derby.iapi.sql.dictionary.ColumnDescriptor
This class represents a column descriptor. public methods in this class are:
Field Summary | |
(package private) long |
autoincInc
|
(package private) long |
autoincStart
|
(package private) DataValueDescriptor |
columnDefault
|
(package private) DefaultInfo |
columnDefaultInfo
|
(package private) java.lang.String |
columnName
|
(package private) int |
columnPosition
|
(package private) DataTypeDescriptor |
columnType
|
(package private) UUID |
defaultUUID
|
(package private) TableDescriptor |
table
|
(package private) UUID |
uuid
|
Fields inherited from class org.apache.derby.iapi.sql.dictionary.TupleDescriptor |
COLUMN_LIST, CONGLOMERATE_LIST, CONSTRAINT_LIST, TRIGGER_LIST |
Constructor Summary | |
ColumnDescriptor(java.lang.String columnName,
int columnPosition,
DataTypeDescriptor columnType,
DataValueDescriptor columnDefault,
DefaultInfo columnDefaultInfo,
TableDescriptor table,
UUID defaultUUID,
long autoincStart,
long autoincInc,
boolean autoinc)
Constructor for a ColumnDescriptor |
|
ColumnDescriptor(java.lang.String columnName,
int columnPosition,
DataTypeDescriptor columnType,
DataValueDescriptor columnDefault,
DefaultInfo columnDefaultInfo,
UUID uuid,
UUID defaultUUID,
long autoincStart,
long autoincInc,
boolean autoinc)
Constructor for a ColumnDescriptor. |
Method Summary | |
long |
getAutoincInc()
Get the Increment value given by the user for an autoincrement column |
long |
getAutoincStart()
Get the start value of an autoincrement column |
java.lang.String |
getColumnName()
Get the name of the column. |
DefaultDescriptor |
getDefaultDescriptor(DataDictionary dd)
Get a DefaultDescriptor for the default, if any, associated with this column. |
DefaultInfo |
getDefaultInfo()
Get the DefaultInfo for this ColumnDescriptor. |
UUID |
getDefaultUUID()
Get the UUID for the column default, if any. |
DataValueDescriptor |
getDefaultValue()
Get the default value for the column. |
java.lang.String |
getDescriptorName()
|
java.lang.String |
getDescriptorType()
Each descriptor must identify itself with its type; i.e index, check constraint whatever. |
int |
getPosition()
Get the ordinal position of the column (1 based) |
UUID |
getReferencingUUID()
Get the UUID of the object the column is a part of. |
TableDescriptor |
getTableDescriptor()
Get the TableDescriptor of the column's table. |
DataTypeDescriptor |
getType()
Get the TypeDescriptor of the column's datatype. |
boolean |
hasNonNullDefault()
Return whether or not there is a non-null default on this column. |
boolean |
isAutoincrement()
Is this column an autoincrement column? |
void |
setColumnName(java.lang.String newColumnName)
Sets the the column name in case of rename column. |
void |
setPosition(int columnPosition)
Set the ordinal position of the column. |
java.lang.String |
toString()
Convert the ColumnDescriptor to a String. |
Methods inherited from class org.apache.derby.iapi.sql.dictionary.TupleDescriptor |
getColumnDependableFinder, getDataDictionary, getDependableFinder, isPersistent, setDataDictionary |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
DefaultInfo columnDefaultInfo
TableDescriptor table
java.lang.String columnName
int columnPosition
DataTypeDescriptor columnType
DataValueDescriptor columnDefault
UUID uuid
UUID defaultUUID
long autoincStart
long autoincInc
Constructor Detail |
public ColumnDescriptor(java.lang.String columnName, int columnPosition, DataTypeDescriptor columnType, DataValueDescriptor columnDefault, DefaultInfo columnDefaultInfo, TableDescriptor table, UUID defaultUUID, long autoincStart, long autoincInc, boolean autoinc)
columnName
- The name of the columncolumnPosition
- The ordinal position of the columncolumnType
- A DataTypeDescriptor for the type of
the columncolumnDefault
- A DataValueDescriptor representing the
default value of the column, if any
(null if no default)columnDefaultInfo
- The default info for the column.table
- A TableDescriptor for the table the
column is indefaultUUID
- The UUID for the default, if any.autoincStart
- Start value for an autoincrement column.autoincInc
- Increment for autoincrement columnautoinc
- boolean value for sanity checking.public ColumnDescriptor(java.lang.String columnName, int columnPosition, DataTypeDescriptor columnType, DataValueDescriptor columnDefault, DefaultInfo columnDefaultInfo, UUID uuid, UUID defaultUUID, long autoincStart, long autoincInc, boolean autoinc)
columnName
- The name of the columncolumnPosition
- The ordinal position of the columncolumnType
- A DataTypeDescriptor for the type of
the columncolumnDefault
- A DataValueDescriptor representing the
default value of the column, if any
(null if no default)columnDefaultInfo
- The default info for the column.uuid
- A uuid for the object that this column
is in.defaultUUID
- The UUID for the default, if any.autoincStart
- Start value for an autoincrement column.autoincInc
- Increment for autoincrement columnautoinc
- Boolean value, for sanity checking.Method Detail |
public UUID getReferencingUUID()
public TableDescriptor getTableDescriptor()
public java.lang.String getColumnName()
public void setColumnName(java.lang.String newColumnName)
newColumnName
- The new column name.public int getPosition()
public DataTypeDescriptor getType()
public boolean hasNonNullDefault()
public DataValueDescriptor getDefaultValue()
public DefaultInfo getDefaultInfo()
public UUID getDefaultUUID()
public DefaultDescriptor getDefaultDescriptor(DataDictionary dd)
dd
- The DataDictionary.
public boolean isAutoincrement()
public long getAutoincStart()
public long getAutoincInc()
public void setPosition(int columnPosition)
public java.lang.String toString()
public java.lang.String getDescriptorName()
getDescriptorName
in class TupleDescriptor
TupleDescriptor.getDescriptorName()
public java.lang.String getDescriptorType()
TupleDescriptor
getDescriptorType
in class TupleDescriptor
TupleDescriptor.getDescriptorType()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |