oracle.javatools.db

Class TemplateExpander

java.lang.Object

oracle.javatools.db.refactoring.UpdateProcessor

oracle.javatools.db.TemplateExpander

public class TemplateExpander
extends UpdateProcessor

An expander of schema objects that provides the Template support for a DBObjectProvider. Templates allow all new objects that are created to have a default set of properties and child objects based on an existing template object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TemplateExpander.Initialiser The template mechanism can be extended by Initialiser objects that can perform extra template work on newly templated objects before they're commited to the provider.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TEMPLATE_OBJECTID

Constructor Summary

Constructors

Constructor and Description
TemplateExpander()

Method Summary

Methods

Modifier and Type	Method and Description
static void	applySourceFromTemplate(PlSqlSourceObject object) Deprecated. Source is copied directly from the template with no modifications other than that defined by changes in the dialog.
static void	applySourceFromTemplate(PlSqlSourceObject template, PlSqlSourceObject object) Deprecated. Source is copied directly from the template with no modifications other than that defined by changes in the dialog.
java.util.Collection<java.lang.String>	getProcessorProperties(DBObjectProvider provider) Gets a list of the properties that exist only for this processor.
static java.lang.String	getTemplateObjectName(DBObject object)
static <T extends DBObject> T	initialiseObject(T template)
static boolean	isPendingObject(DBObject object)
boolean	onlyProcessesPrimaryUpdates() A "primary only" processor is only interested in primary updates.
void	processUpdate(DBObjectTransaction txn, Difference objDiff) Called by a DBObjectProvider during a create or update process.
static void	registerInitialiser(TemplateExpander.Initialiser ini)
static void	registerPropertiesToClear(java.lang.Class clearFromClass, java.util.ArrayList<java.lang.String> clearPropsList, boolean append) Deprecated. use registerPropertyToClear
static void	registerPropertyToClear(java.lang.Class clearFromClass, java.lang.String clearProperty)

Methods inherited from class oracle.javatools.db.refactoring.UpdateProcessor

getLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TEMPLATE_OBJECTID

public static final java.lang.String TEMPLATE_OBJECTID

See Also:

Constant Field Values

Constructor Detail

TemplateExpander

public TemplateExpander()

Method Detail

onlyProcessesPrimaryUpdates

public boolean onlyProcessesPrimaryUpdates()

Description copied from class: UpdateProcessor

A "primary only" processor is only interested in primary updates. If a secondary update occur during the processing phase (i.e. another update to an object already processed once) then these will not be passed to a "primary only" processor.

Overrides:

onlyProcessesPrimaryUpdates in class UpdateProcessor

Returns:

true if our processor need only be passed primary updates.

processUpdate

public void processUpdate(DBObjectTransaction txn,
                 Difference objDiff)

Description copied from class: UpdateProcessor

Called by a DBObjectProvider during a create or update process. The given Difference contains new and updated objects which can be "processed" to provide their full definitions before being "saved" in the underlying database etc.

Specified by:

processUpdate in class UpdateProcessor

Parameters:

txn - the overall transaction that is being performed

objDiff - the Difference of two SystemObjects to be processed

initialiseObject

public static final <T extends DBObject> T initialiseObject(T template)

isPendingObject

public static final boolean isPendingObject(DBObject object)

registerInitialiser

public static void registerInitialiser(TemplateExpander.Initialiser ini)

registerPropertyToClear

public static void registerPropertyToClear(java.lang.Class clearFromClass,
                           java.lang.String clearProperty)

registerPropertiesToClear

@Deprecated
public static void registerPropertiesToClear(java.lang.Class clearFromClass,
                                        java.util.ArrayList<java.lang.String> clearPropsList,
                                        boolean append)

Deprecated. use registerPropertyToClear

getTemplateObjectName

public static java.lang.String getTemplateObjectName(DBObject object)

applySourceFromTemplate

@Deprecated
public static void applySourceFromTemplate(PlSqlSourceObject object)

Deprecated. Source is copied directly from the template with no modifications other than that defined by changes in the dialog.

applySourceFromTemplate

@Deprecated
public static void applySourceFromTemplate(PlSqlSourceObject template,
                                      PlSqlSourceObject object)

Deprecated. Source is copied directly from the template with no modifications other than that defined by changes in the dialog.

getProcessorProperties

public java.util.Collection<java.lang.String> getProcessorProperties(DBObjectProvider provider)

Description copied from class: UpdateProcessor

Gets a list of the properties that exist only for this processor. If a property is used to trigger an UpdateProcessor, and that UpdateProcessor removes the property before the real update happens then it must return the property in this list so that processes outside of the provider can filter out these properties when needed.

Overrides:

getProcessorProperties in class UpdateProcessor