Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.0.0)

E17493-01

oracle.javatools.db.ddl
Class DDLOptions

java.lang.Object
  extended by oracle.javatools.data.HashStructureAdapter
      extended by oracle.javatools.db.ddl.DDLOptions

public class DDLOptions
extends HashStructureAdapter

The options to customise the generation of DDL when using a DDLGenerator.

Since:
11

Field Summary
 
Fields inherited from class oracle.javatools.data.HashStructureAdapter
_hash
 
Constructor Summary
  DDLOptions()
           
  DDLOptions(boolean replace, boolean cascade)
           
protected DDLOptions(HashStructure hash)
           
 
Method Summary
 java.lang.String getSpoolFile()
           
 boolean isCascade()
          Gets whether to generate cascade delete ddl.
 boolean isIncludePrompts()
          Gets whether to generate prompts.
 boolean isPrefixSchemaName()
          Gets whether to always prefix names with the schema.
 boolean isReplace()
          Returns whether to generate the ddl to automatically replace any existing objects.
 boolean isSqlBlankLines()
           
 void setCascade(boolean cascade)
          Sets wether to generate ddl to automatically cascade the delete of any object or child object (e.g.
 void setIncludePrompts(boolean prompts)
          Sets whether to generate prompts for the database's command line client (e.g.
 void setPrefixSchemaName(boolean prefix)
          Sets whether to always prefix names with the schema.
 void setReplace(boolean replace)
          Sets whether to generate the ddl to automatically replace any existing objects.
 void setSpoolFile(java.lang.String filename)
           
 void setSqlBlankLines(boolean onOrOff)
          Sets whether or not to generate the SQL*Plus command
SET SQLBLANKLINES ON
when the generated objdect contain multi-line comments.
 
Methods inherited from class oracle.javatools.data.HashStructureAdapter
addStructureChangeListener, containsKey, copyTo, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DDLOptions

protected DDLOptions(HashStructure hash)

DDLOptions

public DDLOptions()

DDLOptions

public DDLOptions(boolean replace,
                  boolean cascade)
Method Detail

setReplace

public void setReplace(boolean replace)
Sets whether to generate the ddl to automatically replace any existing objects.


isReplace

public final boolean isReplace()
Returns whether to generate the ddl to automatically replace any existing objects.


setCascade

public void setCascade(boolean cascade)
Sets wether to generate ddl to automatically cascade the delete of any object or child object (e.g. table, or primary key).


isCascade

public final boolean isCascade()
Gets whether to generate cascade delete ddl.


setPrefixSchemaName

public void setPrefixSchemaName(boolean prefix)
Sets whether to always prefix names with the schema.


isPrefixSchemaName

public boolean isPrefixSchemaName()
Gets whether to always prefix names with the schema.


setIncludePrompts

public void setIncludePrompts(boolean prompts)
Sets whether to generate prompts for the database's command line client (e.g. SQL*Plus for Oracle)


isIncludePrompts

public boolean isIncludePrompts()
Gets whether to generate prompts.

See Also:
#setGeneratePrompt

getSpoolFile

public java.lang.String getSpoolFile()

setSpoolFile

public void setSpoolFile(java.lang.String filename)

isSqlBlankLines

public boolean isSqlBlankLines()

setSqlBlankLines

public void setSqlBlankLines(boolean onOrOff)
Sets whether or not to generate the SQL*Plus command
SET SQLBLANKLINES ON
when the generated objdect contain multi-line comments.

This is needs to be set true for SQL*Plus scripts. It is only used by OracleDDLGenerator.


Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.0.0)

E17493-01

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