| java.lang.Object org.apache.derby.iapi.sql.dictionary.TupleDescriptor org.apache.derby.iapi.sql.dictionary.ColumnDescriptor
ColumnDescriptor | final public class ColumnDescriptor extends TupleDescriptor (Code) | | This class represents a column descriptor.
public methods in this class are:
- long getAutoincStart()
- java.lang.String getColumnName()
- DefaultDescriptor getDefaultDescriptor(DataDictionary dd)
- DefaultInfo getDefaultInfo
- UUID getDefaultUUID
- DataValueDescriptor getDefaultValue
- int getPosition()
- UUID getReferencingUUID()
- TableDescriptor getTableDescriptor
- DTD getType()
- hasNonNullDefault
- isAutoincrement
- setColumnName
- setPosition
author: Jeff Lichtman |
Constructor Summary | |
public | ColumnDescriptor(String columnName, int columnPosition, DataTypeDescriptor columnType, DataValueDescriptor columnDefault, DefaultInfo columnDefaultInfo, TableDescriptor table, UUID defaultUUID, long autoincStart, long autoincInc, long userChangedWhat) Constructor for a ColumnDescriptor when the column involved
is an autoincrement column. | public | ColumnDescriptor(String columnName, int columnPosition, DataTypeDescriptor columnType, DataValueDescriptor columnDefault, DefaultInfo columnDefaultInfo, TableDescriptor table, UUID defaultUUID, long autoincStart, long autoincInc) | public | ColumnDescriptor(String columnName, int columnPosition, DataTypeDescriptor columnType, DataValueDescriptor columnDefault, DefaultInfo columnDefaultInfo, UUID uuid, UUID defaultUUID, long autoincStart, long autoincInc) Constructor for a ColumnDescriptor. |
autoinc_create_or_modify_Start_Increment | long autoinc_create_or_modify_Start_Increment(Code) | | |
ColumnDescriptor | public ColumnDescriptor(String columnName, int columnPosition, DataTypeDescriptor columnType, DataValueDescriptor columnDefault, DefaultInfo columnDefaultInfo, TableDescriptor table, UUID defaultUUID, long autoincStart, long autoincInc, long userChangedWhat)(Code) | | Constructor for a ColumnDescriptor when the column involved
is an autoincrement column. The last parameter to this method
indicates if an autoincrement column is getting added or if
the autoincrement column is being modified to change the
increment value or to change the start value
Parameters: columnName - The name of the column Parameters: columnPosition - The ordinal position of the column Parameters: columnType - A DataTypeDescriptor for the type ofthe column Parameters: columnDefault - A DataValueDescriptor representing thedefault value of the column, if any(null if no default) Parameters: columnDefaultInfo - The default info for the column. Parameters: table - A TableDescriptor for the table thecolumn is in Parameters: defaultUUID - The UUID for the default, if any. Parameters: autoincStart - Start value for an autoincrement column. Parameters: autoincInc - Increment for autoincrement column Parameters: userChangedWhat - Adding an autoincrement column ORchanging increment value or start value ofthe autoincrement column. |
ColumnDescriptor | public ColumnDescriptor(String columnName, int columnPosition, DataTypeDescriptor columnType, DataValueDescriptor columnDefault, DefaultInfo columnDefaultInfo, TableDescriptor table, UUID defaultUUID, long autoincStart, long autoincInc)(Code) | | Constructor for a ColumnDescriptor
Parameters: columnName - The name of the column Parameters: columnPosition - The ordinal position of the column Parameters: columnType - A DataTypeDescriptor for the type ofthe column Parameters: columnDefault - A DataValueDescriptor representing thedefault value of the column, if any(null if no default) Parameters: columnDefaultInfo - The default info for the column. Parameters: table - A TableDescriptor for the table thecolumn is in Parameters: defaultUUID - The UUID for the default, if any. Parameters: autoincStart - Start value for an autoincrement column. Parameters: autoincInc - Increment for autoincrement column |
ColumnDescriptor | public ColumnDescriptor(String columnName, int columnPosition, DataTypeDescriptor columnType, DataValueDescriptor columnDefault, DefaultInfo columnDefaultInfo, UUID uuid, UUID defaultUUID, long autoincStart, long autoincInc)(Code) | | Constructor for a ColumnDescriptor. Used when
columnDescriptor doesn't know/care about a table
descriptor.
Parameters: columnName - The name of the column Parameters: columnPosition - The ordinal position of the column Parameters: columnType - A DataTypeDescriptor for the type ofthe column Parameters: columnDefault - A DataValueDescriptor representing thedefault value of the column, if any(null if no default) Parameters: columnDefaultInfo - The default info for the column. Parameters: uuid - A uuid for the object that this columnis in. Parameters: defaultUUID - The UUID for the default, if any. Parameters: autoincStart - Start value for an autoincrement column. Parameters: autoincInc - Increment for autoincrement column |
getAutoincInc | public long getAutoincInc()(Code) | | Get the Increment value given by the user for an autoincrement column
the Increment value for an autoincrement column |
getAutoincStart | public long getAutoincStart()(Code) | | Get the start value of an autoincrement column
Get the start value of an autoincrement column |
getAutoinc_create_or_modify_Start_Increment | public long getAutoinc_create_or_modify_Start_Increment()(Code) | | |
getColumnName | public String getColumnName()(Code) | | Get the name of the column.
A String containing the name of the column. |
getDefaultDescriptor | public DefaultDescriptor getDefaultDescriptor(DataDictionary dd)(Code) | | Get a DefaultDescriptor for the default, if any, associated with this column.
Parameters: dd - The DataDictionary. A DefaultDescriptor if this column has a column default. |
getDefaultInfo | public DefaultInfo getDefaultInfo()(Code) | | Get the DefaultInfo for this ColumnDescriptor.
The DefaultInfo for this ColumnDescriptor. |
getDefaultUUID | public UUID getDefaultUUID()(Code) | | Get the UUID for the column default, if any.
The UUID for the column default, if any. |
getDefaultValue | public DataValueDescriptor getDefaultValue()(Code) | | Get the default value for the column. For columns with primitive
types, the object returned will be of the corresponding object type.
For example, for a float column, getDefaultValue() will return
a Float.
An object with the value and type of the default valuefor the column. Returns NULL if there is no default. |
getPosition | public int getPosition()(Code) | | Get the ordinal position of the column (1 based)
The ordinal position of the column. |
getReferencingUUID | public UUID getReferencingUUID()(Code) | | Get the UUID of the object the column is a part of.
The UUID of the table the column is a part of. |
getTableDescriptor | public TableDescriptor getTableDescriptor()(Code) | | Get the TableDescriptor of the column's table.
The TableDescriptor of the column's table. |
getType | public DataTypeDescriptor getType()(Code) | | Get the TypeDescriptor of the column's datatype.
The TypeDescriptor of the column's datatype. |
hasNonNullDefault | public boolean hasNonNullDefault()(Code) | | Return whether or not there is a non-null default on this column.
Whether or not there is a non-null default on this column. |
isAutoincAlways | public boolean isAutoincAlways()(Code) | | Is this column to have autoincremented value always ?
|
isAutoincrement | public boolean isAutoincrement()(Code) | | Is this column an autoincrement column?
Whether or not this is an autoincrement column |
setColumnName | public void setColumnName(String newColumnName)(Code) | | Sets the column name in case of rename column.
Parameters: newColumnName - The new column name. |
setPosition | public void setPosition(int columnPosition)(Code) | | Set the ordinal position of the column.
|
setTableDescriptor | public void setTableDescriptor(TableDescriptor tableDescriptor)(Code) | | Sets the table descriptor for the column.
Parameters: tableDescriptor - The table descriptor for this column |
toString | public String toString()(Code) | | Convert the ColumnDescriptor to a String.
A String representation of this ColumnDescriptor |
updatableByCursor | public boolean updatableByCursor()(Code) | | |
|
|