Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.4.0)

E13403-05

oracle.javatools.db
Class AbstractBuildableObject

java.lang.Object
  extended by oracle.javatools.db.AbstractDBObject
      extended by oracle.javatools.db.AbstractBuildableObject
All Implemented Interfaces:
DBObject, SystemObject, Copyable, DynamicPropertySet
Direct Known Subclasses:
AbstractSystemObject

public abstract class AbstractBuildableObject
extends AbstractDBObject
implements SystemObject

Provides methods for lazy loading and building AbstractDBObjects. This has been abstracted from AbstractSchemaObject.

Since:
11.1.1.2.0

Nested Class Summary
 
Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject
AbstractDBObject.ChildSupport
 
Field Summary
 
Fields inherited from interface oracle.javatools.db.DBObject
COMMENT
 
Constructor Summary
  AbstractBuildableObject()
           
protected AbstractBuildableObject(java.lang.String name, DBObjectID id)
          Constructs a new instance with the specified name and id.
 
Method Summary
protected  void checkInit()
          Checks that the whole object is initialized (built).
protected  void checkInit(java.lang.String prop)
          Checks that the given property has been built.
protected  void copyToImpl(AbstractDBObject copy, DBObject copyParent, IDPolicy idPolicy)
          Implementation method for making a copy of this object.
protected  boolean equalsImpl(AbstractDBObject target)
          Equals implementation for testing equality with another AbstractDBObject.
protected  void getOwnedObjectsImpl(java.util.Collection<DBObject> c, java.lang.String... types)
          Implementation first checks that the object has been built - then returns the collection from suprt.getOwnedObjectsImpl().
 java.util.Map getProperties()
          Returns null if no properties are set.
 java.lang.Object getProperty(java.lang.String prop)
          Retrieves the value associated with a property.
protected  void getReferenceIDsImpl(java.util.Collection<DBObjectID> refs)
          Implementation first checks that the object has been built - then returns the collection from suprt.getReferenceIDsImpl().
protected  boolean needsInitialization()
          Checks if there is still a DBObjectBuilder registered against this object, identifying that it is not yet fully built.
 void setProperty(java.lang.String prop, java.lang.Object value)
          Sets the value for a property.
 
Methods inherited from class oracle.javatools.db.AbstractDBObject
changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, findOwnedObject, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeThisAsParent, replaceReferenceIDs, setID, setName, setProperties, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface oracle.javatools.db.SystemObject
addObjectListener, fireObjectUpdated, removeObjectListener
 
Methods inherited from interface oracle.javatools.db.DBObject
copyTo, copyTo, copyTo, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getParent, getReferenceIDs, getType, replaceReferenceIDs, setID, setName
 
Methods inherited from interface oracle.javatools.util.DynamicPropertySet
getProperty, setProperties
 

Constructor Detail

AbstractBuildableObject

public AbstractBuildableObject()

AbstractBuildableObject

protected AbstractBuildableObject(java.lang.String name,
                                  DBObjectID id)
Constructs a new instance with the specified name and id.

Parameters:
name - a string representing the name of this object.
id - the id for this object.
Method Detail

needsInitialization

protected boolean needsInitialization()
Checks if there is still a DBObjectBuilder registered against this object, identifying that it is not yet fully built.


checkInit

protected void checkInit(java.lang.String prop)
Checks that the given property has been built. If prop is null the entire object is built.


checkInit

protected void checkInit()
Checks that the whole object is initialized (built).


getProperties

public java.util.Map getProperties()
Description copied from class: AbstractDBObject
Returns null if no properties are set.

Specified by:
getProperties in interface DynamicPropertySet
Overrides:
getProperties in class AbstractDBObject

getProperty

public java.lang.Object getProperty(java.lang.String prop)
Description copied from interface: DynamicPropertySet
Retrieves the value associated with a property.

Specified by:
getProperty in interface DynamicPropertySet
Overrides:
getProperty in class AbstractDBObject
Parameters:
prop - the property key for which a value is desired. exists.
Returns:
the value of the requested property, or a null value if the property does not exist or is not set.

setProperty

public void setProperty(java.lang.String prop,
                        java.lang.Object value)
Description copied from interface: DynamicPropertySet
Sets the value for a property. Setting a value to null removes that property.

Specified by:
setProperty in interface DynamicPropertySet
Overrides:
setProperty in class AbstractDBObject
Parameters:
prop - the property key to set
value - the value to set

getOwnedObjectsImpl

protected void getOwnedObjectsImpl(java.util.Collection<DBObject> c,
                                   java.lang.String... types)
Implementation first checks that the object has been built - then returns the collection from suprt.getOwnedObjectsImpl(). All overrides must call this first to ensure the object has been built.

Overrides:
getOwnedObjectsImpl in class AbstractDBObject
Parameters:
c - a Collection of the apppropriate children.
types - a vararg of the type(s) to search for
See Also:
AbstractDBObject.includesType(java.lang.String, java.lang.String...)

getReferenceIDsImpl

protected void getReferenceIDsImpl(java.util.Collection<DBObjectID> refs)
Implementation first checks that the object has been built - then returns the collection from suprt.getReferenceIDsImpl(). All overrides must call this first to ensure the object has been built.

Overrides:
getReferenceIDsImpl in class AbstractDBObject
Parameters:
refs - the collection of ids this object references

copyToImpl

protected void copyToImpl(AbstractDBObject copy,
                          DBObject copyParent,
                          IDPolicy idPolicy)
Description copied from class: AbstractDBObject
Implementation method for making a copy of this object. To add custom copyTo logic, a subclass must override this method (exactly), and must call back to the super implementation.

Overrides:
copyToImpl in class AbstractDBObject
Parameters:
copy - the copy being created of this object
copyParent - if this object is being copied underneath a parent, this parameter is the copy of the parent of this object, which will therefore need to be the parent of the copy of this object.
idPolicy - the policy for copying the object's ID.

equalsImpl

protected boolean equalsImpl(AbstractDBObject target)
Description copied from class: AbstractDBObject
Equals implementation for testing equality with another AbstractDBObject. Override this method (with exact signature) to customise the equality comparison.

Overrides:
equalsImpl in class AbstractDBObject

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.4.0)

E13403-05

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