Extension SDK 9.0.5

oracle.jdeveloper.cm.ds.db
Interface DDLGenerator

All Known Implementing Classes:
AbstractDDLGenerator

public interface DDLGenerator

The DDLGenerator interface defines an API for retrieving the neccessary DDL statements for creating, updating, and deleting objects.

Since:
9.0.5

Method Summary
 Ddl getCreateDDL(SchemaObject object)
          Retrieves the DDL for creating the specified object.
 Ddl getCreateDDL(SchemaObject object, boolean replace)
          Retrieves the DDL for creating the specified object.
 Ddl[] getDeleteDDL(SchemaObject object, boolean cascade)
          Retrieves the DDL for deleting an object.
 Ddl[] getUpdateDDL(SchemaObject oldObject, SchemaObject newObject)
          Retrieves the DDL for updating the definition of an object.
 

Method Detail

getCreateDDL

public Ddl getCreateDDL(SchemaObject object,
                        boolean replace)
Retrieves the DDL for creating the specified object.

Parameters:
object - the object for which DDL is required
replace - whether an existing object should be replaced
Returns:
a string array containing the DDL statements necessary to create the object

getCreateDDL

public Ddl getCreateDDL(SchemaObject object)
Retrieves the DDL for creating the specified object.

Parameters:
object - the object for which DDL is required
Returns:
a string array containing the DDL statements necessary to create the object

getUpdateDDL

public Ddl[] getUpdateDDL(SchemaObject oldObject,
                          SchemaObject newObject)
Retrieves the DDL for updating the definition of an object.

Parameters:
oldObject - the original version of the object
newObject - the updated data model
Returns:
a string array containing the DDL statements that will update the old object to the new model
Throws:
DBException - if legal DDL cannot be generated

getDeleteDDL

public Ddl[] getDeleteDDL(SchemaObject object,
                          boolean cascade)
Retrieves the DDL for deleting an object.

Parameters:
object - the object to be deleted
cascade - a boolean value indicating whether a cascade delete should be performed, if appropriate for the object type
Returns:
a string array containing the DDL statements for deleting the object

Extension SDK

 

Copyright © 1997, 2004, Oracle. All rights reserved.