oracle.toplink.essentials.tools.schemaframework

Class DatabaseObjectDefinition

java.lang.Object

oracle.toplink.essentials.tools.schemaframework.DatabaseObjectDefinition

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

SequenceDefinition, TableDefinition, ViewDefinition

public abstract class DatabaseObjectDefinition
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

Purpose: Define a database object for the purpose of creation and deletion. A database object is an entity such as a table, view, proc, sequence...

Responsibilities:

• Be able to create and drop the object from the database.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	name
java.lang.String	qualifier

Constructor Summary

Constructors

Constructor and Description
DatabaseObjectDefinition()

Method Summary

Modifier and Type	Method and Description
abstract java.io.Writer	buildCreationWriter(AbstractSession session, java.io.Writer writer) INTERNAL: Returns the writer used for creation of this object.
abstract java.io.Writer	buildDeletionWriter(AbstractSession session, java.io.Writer writer) INTERNAL: Returns the writer used for creation of this object.
java.lang.Object	clone() PUBLIC:
void	createObject(AbstractSession session, java.io.Writer schemaWriter) INTERNAL: Either drop from the database directly or write the statement to a file.
void	createOnDatabase(AbstractSession session) INTERNAL: Execute the DDL to create the varray.
void	dropFromDatabase(AbstractSession session) INTERNAL: Execute the DDL to drop the varray.
void	dropObject(AbstractSession session, java.io.Writer schemaWriter) INTERNAL: Execute the DDL to drop the varray.
java.lang.String	getFullName() INTERNAL: Most major databases support a creator name scope.
java.lang.String	getName() PUBLIC: Return the name of the object.
java.lang.String	getQualifier() PUBLIC: Most major databases support a creator name scope.
void	setName(java.lang.String name) PUBLIC: Set the name of the object.
void	setQualifier(java.lang.String qualifier) PUBLIC: Most major databases support a creator name scope.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

public java.lang.String name

qualifier

public java.lang.String qualifier

Constructor Detail

DatabaseObjectDefinition

public DatabaseObjectDefinition()

Method Detail

buildCreationWriter

public abstract java.io.Writer buildCreationWriter(AbstractSession session,
                                                   java.io.Writer writer)
                                            throws ValidationException

INTERNAL: Returns the writer used for creation of this object.

Throws:

ValidationException

buildDeletionWriter

public abstract java.io.Writer buildDeletionWriter(AbstractSession session,
                                                   java.io.Writer writer)
                                            throws ValidationException

INTERNAL: Returns the writer used for creation of this object.

Throws:

ValidationException

clone

public java.lang.Object clone()

PUBLIC:

Overrides:

clone in class java.lang.Object

createObject

public void createObject(AbstractSession session,
                         java.io.Writer schemaWriter)
                  throws TopLinkException

INTERNAL: Either drop from the database directly or write the statement to a file. Database objects are root level entities such as tables, views, procs, sequences...

Throws:

TopLinkException

createOnDatabase

public void createOnDatabase(AbstractSession session)
                      throws TopLinkException

INTERNAL: Execute the DDL to create the varray.

Throws:

TopLinkException

dropFromDatabase

public void dropFromDatabase(AbstractSession session)
                      throws TopLinkException

INTERNAL: Execute the DDL to drop the varray.

Throws:

TopLinkException

dropObject

public void dropObject(AbstractSession session,
                       java.io.Writer schemaWriter)
                throws TopLinkException

INTERNAL: Execute the DDL to drop the varray. Either directly from the database of write out the statement to a file.

Throws:

TopLinkException

getFullName

public java.lang.String getFullName()

INTERNAL: Most major databases support a creator name scope. This means whenever the database object is referecned, it must be qualified.

getName

public java.lang.String getName()

PUBLIC: Return the name of the object. i.e. the table name or the sequence name.

getQualifier

public java.lang.String getQualifier()

PUBLIC: Most major databases support a creator name scope. This means whenever the database object is referecned, it must be qualified.

setName

public void setName(java.lang.String name)

PUBLIC: Set the name of the object. i.e. the table name or the sequence name.

setQualifier

public void setQualifier(java.lang.String qualifier)

PUBLIC: Most major databases support a creator name scope. This means whenever the database object is referecned, it must be qualified.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object