|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.5.0) E13403-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.javatools.db.AbstractDBObjectBuilder<T>
public abstract class AbstractDBObjectBuilder<T extends AbstractBuildableObject>
Abstract implementation of DBObjectbuilder that provides core support for component building of objects.
Nested Class Summary | |
---|---|
static interface |
AbstractDBObjectBuilder.PropertyBuilder Annotation to mark methods that build components (properties) of a given object within this builder. |
Field Summary |
---|
Fields inherited from interface oracle.javatools.db.DBObjectBuilder |
---|
BASE_COMPONENT_KEY |
Constructor Summary | |
---|---|
protected |
AbstractDBObjectBuilder(AbstractDBObjectProvider pro, java.lang.String type) |
Method Summary | |
---|---|
void |
buildObject(T object) Requests that the specified object be completed. |
void |
buildObjectComponent(T object, java.lang.String key) Uses canBuildComponents() to work out whether this builder can build just the given (key) subcomponent. |
protected boolean |
canBuildComponents() Returns false by default. |
abstract 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 |
ensureComponent(T obj, java.lang.String key) Ensures that the given component has been built. |
protected void |
fillInObject(T object) Fills in the entire object definition - i.e. |
protected void |
fillInObjectComponent(T object, java.lang.String key) Builds the whole object by default. |
protected java.lang.String |
getObjectType() |
protected AbstractDBObjectProvider |
getProvider() |
protected Schema |
getSchema(java.lang.String name) Gets the schema with the given name from the underlying provider. |
protected boolean |
isBuildableProperty(java.lang.String key) If this returns false, it means that the given property should not trigger any kind of build on the object. |
protected void |
markAsBuilt(T obj) |
protected boolean |
needsBuilding(T obj, java.lang.String key) Returns true if the given subcomponent of the object hasn't been explicitly built yet. |
boolean |
needsBuilding(T obj, java.lang.String key, boolean checkBuilder) Checks whether the given component key on the given object needs building and optionally includes a check as to whether the object has been completely built already. |
protected void |
registerObject(T object) Shared between buildObject and buildObjects to perform any post-build tasks that are needed (e.g. |
protected void |
updateTimestamp(DBObject object) Sets the timestamp of the given object if the underyling DBObjectProvide supports timestamping. |
protected void |
updateTimestamp(DBObject object, boolean force) |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected AbstractDBObjectBuilder(AbstractDBObjectProvider pro, java.lang.String type)
Method Detail |
---|
protected final java.lang.String getObjectType()
protected final AbstractDBObjectProvider getProvider()
protected final Schema getSchema(java.lang.String name) throws DBException
DBException
public abstract T createObject(java.lang.String name, Schema schema, DBObjectID id)
DBObjectBuilder
DBObjectBuilder
instance.createObject
in interface DBObjectBuilder<T extends AbstractBuildableObject>
name
- The name of the new objectschema
- The schema containing the new objectid
- the DBObjectID for the new objectpublic final void buildObject(T object) throws DBException
DBObjectBuilder
buildObject
in interface DBObjectBuilder<T extends AbstractBuildableObject>
object
- The object needing buildingDBException
- if an error occurs trying to build the objectprotected void fillInObject(T object) throws DBException
object
- the object to fill inDBException
protected void registerObject(T object) throws DBException
DBException
protected final void updateTimestamp(DBObject object) throws DBException
DBException
protected final void updateTimestamp(DBObject object, boolean force) throws DBException
DBException
protected final boolean needsBuilding(T obj, java.lang.String key)
#needsBuilding(T,String,boolean)
public final boolean needsBuilding(T obj, java.lang.String key, boolean checkBuilder)
protected final void markAsBuilt(T obj)
protected final void ensureComponent(T obj, java.lang.String key) throws DBException
DBException
public final void buildObjectComponent(T object, java.lang.String key) throws DBException
buildObjectComponent
in interface DBObjectBuilder<T extends AbstractBuildableObject>
DBException
protected final void fillInObjectComponent(T object, java.lang.String key) throws DBException
DBException
protected boolean canBuildComponents()
AbstractDBObjectBuilder.PropertyBuilder
annotation.protected boolean isBuildableProperty(java.lang.String key)
key
- the property key for component building
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.5.0) E13403-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |