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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OfflineDBObjectFactory.IDScheme Deprecated.

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

Methods

Modifier and Type	Method and Description
void	ensureID(java.util.Collection<? extends DBObject> objs, Difference rs) Checks that the given objects have an ID.
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.
DBObjectID	ensureID(DBObject obj, boolean deep, boolean forceNames) Same as ensureID(DBObject,boolean) but optionally specify that this is only a load operation and therefore heavier ID processing (such as updating the name information in the IDs) can be skipped.
protected DBObjectID	findParentID(DBObjectID parentID)
FKConstraint	newFKConstraint(java.lang.String name, Relation parent) Deprecated. as of 11.1.1 call newObject(FKConstraint.class, parent) 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.
IdentifierBasedID	newID(java.lang.String type) Deprecated.
DBObjectID	newID(java.lang.String type, IdentifierBasedID parent) Deprecated.
PKConstraint	newPKConstraint(java.lang.String name, Relation parent) Deprecated. as of 11.1.1 call newObject(PKConstraint.class, parent) instead
UniqueConstraint	newUniqueConstraint(java.lang.String name, Relation parent) Deprecated. as of 11.1.1 call newObject(UniqueConstraint.class, parent) instead

Methods inherited from class oracle.javatools.db.DBObjectFactory

createID, ensureBaseInfo, ensureDerivedPropertyBuilder, ensureProvider, ensureSchema, getExternalDefaultValue, getInitialValue, getLogger, getName, getObjectID, getProvider, isValidID, 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

@Deprecated
public IdentifierBasedID newID(java.lang.String type)

Deprecated.

Returns a DBObjectID for the given object type setup for the offline database provider this factory is associated with.

newID

@Deprecated
public DBObjectID newID(java.lang.String type,
                          IdentifierBasedID parent)

Deprecated.

Returns a DBObjectID for the given object type and parent set up for the offline database provider this factory is associated with.

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.

newUniqueConstraint

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

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

newFKConstraint

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

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

newPKConstraint

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

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

ensureID

public DBObjectID ensureID(DBObject obj)

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

ensureID

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

Checks that the given objects have an ID. AUTOMATICALLY RECURSES TO THE OBJECT'S CHILDREN.

For internal use only. Application developers should not use this

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

ensureID

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

Same as ensureID(DBObject,boolean) but optionally specify that this is only a load operation and therefore heavier ID processing (such as updating the name information in the IDs) can be skipped.

Overrides:

ensureID in class DBObjectFactory

Parameters:

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

deep - 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

findParentID

protected DBObjectID findParentID(DBObjectID parentID)

Overrides:

findParentID in class DBObjectFactory