Field Detail

• name

  public String name

• qualifier

  public String qualifier

Constructor Detail

• DatabaseObjectDefinition

  public DatabaseObjectDefinition()

Method Detail

• buildCreationWriter

  public abstract Writer buildCreationWriter​(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                             Writer writer)
                                      throws ValidationException

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

  Throws:

  ValidationException

• buildVPDCreationPolicyWriter

  public Writer buildVPDCreationPolicyWriter​(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                             Writer writer)

  INTERNAL: Sub classes should override.

• buildVPDCreationFunctionWriter

  public Writer buildVPDCreationFunctionWriter​(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                               Writer writer)

  INTERNAL: Sub classes should override.

• buildVPDDeletionWriter

  public Writer buildVPDDeletionWriter​(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                       Writer writer)

  INTERNAL: Sub classes should override.

• buildDeletionWriter

  public abstract Writer buildDeletionWriter​(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                             Writer writer)
                                      throws ValidationException

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

  Throws:

  ValidationException

• clone

  public Object clone()

  PUBLIC:

• createDatabaseSchema

  public void createDatabaseSchema​(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                   Writer writer,
                                   Set<String> createdDatabaseSchemas)
                            throws EclipseLinkException

  INTERNAL: Execute the DDL to create the database schema for this object. Does nothing at this level, subclasses that support this must override this method.

  Throws:

  EclipseLinkException

  See Also:

  TableDefinition

• createDatabaseSchemaOnDatabase

  public void createDatabaseSchemaOnDatabase​(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                             Set<String> createdDatabaseSchemas)
                                      throws EclipseLinkException

  INTERNAL: Execute the DDL to create the database schema for this object. Does nothing at this level, subclasses that support this must override this method.

  Throws:

  EclipseLinkException

  See Also:

  TableDefinition

• createObject

  public void createObject​(org.eclipse.persistence.internal.sessions.AbstractSession session,
                           Writer schemaWriter)
                    throws EclipseLinkException

  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:

  EclipseLinkException

• createOnDatabase

  public void createOnDatabase​(org.eclipse.persistence.internal.sessions.AbstractSession session)
                        throws EclipseLinkException

  INTERNAL: Execute the DDL to create this object.

  Throws:

  EclipseLinkException

• shouldCreateDatabaseSchema

  public boolean shouldCreateDatabaseSchema​(Set<String> createdDatabaseSchemas)

  INTERNAL: Subclasses who care should override this method, e.g. TableDefinition.

• shouldCreateVPDCalls

  public boolean shouldCreateVPDCalls​(org.eclipse.persistence.internal.sessions.AbstractSession session)

  INTERNAL: Subclasses who care should override this method.

• dropDatabaseSchema

  public void dropDatabaseSchema​(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                 Writer writer)
                          throws EclipseLinkException

  INTERNAL: Execute the DDL to drop the database schema for this object. Does nothing at this level, subclasses that support this must override this method.

  Throws:

  EclipseLinkException

  See Also:

  TableDefinition

• dropDatabaseSchemaOnDatabase

  public void dropDatabaseSchemaOnDatabase​(org.eclipse.persistence.internal.sessions.AbstractSession session)
                                    throws EclipseLinkException

  INTERNAL: Execute the DDL to drop the database schema for this object. Does nothing at this level, subclasses that support this must override this method.

  Throws:

  EclipseLinkException

  See Also:

  TableDefinition

• dropFromDatabase

  public void dropFromDatabase​(org.eclipse.persistence.internal.sessions.AbstractSession session)
                        throws EclipseLinkException

  INTERNAL: Execute the DDL to drop the object.

  Throws:

  EclipseLinkException

• dropObject

  public void dropObject​(org.eclipse.persistence.internal.sessions.AbstractSession session,
                         Writer schemaWriter,
                         boolean createSQLFiles)
                  throws EclipseLinkException

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

  Throws:

  EclipseLinkException

• getDatabaseSchema

  public String getDatabaseSchema()

  PUBLIC: Return the database schema associated with this database object.

  See Also:

  TableDefinition

• getFullName

  public String getFullName()

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

• getName

  public String getName()

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

• getQualifier

  public String getQualifier()

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

• postCreateObject

  public void postCreateObject​(org.eclipse.persistence.internal.sessions.AbstractSession session,
                               Writer createSchemaWriter,
                               boolean createSQLFiles)

  Execute any statements required after the creation of the object

  Parameters:

  session -

  createSchemaWriter -

• preDropObject

  public void preDropObject​(org.eclipse.persistence.internal.sessions.AbstractSession session,
                            Writer dropSchemaWriter,
                            boolean createSQLFiles)

  Execute any statements required before the deletion of the object

  Parameters:

  session -

  dropSchemaWriter -

• setName

  public void setName​(String name)

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

• setQualifier

  public void setQualifier​(String qualifier)

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

• toString

  public String toString()

  Overrides:

  toString in class Object