|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.9.0) E52944-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.javatools.db.property.AbstractPropertyManager
oracle.javatools.db.ddl.TokenDDLGenerator<T>
oracle.javatools.db.ddl.BundleDDLGenerator<T>
public abstract class BundleDDLGenerator<T extends DDLType>
TokenDDLGenerator subclass that uses either a set of Properties files or ResourceBundles with specially formatted keys to automatically register DDL for generation. In addition to the automatic registration process, additional tokens can be registered from the bundles by calling the registerBundle* methods from a subclass.
If the a key in a bundle is of the form:
TYPE.ACTION.DDLTYPE
TABLE.CREATE.TAB
or SEQUENCE.ALTER.SEQ
getDDLType(java.lang.String)
method which should return a DDLType appropriate to this generator.TYPE.ACTION.DDLTYPE.1
GLOBAL.myToken
myToken
can then be reused in token code globally. If myToken
is an object type (e.g. COLUMN
) that registers a global token against that object type.All other keys are ignored.
When processing the entries of the resoure bundle, if any key contains two "."s and doesn't match a type, action or ddltype a severe
message will be logged on the logger
.
Constructor Summary | |
---|---|
BundleDDLGenerator(DBObjectProvider pro, java.lang.String... resourceNames) Note the first parameter is a DBObjectProvider, not a Database. |
Method Summary | |
---|---|
protected void |
addBundles(java.util.ResourceBundle... bundles) Adds the given bundles to this generator. |
protected void |
addResourceNames(java.lang.String... resourceNames) Adds the given resource names to this generator. |
protected boolean |
canChangeWithAlter(DBObject orig, DBObject update, java.lang.String prop) Returns true if the given property can be changed using an alter on the given original and updated objects. |
protected boolean |
canCreate(java.lang.String type, java.lang.String prop) Tests whether the given property is supported for create on the given object type. |
protected void |
copyGenerators(oracle.javatools.db.ddl.DDLGeneratorImpl other, java.lang.String type, boolean incAlter) Copies the ddl generators for the given object type from this generator to another generator implementation. |
protected java.lang.String |
findResource(java.lang.String key) |
protected DDL<T> |
finish(DDLOptions options, DDL<T> ddl) This method is called on every DDL created before it is returned. |
DDL<T> |
getCreateDDL(DDLOptions options, DBObject... objects) Gets CREATE statements for the given objects. |
Ddl |
getCreateDDL(Schema schema) Deprecated. |
Ddl |
getCreateDDL(SchemaObject[] objects, boolean replace, boolean cascade) Deprecated. |
Ddl |
getCreateDDL(SchemaObject obj, boolean replace, boolean cascade) Deprecated. |
protected DDL<T> |
getCreateDDLImpl(DDLOptions options, DBObject... objects) |
protected abstract T |
getDDLType(java.lang.String type) Implement in subclasses to return the right DDLType implementation for the given string. |
DDL<T> |
getDeleteDDL(DDLOptions options, DBObject... objects) Gets DROP statements for the given objects. |
Ddl |
getDeleteDDL(Schema schema, boolean cascade) Deprecated. |
Ddl |
getDeleteDDL(SchemaObject[] objects, boolean cascade) Deprecated. |
Ddl |
getDeleteDDL(SchemaObject object, boolean cascade) Deprecated. |
protected DDL<T> |
getDeleteDDLImpl(DDLOptions options, DBObject... objects) |
protected PropertyHelper |
getPropertyHelper() |
DDL<T> |
getUndeleteDDL(DDLOptions options, DBObject... objects) Gets statements to undelete (e.g. |
DDL<T> |
getUpdateDDL(DDLOptions options, Difference resultSet) Gets ALTER statements for the given objects where possible, or DROP/CREATE, or CREATE AND REPLACE where appropriate/necessary. |
Ddl[] |
getUpdateDDL(Difference resultSet, boolean replace, boolean cascade) Deprecated. |
Ddl[] |
getUpdateDDL(SchemaObject[] oldObjects, SchemaObject[] newObjects) Deprecated. |
Ddl[] |
getUpdateDDL(SchemaObject oldObject, SchemaObject newObject) Deprecated. |
protected DDL<T> |
getUpdateDDLImpl(DDLOptions options, Difference rs) Gets the update DDL for the given Difference. |
protected void |
processResultSet(DDLOptions options, Difference rs, DDL<T> ddl) |
protected void |
registerAlterGenerator(java.lang.String type, AlterDDLGenerator deletor) |
protected void |
registerBundleAlterDDL(java.lang.String type, java.lang.String resName, T ddlType) Registers alter DDL code from the ResourceBundle by the resource name of the code in that bundle. |
protected void |
registerBundleCreateDDL(java.lang.String type, java.lang.String resName, T ddlType) Registers create DDL code from the ResourceBundle by the resource name of the code in that bundle. |
protected void |
registerBundleDropDDL(java.lang.String type, java.lang.String resName, T ddlType) Registers drop DDL code from the ResourceBundle by the resource name of the code in that bundle. |
protected void |
registerBundleEntry(java.lang.String key, java.lang.String code) Registers an entry from an underlying bundle (or property file). |
protected void |
registerBundleTokens() Registers all the tokens in the underyling resource bundles. |
protected void |
registerBundleUndeleteDDL(java.lang.String type, java.lang.String resName, T ddlType) Registers undelete DDL code from the ResourceBundle by the resource name of the code in that bundle. |
protected void |
registerCreateGenerator(java.lang.String type, CreateDDLGenerator creator) |
protected void |
registerDropGenerator(java.lang.String type, DropDDLGenerator dropper) |
protected void |
registerTopLevelChild(java.lang.String type, java.lang.String propPath, java.lang.String childType) Registers a child object property, that can be treated as a top level object in the ddl, and therefore when encountered the generator should recurse onto the object. |
protected void |
registerUndeleteGenerator(java.lang.String type, UndeleteDDLGenerator undeletor) |
boolean |
supportsAction(java.lang.String type, PropertyAction.Type actionType) Asks whether a given action is supported for the specified object type in this provider. |
Methods inherited from class oracle.javatools.db.ddl.TokenDDLGenerator |
---|
createDDL, createUpdateDDL, includeSyntax, registerAlterDDL, registerCreateDDL, registerDropDDL, registerTokenGenerator, registerUndeleteDDL |
Methods inherited from class oracle.javatools.db.property.AbstractPropertyManager |
---|
canAlterProperty, canChangeProperty, canChangeWithReplace, canCreate, canUpdateObject, canUpdateObject, getLogger, getProvider, getProviderClass, supportsProperty, supportsProperty |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface oracle.javatools.db.property.PropertyManager |
---|
canAlterProperty, canChangeProperty, canUpdateObject, canUpdateObject, supportsProperty |
Constructor Detail |
---|
public BundleDDLGenerator(DBObjectProvider pro, java.lang.String... resourceNames)
If the resourceNames parameter is non-null this will call #addResourcesNames
and therefore initialise the generator. If resourceNames is omitted, addResourceNames(java.lang.String...)
or addBundles(java.util.ResourceBundle...)
must be called for the generator to function.
pro
- the provider for this generator to use for name externalisation etcbundles
- either Strings (for properties files) or ResourceBundles that contains the ddl token syntax.Method Detail |
---|
protected void addResourceNames(java.lang.String... resourceNames)
addBundles(java.util.ResourceBundle...)
should be called only once for a given generator to avoid duplicate registration of resources.resourceNames
- the names of properties files containing the resourcesprotected void addBundles(java.util.ResourceBundle... bundles)
addResourceNames(java.lang.String...)
should be called only once for a given generator to avoid duplicate registration of resources.bundles
- the ResourceBundles containing the ddl token strings.protected final java.lang.String findResource(java.lang.String key)
protected final void registerBundleTokens()
protected void registerBundleEntry(java.lang.String key, java.lang.String code)
key
-code
-protected abstract T getDDLType(java.lang.String type)
protected final void registerBundleCreateDDL(java.lang.String type, java.lang.String resName, T ddlType)
TokenDDLGenerator.registerCreateDDL(String,String,oracle.javatools.db.ddl.DDLType)
protected final void registerBundleDropDDL(java.lang.String type, java.lang.String resName, T ddlType)
TokenDDLGenerator.registerDropDDL(String,String,oracle.javatools.db.ddl.DDLType)
protected final void registerBundleUndeleteDDL(java.lang.String type, java.lang.String resName, T ddlType)
TokenDDLGenerator.registerDropDDL(String,String,oracle.javatools.db.ddl.DDLType)
protected final void registerBundleAlterDDL(java.lang.String type, java.lang.String resName, T ddlType)
TokenDDLGenerator.registerAlterDDL(String,String,oracle.javatools.db.ddl.DDLType)
protected PropertyHelper getPropertyHelper()
protected final void registerCreateGenerator(java.lang.String type, CreateDDLGenerator creator)
protected final void registerDropGenerator(java.lang.String type, DropDDLGenerator dropper)
protected final void registerAlterGenerator(java.lang.String type, AlterDDLGenerator deletor)
protected final void registerUndeleteGenerator(java.lang.String type, UndeleteDDLGenerator undeletor)
protected final void copyGenerators(oracle.javatools.db.ddl.DDLGeneratorImpl other, java.lang.String type, boolean incAlter)
other
- the ddl generator to copy syntax totype
- the object type to copyincAlter
- whether to include alter ddl statements, or just create and drop.protected final void registerTopLevelChild(java.lang.String type, java.lang.String propPath, java.lang.String childType)
type
- the parent object type (e.g. Table.TYPE
)propPath
- the path to the child property (e.g. indexes
)childType
- the child object type that can be treated in its own right in the ddl generator (e.g. Index.TYPE
)protected DDL<T> getCreateDDLImpl(DDLOptions options, DBObject... objects)
protected DDL<T> getDeleteDDLImpl(DDLOptions options, DBObject... objects)
public DDL<T> getUndeleteDDL(DDLOptions options, DBObject... objects)
DDLGenerator
protected DDL<T> getUpdateDDLImpl(DDLOptions options, Difference rs)
options
- the options for generationrs
- the Difference for the object to alterprotected boolean canCreate(java.lang.String type, java.lang.String prop)
AbstractPropertyManager
protected DDL<T> finish(DDLOptions options, DDL<T> ddl)
options
- the options for the current generationddl
- the ddl we've generated and are about to returnpublic boolean supportsAction(java.lang.String type, PropertyAction.Type actionType)
PropertyManager
supportsAction
in interface PropertyManager
protected boolean canChangeWithAlter(DBObject orig, DBObject update, java.lang.String prop)
AbstractPropertyManager
canChangeWithAlter
in class AbstractPropertyManager
public final DDL<T> getCreateDDL(DDLOptions options, DBObject... objects)
DDLGenerator
getCreateDDL
in interface DDLGenerator<T extends DDLType>
public final DDL<T> getDeleteDDL(DDLOptions options, DBObject... objects)
DDLGenerator
getDeleteDDL
in interface DDLGenerator<T extends DDLType>
public final DDL<T> getUpdateDDL(DDLOptions options, Difference resultSet)
DDLGenerator
getUpdateDDL
in interface DDLGenerator<T extends DDLType>
protected final void processResultSet(DDLOptions options, Difference rs, DDL<T> ddl)
@Deprecated
public final Ddl getCreateDDL(SchemaObject obj,
boolean replace,
boolean cascade)
@Deprecated
public final Ddl getCreateDDL(SchemaObject[] objects,
boolean replace,
boolean cascade)
@Deprecated
public final Ddl getDeleteDDL(SchemaObject object,
boolean cascade)
@Deprecated
public final Ddl getDeleteDDL(SchemaObject[] objects,
boolean cascade)
@Deprecated
public final Ddl[] getUpdateDDL(SchemaObject oldObject,
SchemaObject newObject)
@Deprecated
public final Ddl[] getUpdateDDL(SchemaObject[] oldObjects,
SchemaObject[] newObjects)
@Deprecated
public final Ddl[] getUpdateDDL(Difference resultSet,
boolean replace,
boolean cascade)
@Deprecated
public final Ddl getCreateDDL(Schema schema)
@Deprecated
public final Ddl getDeleteDDL(Schema schema,
boolean cascade)
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.9.0) E52944-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |