oracle.javatools.db

Class DBObjectFactory

java.lang.Object

oracle.javatools.db.DBObjectFactory

Direct Known Subclasses:

OfflineDBObjectFactory

public class DBObjectFactory
extends java.lang.Object

Factory to control the creation of SchemaObjects and ChildDBObjects which may be based on templates and/or have the initial values of properties defined by PropertyInitializers.

The DBObjectFactory supports all SchemaObjects and the following ChildDBObject types

• Column
• PKConstraint
• UniqueConstraint
• FKConstraint
• CheckConstraint
• Index
• TablePartition
• IndexPartition

Since:

11.1.1.2.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DBObjectFactory(DBObjectProvider pro) Constructor has protected access as API users should retrieve a factory from the provider, and not instantiate their own.

Method Summary

Methods

Modifier and Type	Method and Description
protected BaseObjectID	createID(DBObject obj) Creates a new BaseObjectID for the given object.
protected BaseObjectID	createID(DBObject obj, DBObjectID parent) Creates a new BaseObjectID for the given object.
protected void	ensureBaseInfo(BaseObjectID id, DBObject obj, boolean forceName)
DerivedPropertyBuilder	ensureDerivedPropertyBuilder(DBObject obj) If the given object is buildable, and the provider has a derived property builder for that class of object then this will ensure that the object has a derived property builder set from this factory's provider.
DBObjectID	ensureID(DBObject obj, boolean recurse, boolean forceNames) Checks that the given object has an ID that is set up for the factory's provider.
void	ensureIDs(java.util.Collection<? extends DBObject> objs, Difference diff) Checks that all of the given objects that are part of a transaction have an ID that is set up for the factory's provider.
void	ensureProvider(DBObjectID id) Initialises the given id's provider to be the factory's provider if it wasn't already set.
void	ensureSchema(SchemaObject obj) Ensures that the given object's Schema is the same instance that the provider has, and not a copy, or separate instance with the same name.
java.lang.Object	getExternalDefaultValue(DBObject obj, java.lang.String propertyName) Deprecated. replaced by PropertyManager.getImplicitDefaultValue(oracle.javatools.db.DBObject, java.lang.String)
java.lang.Object	getInitialValue(DBObject obj, java.lang.String propertyName)
protected java.util.logging.Logger	getLogger()
protected java.lang.String	getName(DBObject obj, boolean forceNames)
protected DBObjectID	getObjectID(DBObject obj) As an object's ID should be immutable, DBObject.getID() returns a copy of the underlying ID.
protected DBObjectProvider	getProvider()
protected java.util.Collection<DBObjectID>	getReferenceIDs(DBObject obj) Gets the existing referenceIDs for the given object without building any properties that are yet to be built.
protected boolean	isValidID(DBObjectID id)
<T extends DBObject> T	newObject(java.lang.Class<T> clz) Creates a new DBObject of the specified class using the default template if one exists, and with properties initialized according to all registered PropertyInitializers.
<T extends DBObject> T	newObject(java.lang.Class<T> clz, DBObject parent) Creates a new DBObject of the specified class using the default template if one exists, and with properties initialized according to all registered PropertyInitializers.
<T extends DBObject> T	newObject(java.lang.Class<T> clz, DBObject parent, boolean useDefaultTemplate) Creates a new DBObject of the specified class optionally using the default template if one exists, and with properties initialized according to all registered PropertyInitializers.
<T extends DBObject> T	newObject(java.lang.Class<T> clz, DBObject parent, boolean useDefaultTemplate, boolean initialiseProperties) Creates a new DBObject of the specified class optionally using the default template if one exists, and with properties initialized according to all registered PropertyInitializers.
<T extends DBObject> T	newObject(T template) Creates a new object using the given template with properties initialized according to all registered PropertyInitializers,
<T extends DBObject> T	newObject(T template, DBObject parent) Creates a new object using the given template with properties initialized according to all registered PropertyInitializers,
<T extends AbstractBuildableObject> boolean	setDerivedPropertyBuilder(T obj, DerivedPropertyBuilder<? super T> builder) Attempts to set a DerivedPropertyBuilder implementation on the given object.
protected boolean	useIdentifierBasedIDs(DBObject obj) Returns true if the given object should be given an IdentifierBasedID rather than a NameBasedID by the default createID(oracle.javatools.db.DBObject) implementation.

