|
EclipseLink 2.3.2, build 'v20111125-r10461' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.persistence.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:
Field Summary | |
---|---|
protected java.lang.String |
additional
|
protected java.lang.String |
constraint
|
protected java.lang.String |
foreignKeyFieldName
|
protected boolean |
isIdentity
|
protected boolean |
isPrimaryKey
|
protected boolean |
isUnique
|
protected java.lang.String |
name
|
protected boolean |
shouldAllowNull
|
protected int |
size
|
protected int |
subSize
|
protected java.lang.Class |
type
Java type class for the field. |
protected java.lang.String |
typeDefinition
Database-specific complete type definition like "VARCHAR2(50) UNIQUE NOT NULL". |
protected java.lang.String |
typeName
Generic database type name for the field, which can be used instead of the Java class 'type'. |
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 | |
---|---|
void |
appendDBString(java.io.Writer writer,
org.eclipse.persistence.internal.sessions.AbstractSession session,
TableDefinition table)
INTERNAL: Append the database field definition string to the table creation statement. |
void |
appendTypeString(java.io.Writer writer,
org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL: Append the database field definition string to the type creation statement. |
java.lang.Object |
clone()
PUBLIC: |
java.lang.String |
getAdditional()
PUBLIC: Return any additional information about this field to be given when the table is created. |
java.lang.String |
getConstraint()
PUBLIC: Return any constraint of this field. |
java.lang.String |
getForeignKeyFieldName()
|
java.lang.String |
getName()
PUBLIC: Return the name of the field. |
int |
getSize()
PUBLIC: Return the size of the field, this is only required for some field types. |
int |
getSubSize()
PUBLIC: Return the sub-size of the field. |
java.lang.Class |
getType()
PUBLIC: Return the type of the field. |
java.lang.String |
getTypeDefinition()
PUBLIC: Return the type definition of the field. |
java.lang.String |
getTypeName()
PUBLIC: Return the type name of the field. |
boolean |
isIdentity()
PUBLIC: Answer whether the receiver is an identity field. |
boolean |
isPrimaryKey()
PUBLIC: Answer whether the receiver is a primary key. |
boolean |
isUnique()
PUBLIC: Answer whether the receiver is a unique constraint field. |
void |
setAdditional(java.lang.String string)
PUBLIC: Set any additional information about this field to be given when the table is created. |
void |
setConstraint(java.lang.String string)
PUBLIC: Set any constraint of this field. |
void |
setForeignKeyFieldName(java.lang.String foreignKeyFieldName)
|
void |
setIsIdentity(boolean value)
PUBLIC: Set whether the receiver is an identity field. |
void |
setIsPrimaryKey(boolean value)
PUBLIC: Set whether the receiver is a primary key. |
void |
setName(java.lang.String name)
PUBLIC: Set the name of the field. |
void |
setShouldAllowNull(boolean value)
PUBLIC: Set whether the receiver should allow null values. |
void |
setSize(int size)
PUBLIC: Set the size of the field, this is only required for some field types. |
void |
setSubSize(int subSize)
PUBLIC: Set the sub-size of the field. |
void |
setType(java.lang.Class type)
PUBLIC: Set the type of the field. |
void |
setTypeDefinition(java.lang.String typeDefinition)
PUBLIC: Set the type definition of the field. |
void |
setTypeName(java.lang.String typeName)
PUBLIC: Set the type name of the field. |
void |
setUnique(boolean value)
PUBLIC: Set whether the receiver is a unique constraint field. |
boolean |
shouldAllowNull()
PUBLIC: Return whether the receiver should allow null values. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected java.lang.String name
protected java.lang.Class type
protected java.lang.String typeName
protected java.lang.String typeDefinition
protected int size
protected int subSize
protected boolean shouldAllowNull
protected boolean isIdentity
protected boolean isPrimaryKey
protected boolean isUnique
protected java.lang.String additional
protected java.lang.String constraint
protected java.lang.String foreignKeyFieldName
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 void appendDBString(java.io.Writer writer, org.eclipse.persistence.internal.sessions.AbstractSession session, TableDefinition table) throws ValidationException
ValidationException
public void appendTypeString(java.io.Writer writer, org.eclipse.persistence.internal.sessions.AbstractSession session) throws ValidationException
ValidationException
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
|
EclipseLink 2.3.2, build 'v20111125-r10461' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |