org.castor.ddlgen.schemaobject

Interface SchemaObject

All Known Implementing Classes:

AbstractSchemaObject, Db2Field, Db2PrimaryKey, DefaultField, DefaultForeignKey, DefaultIndex, DefaultPrimaryKey, DefaultSchema, DefaultTable, DerbyField, Field, ForeignKey, HighLowKeyGenerator, HsqlField, HsqlPrimaryKey, HsqlTable, IdentityKeyGenerator, Index, KeyGenerator, MaxKeyGenerator, MssqlField, MssqlPrimaryKey, MysqlField, MysqlForeignKey, MysqlSchema, MysqlTable, PointBaseField, PointBasePrimaryKey, PostgresqlField, PrimaryKey, Schema, SequenceKeyGenerator, SybaseField, Table, UUIDKeyGenerator

public interface SchemaObject

Interface for all schema objects.

Since:

1.1

Version:

$Revision: 5951 $ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $

Author:

Le Duc Bao, Ralf Joachim

Method Summary

Methods

Modifier and Type	Method and Description
DDLGenConfiguration	getConfiguration() Get configuration of the schema object.
String	getName() Get name of the schema object.
void	setConfiguration(DDLGenConfiguration config) Set configuration of the schema object.
void	setName(String name) Set name of the schema object.
void	toCreateDDL(DDLWriter writer) Build create script for the schema object.
void	toDropDDL(DDLWriter writer) Build drop script for the schema object.

Method Detail

setConfiguration

void setConfiguration(DDLGenConfiguration config)

Set configuration of the schema object.

Parameters:

config - Configuration to be used by the schema object.

getConfiguration

DDLGenConfiguration getConfiguration()

Get configuration of the schema object.

Returns:

Configuration of the schema object.

setName

void setName(String name)

Set name of the schema object.

Parameters:

name - Name of the schema object.

getName

String getName()

Get name of the schema object.

Returns:

Name of the schema object.

toCreateDDL

void toCreateDDL(DDLWriter writer)
                 throws GeneratorException

Build create script for the schema object.

Parameters:

writer - DDLWriter to write schema objects to.

Throws:

GeneratorException - If generation of the script failed or is not supported.

toDropDDL

void toDropDDL(DDLWriter writer)
               throws GeneratorException

Build drop script for the schema object.

Parameters:

writer - DDLWriter to write schema objects to.

Throws:

GeneratorException - If generation of the script failed or is not supported.