org.castor.ddlgen.schemaobject

Class PrimaryKey

java.lang.Object

org.castor.ddlgen.schemaobject.AbstractSchemaObject

org.castor.ddlgen.schemaobject.PrimaryKey

All Implemented Interfaces:

SchemaObject

Direct Known Subclasses:

Db2PrimaryKey, DefaultPrimaryKey, HsqlPrimaryKey, MssqlPrimaryKey, PointBasePrimaryKey

public abstract class PrimaryKey
extends AbstractSchemaObject

Abstract base class for all primary keys.

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

Constructor and Description
PrimaryKey()

Method Summary

Methods

Modifier and Type	Method and Description
void	addField(Field field) Add given field to list of primary key fields.
boolean	equals(java.lang.Object other)
protected void	fieldNames(DDLWriter writer) Concatenate all field names delimited by field delimiter and whitespace.
Field	getField(int index) Get primary key field at given index.
int	getFieldCount() Get number of primary key fields.
Table	getTable() Get table the primary key is used for.
int	hashCode()
void	setTable(Table table) Set table the primary key is used for.
void	toDropDDL(DDLWriter writer) 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 Detail

PrimaryKey

public PrimaryKey()

Method Detail

addField

public final void addField(Field field)

Add given field to list of primary key fields.

Parameters:

field - Field to add to list of primary key fields.

getFieldCount

public final int getFieldCount()

Get number of primary key fields.

Returns:

Number of primary key fields.

getField

public final Field getField(int index)

Get primary key field at given index.

Parameters:

index - Index of primary key field to return.

Returns:

Primary key field at given index.

setTable

public final void setTable(Table table)

Set table the primary key is used for.

Parameters:

table - Table the primary key is used for.

getTable

public final Table getTable()

Get table the primary key is used for.

Returns:

Table the primary key is used for.

fieldNames

protected final void fieldNames(DDLWriter writer)

Concatenate all field names delimited by field delimiter and whitespace.

Parameters:

writer - DDLWriter to write schema objects to.

toDropDDL

public final void toDropDDL(DDLWriter writer)

Build drop script for the schema object.

Parameters:

writer - DDLWriter to write schema objects to.

equals

public final boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object