oracle.javatools.db.property

Class DerivedPropertyBuilder<T extends AbstractBuildableObject>

java.lang.Object

oracle.javatools.db.AbstractDBObjectBuilder<T>

oracle.javatools.db.property.DerivedPropertyBuilder<T>

All Implemented Interfaces:

DBObjectBuilder<T>

Direct Known Subclasses:

AbstractSQLQueryBuilder

public abstract class DerivedPropertyBuilder<T extends AbstractBuildableObject>
extends AbstractDBObjectBuilder<T>

Abstract implementation of DBObjectBuilder specifically for the building of derived properties. Subclasses should annotate a build method with the PropertyBuilder annotation to facilitate building.

Since:

12

Nested Class Summary

Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObjectBuilder

AbstractDBObjectBuilder.PropertyBuilder

Field Summary

Fields inherited from interface oracle.javatools.db.DBObjectBuilder

BASE_COMPONENT_KEY

Constructor Summary

Constructors

Constructor and Description
DerivedPropertyBuilder(AbstractDBObjectProvider pro, java.lang.String type) Creates a new derived property builder.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	canBuildComponents() Returns false by default.
java.util.Collection<java.lang.String>	clearDerivedProperties(T obj, java.lang.String property, DBObjectChange change) Clears the properties that are derived from the given property and that need resetting given the new value for the source property.
T	createObject(java.lang.String name, Schema schema, DBObjectID id) Requests the creation of a new SchemaObject of the type built by this DBObjectBuilder instance.
protected void	registerObject(T object) Shared between buildObject and buildObjects to perform any post-build tasks that are needed (e.g.

Methods inherited from class oracle.javatools.db.AbstractDBObjectBuilder

buildObject, buildObjectComponent, canBuildEditableObject, ensureComponent, fillInObject, fillInObjectComponent, findObjectInProviderCache, findObjectInProviderCache, getBuiltProperties, getDerivedProperties, getLogger, getObjectType, getProvider, getSchema, isBuildableProperty, markAsBuilt, markAsBuilt, needsBuilding, needsBuilding, newObject, newObject, updateTimestamp, updateTimestamp

Methods inherited from class java.lang.Object

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

Constructor Detail

DerivedPropertyBuilder

public DerivedPropertyBuilder(AbstractDBObjectProvider pro,
                      java.lang.String type)

Creates a new derived property builder.

Parameters:

pro - the containing provider

type - the type of object that is built by this builder (e.g. Table.TYPE)

Method Detail

clearDerivedProperties

public java.util.Collection<java.lang.String> clearDerivedProperties(T obj,
                                                            java.lang.String property,
                                                            DBObjectChange change)

Clears the properties that are derived from the given property and that need resetting given the new value for the source property.

Parameters:

obj - the object the property is being changed on

property - the property being changed

change - the overall change that is occuring

Returns:

the properties that are derived from the given property, and were cleared.

canBuildComponents

protected final boolean canBuildComponents()

Description copied from class: AbstractDBObjectBuilder

Returns false by default. Override to enable building by component in this builder. Once enabled, component building is supported by the use of methods annotated with the AbstractDBObjectBuilder.PropertyBuilder annotation.

Overrides:

canBuildComponents in class AbstractDBObjectBuilder<T extends AbstractBuildableObject>

createObject

public final T createObject(java.lang.String name,
             Schema schema,
             DBObjectID id)

Description copied from interface: DBObjectBuilder

Requests the creation of a new SchemaObject of the type built by this DBObjectBuilder instance.

Specified by:

createObject in interface DBObjectBuilder<T extends AbstractBuildableObject>

Overrides:

createObject in class AbstractDBObjectBuilder<T extends AbstractBuildableObject>

Parameters:

name - The name of the new object

schema - The schema containing the new object

id - the DBObjectID for the new object

Returns:

The newly created object

registerObject

protected void registerObject(T object)
                       throws DBException

Description copied from class: AbstractDBObjectBuilder

Shared between buildObject and buildObjects to perform any post-build tasks that are needed (e.g. timestamping, registration with the object manager etc. Really we should try and do this for multiple objects at once as well but the timestamping work isn't easy to change that too so for now we'll stick with one at a time.

Overrides:

registerObject in class AbstractDBObjectBuilder<T extends AbstractBuildableObject>

Throws:

DBException