oracle.javatools.db

Class Column

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractBuildableObject

oracle.javatools.db.AbstractChildBuildableObject

oracle.javatools.db.Column

All Implemented Interfaces:

ChildDBObject, DBObject, Copyable, DynamicPropertySet

Direct Known Subclasses:

ViewColumn

public class Column
extends AbstractChildBuildableObject

Model of a database column.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject

AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTO_GENERATED_SEQUENCE Deprecated.
static java.lang.String	AUTO_GENERATED_SEQUENCE_TRIGGER Deprecated.
static java.lang.String	TYPE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

Constructors

Constructor and Description
Column() Constructs a new Column.
Column(java.lang.String name) Constructs a new Column with the specified name.
Column(java.lang.String name, DataTypeUsage usage) Constructs a new Column with the specified name and datatype.

Method Summary

Methods

Modifier and Type	Method and Description
DataTypeUsage	getDataTypeUsage() Gets the usage object for the datatype information for this column.
java.lang.Object	getDefault() Retrieves the default value for the Column.
IdentityColumnProperties	getIdentityProperties() Gets the IdentityColumnProperties object that controls the auto generation of values for this column.
java.lang.Long	getPrecision() Deprecated. - use getDataTypeUsage() and then get the appropriate attribute from the DataTypeUsage. e.g. dataTypeUsage.getAttributeValue( DataTypeAttribute.DATATYPE_PRECISION)
Relation	getRelation() Gets the Relation that owns this Column.
java.lang.Long	getScale() Deprecated. - use getDataTypeUsage() and then get the appropriate attribute from the DataTypeUsage. e.g. dataTypeUsage.getAttributeValue( DataTypeAttribute.DATATYPE_SCALE)
java.lang.String	getType() Returns the type of this object.
SQLFragment	getVirtualExpression() Retrieves the Virtual Expression for the Column.
java.lang.String	getVirtualExpressionSource() Retrieves the Virtual Expression source for the Column.
boolean	isNotNull() Whether the Column is restricted to non-null values.
void	setDataTypeUsage(DataTypeUsage dataTypeUsage) Sets the usage object for the datatype information for this column.
void	setDefault(java.lang.Object defaultValue) Sets the default value for the Column.
void	setIdentityProperties(IdentityColumnProperties props) Sets the IdentityColumnProperties object that controls the auto generation of values for this column.
void	setNotNull(boolean notNull) Sets whether the Column is restricted to non-null values.
void	setPrecision(java.lang.Long precision) Deprecated. - use getDataTypeUsage() and then set the appropriate attribute from the DataTypeUsage. e.g. dataTypeUsage.setAttributeValue( DataTypeAttribute.DATATYPE_PRECISION)
void	setRelation(Relation relation) Sets the Relation that owns this Column.
void	setScale(java.lang.Long scale) Deprecated. - use getDataTypeUsage() and then set the appropriate attribute from the DataTypeUsage. e.g. dataTypeUsage.setAttributeValue( DataTypeAttribute.DATATYPE_SCALE)
void	setVirtualExpression(SQLFragment expression) Sets the Virtual Expression for the Column.
void	setVirtualExpressionSource(java.lang.String expression) Sets the Virtual Expression source for the Column.

Methods inherited from class oracle.javatools.db.AbstractChildBuildableObject

setParent

Methods inherited from class oracle.javatools.db.AbstractBuildableObject

checkInit, checkInit, copyToImpl, getOwnedObjectsImpl, getProperties, getReferenceIDsImpl, needsInitialization

Methods inherited from class oracle.javatools.db.AbstractDBObject

addObjectListener, addObjectListener, addObjectListener, changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, findOwnedObject, findParent, fireObjectUpdated, firePropertyChanged, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getParent, getProperty, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeObjectListener, removeObjectListener, removeObjectListener, removeOwnedObject, removeThisAsParent, replaceReferenceIDs, setID, setName, setProperties, setProperty, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.javatools.db.ChildDBObject

getParent

Methods inherited from interface oracle.javatools.db.DBObject

addObjectListener, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getProperties, getReferenceIDs, hashCode, removeObjectListener, removeOwnedObject, replaceReferenceIDs, setID, setName

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperty, getProperty, setProperties, setProperty

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

AUTO_GENERATED_SEQUENCE

@Deprecated
public static final java.lang.String AUTO_GENERATED_SEQUENCE

Deprecated.

See Also:

Constant Field Values

AUTO_GENERATED_SEQUENCE_TRIGGER

@Deprecated
public static final java.lang.String AUTO_GENERATED_SEQUENCE_TRIGGER