Methods inherited from class java.lang.Object

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

Constructor Detail

DBObjectFactory

protected DBObjectFactory(DBObjectProvider pro)

Constructor has protected access as API users should retrieve a factory from the provider, and not instantiate their own.

Method Detail

getProvider

protected final DBObjectProvider getProvider()

Returns:

the current DBObjectProvider

getLogger

protected java.util.logging.Logger getLogger()

newObject

public <T extends DBObject> T newObject(T template)

Creates a new object using the given template with properties initialized according to all registered PropertyInitializers,

Returns:

the new object, or null if an object of that class cannot be instantiated.

newObject

public <T extends DBObject> T newObject(T template,
                               DBObject parent)

Creates a new object using the given template with properties initialized according to all registered PropertyInitializers,

Parameters:

template - the template to use for the new object

parent - the parent of the new object - e.g. a Schema for a new Sequence, a Table for a new column etc.

Returns:

the new object, or null if an object of that class cannot be instantiated.

newObject

public <T extends DBObject> T newObject(java.lang.Class<T> clz)

Creates a new DBObject of the specified class using the default template if one exists, and with properties initialized according to all registered PropertyInitializers.

Parameters:

clz - the class of object to create

Returns:

the new DBObject, or null if an object of that class cannot be instantiated.

newObject

public <T extends DBObject> T newObject(java.lang.Class<T> clz,
                               DBObject parent)

Creates a new DBObject of the specified class using the default template if one exists, and with properties initialized according to all registered PropertyInitializers.

Parameters:

clz - the class of object to create

parent - the parent of the new object - e.g. a Schema for a new Sequence, a Table for a new column etc.

Returns:

the new DBObject, or null if an object of that class cannot be instantiated.

newObject

public <T extends DBObject> T newObject(java.lang.Class<T> clz,
                               DBObject parent,
                               boolean useDefaultTemplate)

Creates a new DBObject of the specified class optionally using the default template if one exists, and with properties initialized according to all registered PropertyInitializers.

Parameters:

clz - the class of object to create

parent - the parent of the new object - e.g. a Schema for a new Sequence, a Table for a new column etc.

useDefaultTemplate - whether to use the default template from the provider for the given object type (if such a template is registered)

Returns:

the new DBObject, or null if an object of that class cannot be instantiated.

newObject

public <T extends DBObject> T newObject(java.lang.Class<T> clz,
                               DBObject parent,
                               boolean useDefaultTemplate,
                               boolean initialiseProperties)

Creates a new DBObject of the specified class optionally using the default template if one exists, and with properties initialized according to all registered PropertyInitializers.

Parameters:

clz - the class of object to create

parent - the parent of the new object - e.g. a Schema for a new Sequence, a Table for a new column etc.

useDefaultTemplate - whether to use the default template from the provider for the given object type (if such a template is registered)

initialiseProperties - whether to run any registered PropertyInitializers from the underlying DatabaseDescriptor against the new object.

Returns:

the new DBObject, or null if an object of that class cannot be instantiated.

ensureDerivedPropertyBuilder

public final DerivedPropertyBuilder ensureDerivedPropertyBuilder(DBObject obj)

If the given object is buildable, and the provider has a derived property builder for that class of object then this will ensure that the object has a derived property builder set from this factory's provider.

Recurses to all existing owned objects in the hierarchy without building any extra properties.

Parameters:

obj - the object to ensure has a derived property builder

Returns:

the DerivedPropertyBuilder now set on obj, if it is buildable and has a derived builder defined for this provider. Child objects might have had a derived property builder set and this will still return null if the top object has no derived builder itself.

setDerivedPropertyBuilder

