org.castor.ddlgen.schemaobject

Class Field

Implemented Interfaces:
SchemaObject
Known Direct Subclasses:
Db2Field, DefaultField, DerbyField, HsqlField, MssqlField, MysqlField, PointBaseField, PostgresqlField, SybaseField

public abstract class Field
extends AbstractSchemaObject

Abstract base class of all field implementations.
Version:
$Revision: 5951 $ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $
Authors:
Le Duc Bao
Ralf Joachim
Since:
1.1

Field Summary

Fields inherited from class org.castor.ddlgen.schemaobject.AbstractSchemaObject

HASHFACTOR

Method Summary

boolean
equals(Object other)
Integer
getDecimals()
Get decimals parameter from mapping of sql field.
KeyGenerator
getKeyGenerator()
Get key generator for this field.
Integer
getLength()
Get length parameter from mapping of sql field.
Integer
getPrecision()
Get precision parameter from mapping of sql field.
Table
getTable()
Get table which contains this field.
TypeInfo
getType()
Get type information of this field.
int
hashCode()
boolean
isIdentity()
Get if this field is part of the identity?
boolean
isRequired()
Get if this field is a required one?
void
merge(Field field)
Check if given field can be merged with this one.
void
setIdentity(boolean isIdentity)
Set if this field is part of the identity?
void
setKeyGenerator(KeyGenerator keyGenerator)
Set key generator for this field.
void
setRequired(boolean isRequired)
Set if this field is a required one?
void
setTable(Table table)
Set table which contains this field.
void
setType(TypeInfo type)
Set type information of this field.
void
toDropDDL(DDLWriter writer)

Methods inherited from class org.castor.ddlgen.schemaobject.AbstractSchemaObject

equals, getConfiguration, getName, setConfiguration, setName

Method Details

equals

public final boolean equals(Object other)

getDecimals

public final Integer getDecimals()
Get decimals parameter from mapping of sql field.
Returns null as it is not supported yet.
Returns:
decimals Decimals parameter from mapping of sql field.

getKeyGenerator

public final KeyGenerator getKeyGenerator()
Get key generator for this field.
Returns:
Key generator for this field.

getLength

public final Integer getLength()
Get length parameter from mapping of sql field.
Returns null as it is not supported yet.
Returns:
length Length parameter from mapping of sql field.

getPrecision

public final Integer getPrecision()
Get precision parameter from mapping of sql field.
Returns null as it is not supported yet.
Returns:
precision Precision parameter from mapping of sql field.

getTable

public final Table getTable()
Get table which contains this field.
Returns:
Table which contains this field.

getType

public final TypeInfo getType()
Get type information of this field.
Returns:
Type information of this field.

hashCode

public final int hashCode()

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.

isRequired

public final boolean isRequired()
Get if this field is a required one?
Returns:
true if the field is required, true otherwise.

merge

public final void merge(Field field)
            throws GeneratorException
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.

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.

setKeyGenerator

public final void setKeyGenerator(KeyGenerator keyGenerator)
Set key generator for this field. null if the field has no key generator.
Parameters:
keyGenerator - Key generator for this field.

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.

setTable

public final void setTable(Table table)
Set table which contains this field.
Parameters:
table - Table which contains this field.

setType

public final void setType(TypeInfo type)
Set type information of this field.
Parameters:
type - Type information of this field.

toDropDDL

public final void toDropDDL(DDLWriter writer)
Specified by:
toDropDDL in interface SchemaObject

Intalio Inc. (C) 1999-2008. All rights reserved http://www.intalio.com