|
Oracle Fusion Middleware Java API Reference for Oracle TopLink (Deprecated) 11g Release 1 (11.1.1) B32476-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.toplink.tools.schemaframework.FieldDefinition
public class FieldDefinition
Purpose: Define a database field definition for creation within a table. This differs from DatabaseField in that it is used only table creation not a runtime.
Responsibilities:
Constructor Summary | |
---|---|
FieldDefinition()
|
|
FieldDefinition(java.lang.String name,
java.lang.Class type)
|
|
FieldDefinition(java.lang.String name,
java.lang.Class type,
int size)
|
|
FieldDefinition(java.lang.String name,
java.lang.Class type,
int size,
int subSize)
|
|
FieldDefinition(java.lang.String name,
java.lang.String typeName)
|
Method Summary | |
---|---|
java.lang.Object |
clone()
|
java.lang.String |
getAdditional()
Return any additional information about this field to be given when the table is created. |
java.lang.String |
getConstraint()
Return any constraint of this field. |
java.lang.String |
getForeignKeyFieldName()
|
java.lang.String |
getName()
Return the name of the field. |
int |
getSize()
Return the size of the field, this is only required for some field types. |
int |
getSubSize()
Return the sub-size of the field. |
java.lang.Class |
getType()
Return the type of the field. |
java.lang.String |
getTypeDefinition()
Return the type definition of the field. |
java.lang.String |
getTypeName()
Return the type name of the field. |
boolean |
isIdentity()
Answer whether the receiver is an identity field. |
boolean |
isPrimaryKey()
Answer whether the receiver is a primary key. |
boolean |
isUnique()
Answer whether the receiver is a unique constraint field. |
void |
setAdditional(java.lang.String string)
Set any additional information about this field to be given when the table is created. |
void |
setConstraint(java.lang.String string)
Set any constraint of this field. |
void |
setForeignKeyFieldName(java.lang.String foreignKeyFieldName)
|
void |
setIsIdentity(boolean value)
Set whether the receiver is an identity field. |
void |
setIsPrimaryKey(boolean value)
Set whether the receiver is a primary key. |
void |
setName(java.lang.String name)
Set the name of the field. |
void |
setShouldAllowNull(boolean value)
Set whether the receiver should allow null values. |
void |
setSize(int size)
Set the size of the field, this is only required for some field types. |
void |
setSubSize(int subSize)
Set the sub-size of the field. |
void |
setType(java.lang.Class type)
Set the type of the field. |
void |
setTypeDefinition(java.lang.String typeDefinition)
Set the type definition of the field. |
void |
setTypeName(java.lang.String typeName)
Set the type name of the field. |
void |
setUnique(boolean value)
Set whether the receiver is a unique constraint field. |
boolean |
shouldAllowNull()
Return whether the receiver should allow null values. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public FieldDefinition()
public FieldDefinition(java.lang.String name, java.lang.Class type)
public FieldDefinition(java.lang.String name, java.lang.Class type, int size)
public FieldDefinition(java.lang.String name, java.lang.Class type, int size, int subSize)
public FieldDefinition(java.lang.String name, java.lang.String typeName)
Method Detail |
---|
public java.lang.Object clone()
clone
in class java.lang.Object
public java.lang.String getAdditional()
public java.lang.String getConstraint()
public java.lang.String getForeignKeyFieldName()
public java.lang.String getName()
public int getSize()
public int getSubSize()
public java.lang.Class getType()
public java.lang.String getTypeName()
public java.lang.String getTypeDefinition()
public boolean isIdentity()
public boolean isPrimaryKey()
public boolean isUnique()
public void setAdditional(java.lang.String string)
public void setConstraint(java.lang.String string)
public void setForeignKeyFieldName(java.lang.String foreignKeyFieldName)
public void setIsIdentity(boolean value)
public void setIsPrimaryKey(boolean value)
public void setName(java.lang.String name)
public void setShouldAllowNull(boolean value)
public void setSize(int size)
public void setSubSize(int subSize)
public void setType(java.lang.Class type)
public void setTypeName(java.lang.String typeName)
public void setTypeDefinition(java.lang.String typeDefinition)
public void setUnique(boolean value)
public boolean shouldAllowNull()
public java.lang.String toString()
toString
in class java.lang.Object
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |