|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1) E13403-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.javatools.db.AbstractDBObject oracle.javatools.db.AbstractChildDBObject oracle.javatools.db.Column
public class Column
Model of a database column.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject |
---|
AbstractDBObject.ChildSupport |
Field Summary | |
---|---|
static java.lang.String |
AUTO_GENERATED_SEQUENCE
|
static java.lang.String |
AUTO_GENERATED_SEQUENCE_TRIGGER
|
static java.lang.String |
TYPE
|
Fields inherited from interface oracle.javatools.db.DBObject |
---|
COMMENT |
Constructor Summary | |
---|---|
Column()
Constructs a new Column. |
|
Column(java.lang.String name)
Constructs a new Column with the specified name. |
|
Column(java.lang.String name,
DataType dataType)
Deprecated. use Column( String name, DataTypeUsage usage ) |
|
Column(java.lang.String name,
DataTypeUsage usage)
Constructs a new Column with the specified name and datatype. |
|
Column(java.lang.String name,
DBObjectID dataTypeID)
Deprecated. use Column( String name, DataTypeUsage usage ) |
Method Summary | |
---|---|
DBObject |
copyTo(DBObject target,
DBObject copyParent,
IDPolicy idPolicy)
Internal copy method used by the API to perform copy operations. |
protected void |
copyToImpl(Column copy,
DBObject copyParent,
IDPolicy idPolicy)
|
boolean |
equals(java.lang.Object target)
|
protected boolean |
equalsImpl(Column copy)
|
DataTypeUsage |
getDataTypeUsage()
Gets the usage object for the datatype information for this column. |
java.lang.Object |
getDefault()
Retrieves the default value for the Column. |
protected void |
getOwnedObjectsImpl(java.util.Collection<DBObject> objs,
java.lang.String... types)
Used by all the final children methods. |
java.lang.Long |
getPrecision()
Deprecated. - use getDataTypeUsage() and then get the appropriate attribute from the DataTypeUsage. e.g. dataTypeUsage.getAttributeValue( DataTypeAttribute.DATATYPE_PRECISION) |
protected void |
getReferenceIDsImpl(java.util.Collection<DBObjectID> refs)
Used by the final getReferenceID() implementation. |
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. |
boolean |
isNotNull()
Whether the Column is restricted to non-null values. |
boolean |
replaceReferenceIDs(java.util.Map<DBObjectID,DBObjectID> idMap)
Override in subclasses to replace reference IDs as appropriate. |
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 |
setNotNull(boolean newNotNull)
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) |
Methods inherited from class oracle.javatools.db.AbstractChildDBObject |
---|
copyToImpl, findParent, getParent, setParent |
Methods inherited from class oracle.javatools.db.AbstractDBObject |
---|
changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyToImpl, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getProperties, getProperty, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeThisAsParent, 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.DBObject |
---|
copyTo, copyTo, copyTo, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getReferenceIDs, setID, setName |
Methods inherited from interface oracle.javatools.util.DynamicPropertySet |
---|
getProperties, getProperty, getProperty, setProperties, setProperty |
Field Detail |
---|
public static final java.lang.String TYPE
public static final java.lang.String AUTO_GENERATED_SEQUENCE
public static final java.lang.String AUTO_GENERATED_SEQUENCE_TRIGGER
Constructor Detail |
---|
public Column()
public Column(java.lang.String name)
name
- a string containing the column namepublic Column(java.lang.String name, DataTypeUsage usage)
name
- a string containing the column namedataType
- the datatype of the column@Deprecated public Column(java.lang.String name, DataType dataType)
name
- a string containing the column namedataType
- the datatype of the column@Deprecated public Column(java.lang.String name, DBObjectID dataTypeID)
name
- a string containing the column namedataTypeID
- the id for the datatype of the columnMethod Detail |
---|
public DBObject copyTo(DBObject target, DBObject copyParent, IDPolicy idPolicy)
AbstractDBObject
This method does not fix internal reference ids on copy. That is done by
the calling DBObject.copyTo(DBObject, IDPolicy)
method.
copyTo
in class AbstractDBObject
DBObject.copyTo(java.lang.Object)
,
DBObject.copyTo(DBObject, boolean)
,
AbstractDBObject.copyToImpl(oracle.javatools.db.AbstractDBObject, oracle.javatools.db.DBObject, oracle.javatools.db.IDPolicy)
protected void copyToImpl(Column copy, DBObject copyParent, IDPolicy idPolicy)
public boolean equals(java.lang.Object target)
equals
in class java.lang.Object
protected boolean equalsImpl(Column copy)
public void setDefault(java.lang.Object defaultValue)
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"
.public java.lang.Object getDefault()
null
if no default is specifiedpublic boolean isNotNull()
public void setNotNull(boolean newNotNull)
newNotNull
- boolean value indicating whether null values are
disallowedpublic void setDataTypeUsage(DataTypeUsage dataTypeUsage)
public DataTypeUsage getDataTypeUsage()
public java.lang.String getType()
DBObject
public Relation getRelation()
Relation
that owns this Column.
public void setRelation(Relation relation)
Relation
that owns this Column.
relation
- the Relation that owns this column.protected void getOwnedObjectsImpl(java.util.Collection<DBObject> objs, java.lang.String... types)
AbstractDBObject
includesType
to check the types vararg.
getOwnedObjectsImpl
in class AbstractDBObject
objs
- a Collection of the apppropriate children.types
- a vararg of the type(s) to search forAbstractDBObject.includesType(java.lang.String, java.lang.String...)
protected void getReferenceIDsImpl(java.util.Collection<DBObjectID> refs)
AbstractDBObject
getReferenceIDsImpl
in class AbstractDBObject
refs
- the collection of ids this object referencespublic boolean replaceReferenceIDs(java.util.Map<DBObjectID,DBObjectID> idMap)
AbstractDBObject
replaceReferenceIDs
in interface DBObject
replaceReferenceIDs
in class AbstractDBObject
idMap
- key = old DBObjectID, value = new DBObjectID
@Deprecated public java.lang.Long getPrecision()
@Deprecated public void setPrecision(java.lang.Long precision)
@Deprecated public java.lang.Long getScale()
@Deprecated public void setScale(java.lang.Long scale)
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1) E13403-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |