oracle.jdeveloper.offlinedb

Class OfflineDBObjectFactory

java.lang.Object

oracle.javatools.db.DBObjectFactory

oracle.jdeveloper.offlinedb.OfflineDBObjectFactory

public class OfflineDBObjectFactory
extends DBObjectFactory

Factory class with methods for creating DBObjects for use in the offline API. All new objects are given appropriate offline object ids.

Individual methods, rather than a generic newDBObject() method that uses reflection, are given to give type safety to API user code, and to make it a bit quicker as well.

Constructor Summary

Constructors

Constructor and Description
OfflineDBObjectFactory(OfflineDBObjectProvider pro) Constructor has package level access as API users should retrieve a factory from the provider, and not instantiate their own.

Method Summary

Modifier and Type	Method and Description
DBObjectID	ensureID(DBObject obj) Checks that the given object has an ID.
DBObjectID	ensureID(DBObject obj, boolean deep) Checks that the given object has an ID.
FKConstraint	newFKConstraint(java.lang.String name, Relation parent) Deprecated. as of 11.1.1 call newObject(FKConstraint.class, parent, name) instead
BaseObjectID	newID(DBObject obj) Creates a new ID for the given object and sets it too.
BaseObjectID	newID(DBObject obj, DBObjectID parent) Creates a new ID for the given object and sets it too.
PKConstraint	newPKConstraint(java.lang.String name, Relation parent) Deprecated. as of 11.1.1 call newObject(PKConstraint.class, parent, name) instead
UniqueConstraint	newUniqueConstraint(java.lang.String name, Relation parent) Deprecated. as of 11.1.1 call newObject(UniqueConstraint.class, parent, name) instead
protected boolean	useIdentifierBasedIDs(DBObject obj) Returns true if the given object should be given an IdentifierBasedID rather than a NameBasedID by the default DBObjectFactory.createID(oracle.javatools.db.DBObject) implementation.

Methods inherited from class oracle.javatools.db.DBObjectFactory

createID, createID, ensureBaseInfo, ensureDerivedPropertyBuilder, ensureDerivedPropertyBuilder, ensureID, ensureIDs, ensureProvider, ensureSchema, getExternalDefaultValue, getInitialValue, getLogger, getName, getObjectID, getProvider, getReferenceIDs, isValidID, newObject, newObject, newObject, newObject, newObject, newObject, newObject, setDerivedPropertyBuilder

Methods inherited from class java.lang.Object

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

Constructor Detail

OfflineDBObjectFactory

public OfflineDBObjectFactory(OfflineDBObjectProvider pro)

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

Method Detail

newID

public BaseObjectID newID(DBObject obj)

Creates a new ID for the given object and sets it too. Will overwrite any existing ID.

newID

public BaseObjectID newID(DBObject obj,
                          DBObjectID parent)

Creates a new ID for the given object and sets it too. Will overwrite any existing ID.

useIdentifierBasedIDs

protected boolean useIdentifierBasedIDs(DBObject obj)

Description copied from class: DBObjectFactory

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

Overrides:

useIdentifierBasedIDs in class DBObjectFactory

Parameters:

obj - the object that needs a new id

Returns:

whether to use an IdentifierBasedID

newUniqueConstraint

@Deprecated
public UniqueConstraint newUniqueConstraint(java.lang.String name,
                                                        Relation parent)

Deprecated. as of 11.1.1 call newObject(UniqueConstraint.class, parent, name) instead

newFKConstraint

@Deprecated
public FKConstraint newFKConstraint(java.lang.String name,
                                                Relation parent)

Deprecated. as of 11.1.1 call newObject(FKConstraint.class, parent, name) instead

newPKConstraint

@Deprecated
public PKConstraint newPKConstraint(java.lang.String name,
                                                Relation parent)

Deprecated. as of 11.1.1 call newObject(PKConstraint.class, parent, name) instead

ensureID

public DBObjectID ensureID(DBObject obj)

Checks that the given object has an ID. Does not check an object's children.

ensureID

public DBObjectID ensureID(DBObject obj,
                           boolean deep)

Checks that the given object has an ID. Will optionally recurse to any child objects to check them as well.
1) check that any parent is correctly setup with an ID
2) check that the object's ID is valid
3) check that any reference IDs are valid (e.g. FK, Synonym)
4) optionally recurse to child objects
Returns null if the object is a sql fragment