|
EclipseLink 2.5.0, build 'v20130507-3faac2b' API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition
public abstract class DatabaseObjectDefinition
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:
| Field Summary | |
|---|---|
java.lang.String |
name
|
java.lang.String |
qualifier
|
| Constructor Summary | |
|---|---|
DatabaseObjectDefinition()
|
|
| Method Summary | |
|---|---|
abstract java.io.Writer |
buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer writer)
INTERNAL: Returns the writer used for creation of this object. |
abstract java.io.Writer |
buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer writer)
INTERNAL: Returns the writer used for deletion of this object. |
java.io.Writer |
buildVPDCreationFunctionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer writer)
INTERNAL: Sub classes should override. |
java.io.Writer |
buildVPDCreationPolicyWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer writer)
INTERNAL: Sub classes should override. |
java.io.Writer |
buildVPDDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer writer)
INTERNAL: Sub classes should override. |
java.lang.Object |
clone()
PUBLIC: |
void |
createDatabaseSchema(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer writer,
java.util.Set<java.lang.String> createdDatabaseSchemas)
INTERNAL: Execute the DDL to create the database schema for this object. |
void |
createDatabaseSchemaOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.util.Set<java.lang.String> createdDatabaseSchemas)
INTERNAL: Execute the DDL to create the database schema for this object. |
void |
createObject(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer schemaWriter)
INTERNAL: Either drop from the database directly or write the statement to a file. |
void |
createOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL: Execute the DDL to create this object. |
void |
dropDatabaseSchema(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer writer)
INTERNAL: Execute the DDL to drop the database schema for this object. |
void |
dropDatabaseSchemaOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL: Execute the DDL to drop the database schema for this object. |
void |
dropFromDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL: Execute the DDL to drop the object. |
void |
dropObject(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer schemaWriter,
boolean createSQLFiles)
INTERNAL: Execute the DDL to drop the object. |
java.lang.String |
getDatabaseSchema()
PUBLIC: Return the database schema associated with this database object. |
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. |
protected boolean |
hasDatabaseSchema()
INTERNAL: Return true is this database object definition has a schema definition. |
void |
postCreateObject(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer createSchemaWriter,
boolean createSQLFiles)
Execute any statements required after the creation of the object |
void |
preDropObject(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer dropSchemaWriter,
boolean createSQLFiles)
Execute any statements required before the deletion of the object |
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. |
boolean |
shouldCreateDatabaseSchema(java.util.Set<java.lang.String> createdDatabaseSchemas)
INTERNAL: Subclasses who care should override this method, e.g. |
boolean |
shouldCreateVPDCalls(org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL: Subclasses who care should override this method. |
java.lang.String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public java.lang.String name
public java.lang.String qualifier
| Constructor Detail |
|---|
public DatabaseObjectDefinition()
| Method Detail |
|---|
public abstract java.io.Writer buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer writer)
throws ValidationException
ValidationException
public java.io.Writer buildVPDCreationPolicyWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer writer)
public java.io.Writer buildVPDCreationFunctionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer writer)
public java.io.Writer buildVPDDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer writer)
public abstract java.io.Writer buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer writer)
throws ValidationException
ValidationExceptionpublic java.lang.Object clone()
clone in class java.lang.Object
public void createDatabaseSchema(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer writer,
java.util.Set<java.lang.String> createdDatabaseSchemas)
throws EclipseLinkException
EclipseLinkExceptionTableDefinition
public void createDatabaseSchemaOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.util.Set<java.lang.String> createdDatabaseSchemas)
throws EclipseLinkException
EclipseLinkExceptionTableDefinition
public void createObject(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer schemaWriter)
throws EclipseLinkException
EclipseLinkException
public void createOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)
throws EclipseLinkException
EclipseLinkExceptionpublic boolean shouldCreateDatabaseSchema(java.util.Set<java.lang.String> createdDatabaseSchemas)
public boolean shouldCreateVPDCalls(org.eclipse.persistence.internal.sessions.AbstractSession session)
public void dropDatabaseSchema(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer writer)
throws EclipseLinkException
EclipseLinkExceptionTableDefinition
public void dropDatabaseSchemaOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)
throws EclipseLinkException
EclipseLinkExceptionTableDefinition
public void dropFromDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)
throws EclipseLinkException
EclipseLinkException
public void dropObject(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer schemaWriter,
boolean createSQLFiles)
throws EclipseLinkException
EclipseLinkExceptionpublic java.lang.String getDatabaseSchema()
TableDefinitionpublic java.lang.String getFullName()
public java.lang.String getName()
public java.lang.String getQualifier()
protected boolean hasDatabaseSchema()
public void postCreateObject(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer createSchemaWriter,
boolean createSQLFiles)
session - createSchemaWriter -
public void preDropObject(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer dropSchemaWriter,
boolean createSQLFiles)
session - dropSchemaWriter - public void setName(java.lang.String name)
public void setQualifier(java.lang.String qualifier)
public java.lang.String toString()
toString in class java.lang.Object
|
EclipseLink 2.5.0, build 'v20130507-3faac2b' API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||