Deprecated.

See Also:

Constant Field Values

Constructor Detail

Column

public Column()

Constructs a new Column.

Column

public Column(java.lang.String name)

Constructs a new Column with the specified name.

Parameters:

name - a string containing the column name

Column

public Column(java.lang.String name,
      DataTypeUsage usage)

Constructs a new Column with the specified name and datatype.

Parameters:

name - a string containing the column name

usage - the column's datatype information

Method Detail

setDefault

public void setDefault(java.lang.Object defaultValue)

Sets the default value for the Column. The default value of a column is used whenever an insert or update does not specify a value for the column.

Parameters:

defaultValue - an object representing the default value for the Column. null means the column has no default. To specify that the Column should default to NULL, use the String value "NULL".

getDefault

public java.lang.Object getDefault()

Retrieves the default value for the Column. The default value of a column is used whenever an insert or update does not specify a value for the column.

Returns:

the default value for the Column, or null if no default is specified

setVirtualExpression

public void setVirtualExpression(SQLFragment expression)

Sets the Virtual Expression for the Column. This is the declarative representation of the "virtual expression source" property, i.e. the "virtual expression source" property should already be set.

Parameters:

expression - a SQLFragment representation of the "virtual expression source" property of this Column.

See Also:

setVirtualExpressionSource(String)

getVirtualExpression

public SQLFragment getVirtualExpression()

Retrieves the Virtual Expression for the Column.

Returns:

the Virtual Expression for the Column, or null if the column is not a virtual column.

setVirtualExpressionSource

public void setVirtualExpressionSource(java.lang.String expression)

Sets the Virtual Expression source for the Column.

Parameters:

expression - a SQLFragment representing the Virtual Expression for the Column. null means the column is not virtual.

getVirtualExpressionSource

public java.lang.String getVirtualExpressionSource()

Retrieves the Virtual Expression source for the Column.

Returns:

the Virtual Expression for the Column, or null if the column is not a virtual column.

isNotNull

public boolean isNotNull()

Whether the Column is restricted to non-null values.

Returns:

a boolean value indicating whether null values are disallowed

setNotNull

public void setNotNull(boolean notNull)

Sets whether the Column is restricted to non-null values.

Parameters:

notNull - boolean value indicating whether null values are disallowed

setDataTypeUsage

public void setDataTypeUsage(DataTypeUsage dataTypeUsage)

Sets the usage object for the datatype information for this column. This includes the datatype used, as well as any parameters for the usage of that type (e.g. precision, scale, etc).

getDataTypeUsage

public DataTypeUsage getDataTypeUsage()

Gets the usage object for the datatype information for this column. This includes the datatype used, as well as any parameters for the usage of that type (e.g. precision, scale, etc).

setIdentityProperties

public void setIdentityProperties(IdentityColumnProperties props)

Sets the IdentityColumnProperties object that controls the auto generation of values for this column.

getIdentityProperties

public IdentityColumnProperties getIdentityProperties()

Gets the IdentityColumnProperties object that controls the auto generation of values for this column.

getType

public java.lang.String getType()

Description copied from interface: DBObject

Returns the type of this object. Valid types include things like tables, views, synonyms, and columns.

Returns:

a string describing the type of object.

getRelation

public Relation getRelation()

Gets the Relation that owns this Column.

Returns:

the Relation that owns this column

setRelation

public void setRelation(Relation relation)

Sets the Relation that owns this Column.

Parameters:

relation - the Relation that owns this column.

getPrecision

@Deprecated
public java.lang.Long getPrecision()

Deprecated. - use getDataTypeUsage() and then get the appropriate attribute from the DataTypeUsage.
e.g. dataTypeUsage.getAttributeValue( DataTypeAttribute.DATATYPE_PRECISION)

setPrecision

@Deprecated
public void setPrecision(java.lang.Long precision)

Deprecated. - use getDataTypeUsage() and then set the appropriate attribute from the DataTypeUsage.
e.g. dataTypeUsage.setAttributeValue( DataTypeAttribute.DATATYPE_PRECISION)

getScale

@Deprecated
public java.lang.Long getScale()

Deprecated. - use getDataTypeUsage() and then get the appropriate attribute from the DataTypeUsage.
e.g. dataTypeUsage.getAttributeValue( DataTypeAttribute.DATATYPE_SCALE)

setScale

@Deprecated
public void setScale(java.lang.Long scale)

Deprecated. - use getDataTypeUsage() and then set the appropriate attribute from the DataTypeUsage.
e.g. dataTypeUsage.setAttributeValue( DataTypeAttribute.DATATYPE_SCALE)