org.castor.ddlgen.schemaobject

Class Index

java.lang.Object

org.castor.ddlgen.schemaobject.AbstractSchemaObject

org.castor.ddlgen.schemaobject.Index

All Implemented Interfaces:

SchemaObject

Direct Known Subclasses:

DefaultIndex

public abstract class Index
extends AbstractSchemaObject

Abstract base class for all indices.

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
Index()

Method Summary

Methods

Modifier and Type	Method and Description
void	addField(Field field) Add given field to list of index fields.
boolean	equals(Object other)
protected void	fieldNames(DDLWriter writer) Concatenate all field names delimited by field delimiter and whitespace.
Field	getField(int index) Get index field at given index.
int	getFieldCount() Get number of index fields.
Table	getTable() Get table the foreign key is used for.
int	hashCode()
void	setTable(Table table) Set table the foreign key is used for.

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, toDropDDL

Constructor Detail

Index

public Index()

Method Detail

addField

public final void addField(Field field)

Add given field to list of index fields.

Parameters:

field - Field to add to list of index fields.

getFieldCount

public final int getFieldCount()

Get number of index fields.

Returns:

Number of index fields.

getField

public final Field getField(int index)

Get index field at given index.

Parameters:

index - Index of index field to return.

Returns:

Index field at given index.

setTable

public final void setTable(Table table)

Set table the foreign key is used for.

Parameters:

table - Table the foreign key is used for.

getTable

public final Table getTable()

Get table the foreign key is used for.

Returns:

Table the foreign 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.

equals

public final boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object