public <T extends AbstractBuildableObject> boolean setDerivedPropertyBuilder(T obj,
                                                                    DerivedPropertyBuilder<? super T> builder)

Attempts to set a DerivedPropertyBuilder implementation on the given object. A DerivedPropertyBuilder cannot be changed, and its provider must match this factory's provider, so this will return false if the builder could not be set/changed.

Parameters:

obj - the object to set the builder on.

builder - the DerivedPropertyBuilder implementation to set on the object.

Returns:

true if the builder was set, or if the given builder was already set as the object's builder.

getExternalDefaultValue

@Deprecated
public java.lang.Object getExternalDefaultValue(DBObject obj,
                                                  java.lang.String propertyName)

Deprecated. replaced by PropertyManager.getImplicitDefaultValue(oracle.javatools.db.DBObject, java.lang.String)

getInitialValue

public java.lang.Object getInitialValue(DBObject obj,
                               java.lang.String propertyName)

Returns:

the initial value of the given property on the given object using any registered PropertyInitializers

ensureSchema

public void ensureSchema(SchemaObject obj)

Ensures that the given object's Schema is the same instance that the provider has, and not a copy, or separate instance with the same name.

It is only anticipated that this method will be needed internally.

Parameters:

obj - the SchemaObject to check the Schema for

ensureIDs

public void ensureIDs(java.util.Collection<? extends DBObject> objs,
             Difference diff)

Checks that all of the given objects that are part of a transaction have an ID that is set up for the factory's provider. This automatically recurses to all child objects.

It is only anticipated that this method will be needed internally.

Parameters:

objs - the objects to ensure have valid IDs.

diff - the transaction difference the objects have come from.

Since:

12.1.3

For internal use only. Application developers should not use this

ensureID

public DBObjectID ensureID(DBObject obj,
                  boolean recurse,
                  boolean forceNames)

Checks that the given object has an ID that is set up for the factory's provider. This should only be called for existing objects (e.g. on a load operation) and should not be called for new objects that do not yet exist in the provider because the resulting ID will not resolve.

It is only anticipated that this method will be needed internally.

Parameters:

obj - the object to ensure has a valid ID for this factory's provider

recurse - whether to recurse and process the objects' child objects as well

forceNames - if true this will additionally set the name based information on identifier based IDs. This is a potentially more time consuming operation as it may require dependent objects to be loaded.

Returns:

the id that the given object now has

For internal use only. Application developers should not use this

isValidID

protected boolean isValidID(DBObjectID id)

useIdentifierBasedIDs

protected boolean useIdentifierBasedIDs(DBObject obj)

Returns true if the given object should be given an IdentifierBasedID rather than a NameBasedID by the default createID(oracle.javatools.db.DBObject) implementation.

Parameters:

obj - the object that needs a new id

Returns:

whether to use an IdentifierBasedID

createID

protected BaseObjectID createID(DBObject obj)

Creates a new BaseObjectID for the given object.

Parameters:

obj - the object that needs a new id

Returns:

a new id for the object

createID

protected BaseObjectID createID(DBObject obj,
                    DBObjectID parent)

Creates a new BaseObjectID for the given object.

Parameters:

obj - the object that needs a new id

Returns:

a new id for the object

ensureBaseInfo

protected void ensureBaseInfo(BaseObjectID id,
                  DBObject obj,
                  boolean forceName)

getName

protected final java.lang.String getName(DBObject obj,
                       boolean forceNames)

ensureProvider

public final void ensureProvider(DBObjectID id)

Initialises the given id's provider to be the factory's provider if it wasn't already set.

getObjectID

protected final DBObjectID getObjectID(DBObject obj)

As an object's ID should be immutable, DBObject.getID() returns a copy of the underlying ID. This method gets the actual ID of the object so that properties can be ensured on it without needing to reset it back on the object afterwards.

getReferenceIDs

protected final java.util.Collection<DBObjectID> getReferenceIDs(DBObject obj)

Gets the existing referenceIDs for the given object without building any properties that are yet to be built.

Parameters:

obj - the object to get any existing DBObjectID property values for

Returns:

the referencing property values