Home » db-derby-10.5.3.0 » org.apache.derby.iapi.sql.dictionary » [javadoc | source]
org.apache.derby.iapi.sql.dictionary
public final class: ColumnDescriptor [javadoc | source]
java.lang.Object
   org.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:
  1. long getAutoincStart()
  2. java.lang.String getColumnName()
  3. DefaultDescriptor getDefaultDescriptor(DataDictionary dd)
  4. DefaultInfo getDefaultInfo
  5. UUID getDefaultUUID
  6. DataValueDescriptor getDefaultValue
  7. int getPosition()
  8. UUID getReferencingUUID()
  9. TableDescriptor getTableDescriptor
  10. DTD getType()
  11. hasNonNullDefault
  12. isAutoincrement
  13. setColumnName
  14. setPosition
Field Summary
 long autoinc_create_or_modify_Start_Increment     
Constructor:
 public ColumnDescriptor(String columnName,
    int columnPosition,
    DataTypeDescriptor columnType,
    DataValueDescriptor columnDefault,
    DefaultInfo columnDefaultInfo,
    TableDescriptor table,
    UUID defaultUUID,
    long autoincStart,
    long autoincInc) 
    Constructor for a ColumnDescriptor
    Parameters:
    columnName - The name of the column
    columnPosition - The ordinal position of the column
    columnType - A DataTypeDescriptor for the type of the column
    columnDefault - 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 in
    defaultUUID - The UUID for the default, if any.
    autoincStart - Start value for an autoincrement column.
    autoincInc - Increment for autoincrement column
 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. 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
    columnPosition - The ordinal position of the column
    columnType - A DataTypeDescriptor for the type of the column
    columnDefault - 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 in
    defaultUUID - The UUID for the default, if any.
    autoincStart - Start value for an autoincrement column.
    autoincInc - Increment for autoincrement column
    userChangedWhat - Adding an autoincrement column OR changing increment value or start value of the autoincrement column.
 public ColumnDescriptor(String columnName,
    int columnPosition,
    DataTypeDescriptor columnType,
    DataValueDescriptor columnDefault,
    DefaultInfo columnDefaultInfo,
    UUID uuid,
    UUID defaultUUID,
    long autoincStart,
    long autoincInc,
    long autoincValue) 
    Constructor for a ColumnDescriptor. Used when columnDescriptor doesn't know/care about a table descriptor.
    Parameters:
    columnName - The name of the column
    columnPosition - The ordinal position of the column
    columnType - A DataTypeDescriptor for the type of the column
    columnDefault - 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 column
    autoincValue - Current value of the autoincrement column
Method from org.apache.derby.iapi.sql.dictionary.ColumnDescriptor Summary:
getAutoincInc,   getAutoincStart,   getAutoincValue,   getAutoinc_create_or_modify_Start_Increment,   getColumnName,   getDefaultDescriptor,   getDefaultInfo,   getDefaultUUID,   getDefaultValue,   getDescriptorName,   getDescriptorType,   getPosition,   getReferencingUUID,   getTableDescriptor,   getType,   hasGenerationClause,   hasNonNullDefault,   isAutoincAlways,   isAutoincrement,   setAutoinc_create_or_modify_Start_Increment,   setColumnName,   setPosition,   setTableDescriptor,   toString,   updatableByCursor
Methods from org.apache.derby.iapi.sql.dictionary.TupleDescriptor:
getColumnDependableFinder,   getDataDictionary,   getDependableFinder,   getDescriptorName,   getDescriptorType,   isPersistent,   setDataDictionary
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.derby.iapi.sql.dictionary.ColumnDescriptor Detail:
 public long getAutoincInc() 
    Get the Increment value given by the user for an autoincrement column
 public long getAutoincStart() 
    Get the start value of an autoincrement column
 public long getAutoincValue() 
    Get the current value for an autoincrement column. One case in which this is used involves dropping a column from a table. When ALTER TABLE DROP COLUMN runs, it drops the column from SYSCOLUMNS, and then must adjust the column positions of the other subsequent columns in the table to account for the removal of the dropped columns. This involves deleting and re-adding the column descriptors to SYSCOLUMNS, but during that process we must be careful to preserve the current value of any autoincrement column.
 public long getAutoinc_create_or_modify_Start_Increment() 
 public String getColumnName() 
    Get the name of the column.
 public DefaultDescriptor getDefaultDescriptor(DataDictionary dd) 
    Get a DefaultDescriptor for the default, if any, associated with this column.
 public DefaultInfo getDefaultInfo() 
    Get the DefaultInfo for this ColumnDescriptor.
 public UUID getDefaultUUID() 
    Get the UUID for the column default, if any.
 public DataValueDescriptor getDefaultValue() 
    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.
 public String getDescriptorName() 
 public String getDescriptorType() 
 public int getPosition() 
    Get the ordinal position of the column (1 based)
 public UUID getReferencingUUID() 
    Get the UUID of the object the column is a part of.
 public TableDescriptor getTableDescriptor() 
    Get the TableDescriptor of the column's table.
 public DataTypeDescriptor getType() 
    Get the TypeDescriptor of the column's datatype.
 public boolean hasGenerationClause() 
    Is this column a generated column
 public boolean hasNonNullDefault() 
    Return whether or not there is a non-null default on this column.
 public boolean isAutoincAlways() 
    Is this column to have autoincremented value always ?
 public boolean isAutoincrement() 
    Is this column an autoincrement column?
 public  void setAutoinc_create_or_modify_Start_Increment(int c_or_m) 
 public  void setColumnName(String newColumnName) 
    Sets the column name in case of rename column.
 public  void setPosition(int columnPosition) 
    Set the ordinal position of the column.
 public  void setTableDescriptor(TableDescriptor tableDescriptor) 
    Sets the table descriptor for the column.
 public String toString() 
    Convert the ColumnDescriptor to a String.
 public boolean updatableByCursor()