Package org.castor.ddlgen.schemaobject
Class Field
java.lang.Object
org.castor.ddlgen.schemaobject.AbstractSchemaObject
org.castor.ddlgen.schemaobject.Field
- All Implemented Interfaces:
SchemaObject
- Direct Known Subclasses:
Db2Field
,DefaultField
,DerbyField
,HsqlField
,MssqlField
,MysqlField
,PointBaseField
,PostgresqlField
,SybaseField
Abstract base class of all field implementations.
- Since:
- 1.1
- Version:
- $Revision: 5951 $ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $
- Author:
- Le Duc Bao, Ralf Joachim
-
Field Summary
Fields inherited from class org.castor.ddlgen.schemaobject.AbstractSchemaObject
HASHFACTOR
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
final Integer
Get decimals parameter from mapping of sql field.final KeyGenerator
Get key generator for this field.final Integer
Get length parameter from mapping of sql field.final Integer
Get precision parameter from mapping of sql field.final Table
getTable()
Get table which contains this field.final TypeInfo
getType()
Get type information of this field.final int
hashCode()
final boolean
Get if this field is part of the identity?final boolean
Get if this field is a required one?final void
Check if given field can be merged with this one.final void
setIdentity
(boolean isIdentity) Set if this field is part of the identity?final void
setKeyGenerator
(KeyGenerator keyGenerator) Set key generator for this field.final void
setRequired
(boolean isRequired) Set if this field is a required one?final void
Set table which contains this field.final void
Set type information of this field.final void
Build drop script for the schema object.Methods inherited from class org.castor.ddlgen.schemaobject.AbstractSchemaObject
equals, getConfiguration, getName, setConfiguration, setName
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.castor.ddlgen.schemaobject.SchemaObject
toCreateDDL
-
Constructor Details
-
Field
public Field()
-
-
Method Details
-
setKeyGenerator
Set key generator for this field.null
if the field has no key generator.- Parameters:
keyGenerator
- Key generator for this field.
-
getKeyGenerator
Get key generator for this field.- Returns:
- Key generator for this field.
-
setIdentity
public final void setIdentity(boolean isIdentity) Set if this field is part of the identity?- Parameters:
isIdentity
-true
if the field is part of the identity,true
otherwise.
-
isIdentity
public final boolean isIdentity()Get if this field is part of the identity?- Returns:
true
if the field is part of the identity,true
otherwise.
-
setRequired
public final void setRequired(boolean isRequired) Set if this field is a required one?- Parameters:
isRequired
-true
if the field is required,true
otherwise.
-
isRequired
public final boolean isRequired()Get if this field is a required one?- Returns:
true
if the field is required,true
otherwise.
-
setType
Set type information of this field.- Parameters:
type
- Type information of this field.
-
getType
Get type information of this field.- Returns:
- Type information of this field.
-
setTable
Set table which contains this field.- Parameters:
table
- Table which contains this field.
-
getTable
Get table which contains this field.- Returns:
- Table which contains this field.
-
getLength
Get length parameter from mapping of sql field.
Returnsnull
as it is not supported yet.- Returns:
- length Length parameter from mapping of sql field.
-
getPrecision
Get precision parameter from mapping of sql field.
Returnsnull
as it is not supported yet.- Returns:
- precision Precision parameter from mapping of sql field.
-
getDecimals
Get decimals parameter from mapping of sql field.
Returnsnull
as it is not supported yet.- Returns:
- decimals Decimals parameter from mapping of sql field.
-
toDropDDL
Build drop script for the schema object.- Parameters:
writer
- DDLWriter to write schema objects to.
-
merge
Check if given field can be merged with this one.- Parameters:
field
- Field to check if it is able to be merged.- Throws:
GeneratorException
- If fields cannot be merged.
-
equals
-
hashCode
public final int hashCode()
-