AbstractDBObjectProvider (Oracle Fusion Middleware Java API Reference for Oracle Extension SDK)

java.lang.Object
- oracle.javatools.db.AbstractDBObjectProvider

All Implemented Interfaces:

DBObjectProvider

Direct Known Subclasses:

AbstractDatabase, OfflineDBObjectProvider
```
public abstract class AbstractDBObjectProvider
extends java.lang.Object
implements DBObjectProvider
```
Provides a base implementation of the DBObjectProvider interface. AbstractDBObjectProvider provides support for registering DBObjectBuilder instances for building specific types of DBObjects. The list of builders is used to determine the types of objects supported by the DBObjectProvider implementation, to list the available objects of a specific type, and to retrieve the SchemaObject representations of the objects.
Subclasses are responsible for ensuring that DBObjectBuilder and DBObjectValidator instances are registered for the types of objects that will be supported. AbstractDBObjectProvider is abstract; sublasses are also responsible for providing implementations of those methods that do not have a generic implementation.
AbstractDBObjectProvider also handles caching of DBObject instances. When new instances are created, they are cached (optionally this caching is weak, that is specified by the constructor). Subsequent requests for the same metadata will result in the same DBObject instance being returned.

Since:

9.0.5

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CASE_SENSITIVE_NAME_POLICY` Both quoted and unquoted names are case sensitive, and kept internally in the original case used when they were defined.
`protected static java.lang.String[]`	`EMPTY_LIST`
`static int`	`LOWER_CASE_NAME_POLICY` Unquoted Names are case insensitive and converted to lower case internally.
`static int`	`MIXED_CASE_NAME_POLICY` Both quoted and unquoted names are case insensitive, and kept internally in the original case used when they were defined.
`static java.lang.String`	`NEW_FROM_TEMPLATE_TYPE`
`static java.lang.String`	`TIMESTAMP_PROPERTY` The timestamp of the object - i.e.
`static int`	`UPPER_CASE_NAME_POLICY` Unquoted Names are case insensitive and converted to upper case internally.

Fields inherited from interface oracle.javatools.db.DBObjectProvider
CREATE_PRIVILEDGE, DELETE_PRIVILEDGE, MODIFY_PRIVILEDGE

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractDBObjectProvider()` Create a new provider that uses normal (i.e not weak) caching for its objects.
`protected`	`AbstractDBObjectProvider(boolean weakCaching)` Creates a new provider specifing whether the caching of object instances should be weak or not.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addObjectListener(DBObjectListener list, DBObjectCriteria crit)` Adds a listener that is notified of any updates to objects that match the given criteria.
`void`	`addObjectListener(DBObjectListener list, DBObjectID id)` Adds a listener that is notified of any updates to the object represented by the given DBObjectID.
`void`	`addObjectListener(DBObjectListener list, SystemObject obj)` Adds a listener that is notified of any updates to the given object.
`void`	`addProviderListener(DBObjectProviderListener list)` Adds the given listener to the list of registered listener for events on this provider.
`void`	`addProviderListener(DBObjectProviderListener list)` Deprecated. use `addProviderListener(DBObjectProviderListener)`
`protected void`	`cacheObject(SystemObject object, boolean loadOperation)` Adds an object to the cache.
`void`	`canUpdate(Difference listDiff, boolean replace, boolean cascade)` Tests whether the given update can be performed.
`protected <T extends SystemObject> T`	`checkCachedObject(T object)` Use by getObjectImpl to verify that the given object in the cache is still valid.
`void`	`clearAllCaches()` Clears all cached information in this provider that has been loaded from the underlying database.
`void`	`commitTransaction(DBObjectTransaction txn)` Commits a transaction of object changes.
`protected abstract java.util.Collection<DBObjectChange>`	`commitTransaction(DBObjectTransaction txn, Difference listDiff)` Implement to commit the given transaction's difference.
`static java.lang.String`	`convertObject(DBObject obj)` Converts a DBObject into a String representation of the object name.
`void`	`createObject(SystemObject obj, boolean replace)` Causes the creation of the object described by the specified meta data.
`protected DBObjectFactory`	`createObjectFactory()` Called once to create a factory for creating objects, and ensuring IDs, etc in this provider.
`protected SchemaObjectManager`	`createObjectManager()` Creates the object manager for this provider.
`void`	`createSchema(Schema schema, boolean replace)` Causes the creation of a new Schema in the persistent storage.
`void`	`deleteObject(SystemObject obj, boolean cascade)` Deletes the object.
`void`	`deleteSchema(Schema schema, boolean cascade)` Deletes the schema.
`protected void`	`destroyCache()` Destroys the object cache.
`protected Difference`	`ensureSystemObjectListDifference(Difference diff)` Call this to ensure that the caller of an API method that takes a Difference of SystemObject[] objects has a correct Difference arg.
`protected SystemObject`	`findObject(DBObjectID id)` Looks for the specified object id in the cache.
`protected SystemObject`	`findObject(java.lang.String type, Schema schema, java.lang.String name)` Looks for the specified object in the cache.
`protected Schema`	`findSchema(java.lang.String name)` Method for use within the provider that retrieves a schema and doesn't check the database if the schema is found in the cache.
`protected void`	`fireObjectsAdded(java.util.Collection<? extends SystemObject> sysObjs)` Notifies all listeners that the given objects have been added to this provider.
`void`	`fireObjectsAdded(Schema schema, SchemaObject[] objs)` Deprecated. use `fireObjectsAdded(Collection)`
`protected void`	`fireObjectsRemoved(java.util.Collection<? extends SystemObject> sysObjs)` Notifies all listeners that the given objects have been removed from this provider.
`protected void`	`fireObjectsRemoved(Schema schema, SchemaObject[] objs)` Deprecated. use `fireObjectsRemoved(Collection)`
`protected void`	`fireObjectUpdated(DBObjectChange change)` Notifies all listeners of an update to a SystemObject.
`protected void`	`fireProviderClosed()` Fires a providerClosed event to all listeners.
`void`	`fireProviderDeleted()` Deprecated. with no replacement - the "provider deleted" event no longer exists.
`protected void`	`fireProviderOpened()` Fires a providerOpened event to all listeners.
`protected void`	`fireProviderReloaded()` Fires a providerReloaded event to all listeners.
`protected void`	`fireSchemaAdded(Schema schema)` Deprecated. use `fireObjectsAdded(Collection)`
`protected void`	`fireSchemaObjectUpdated(DBObjectChange change)` Deprecated. use `fireObjectUpdated(DBObjectChange)`
`protected void`	`fireSchemaRemoved(Schema schema)` Deprecated.
`protected void`	`fireSchemaUpdated(DBObjectChange change)` Deprecated. use `fireObjectUpdated(DBObjectChange)`
`protected DBObjectBuilder`	`getBuilderForType(java.lang.String type)` Retrieves the DBObjectBuilder registered for a type of object.
`protected java.lang.Object`	`getCachedTimestamp(java.lang.Object obj)` Use to check whether timestamps are suspended and that the given object is a key in the cache of timestamp values.
`SchemaObjectManager`	`getCascadeManager()` By default creates a SchemaObjectManager.
`protected int`	`getCasePolicy()` Retrieves the provider's case policy for unquoted names.
`DataType`	`getDataType(java.lang.String typeName)` Retrieves the datatype represented by a specific name.
`DDLGenerator`	`getDDLGenerator()` Gets the DDLGenerator for this provider.
`java.lang.String`	`getDefaultSchemaName(DatabaseLink link)` The default schema of a database link may be different from the username associated with that link.
`DBObject`	`getDefaultTemplateForType(java.lang.String type)` Returns the default template object for the given type, or null if none defined.
`java.lang.String`	`getDescription()` Gets a short description of the provider.
`DiffEngine`	`getDiffEngine()` Returns a diff engine setup with the appropriate set of differs for object updating.
`protected java.lang.Long`	`getExistingTimestamp(SystemObject object)`
`java.lang.String`	`getExternalName(java.lang.String name)` Converts the specified name into the format used externally to represent the identifier.
`java.lang.String`	`getExternalName(java.lang.String name, java.lang.String objectType)` Converts the specified name into the format used externally to represent the identifier.
`protected java.lang.Long`	`getExternalTimestamp(SystemObject object)`
`protected java.lang.Long`	`getExternalTimestampImpl(SystemObject object)` Retrieves the external timestamp for the specified object.
`java.lang.String`	`getIdentifierQuoteString()` Retrieves the string used to quote identifiers.
`java.lang.String`	`getInternalName(java.lang.String name)` Converts the specified name into the format used internally within the metadata.
`java.lang.String`	`getInternalName(java.lang.String name, java.lang.String objectType)` Converts the specified name into the format used internally within the metadata.
`protected java.util.logging.Logger`	`getLogger()` Gets the logger to use in this provider.
`<T extends SystemObject> T`	`getObject(DBObjectCriteria<T> criteria)` Retrieves the SystemObject representing a specific database object.
`SchemaObject`	`getObject(java.lang.String objectType, Schema schema, java.lang.String name)` Retrieves the SchemaObject representing a specific database object.
`DBObjectFactory`	`getObjectFactory()` Get the object factory for this provider.
`protected <T extends SystemObject> T`	`getObjectImpl(DBObjectCriteria<T> criteria)` getObject implementation for looking up a single object in the provider.
`SchemaObjectManager`	`getObjectManager()` Deprecated.
`DataType`	`getOrCreateDataType(java.lang.String typeName)` Gets (or creates) the datatype represented by a specific name.
`PropertyManager`	`getPropertyManager()` Gets the PropertyManager (if available) for this provider.
`protected int`	`getQuotedNameCasePolicy()` Deprecated. `getCasePolicy()` covers both quoted and unquoted names.
`Schema`	`getSchema(java.lang.String name)` Retrieves the Schema object associated with a specific name.
`SchemaObjectExpander[]`	`getSchemaObjectExpanders()` Deprecated.
`java.lang.Long`	`getTimestamp(DBObjectID id)` Retrieves the timestamp for the object represented by the given ID.
`java.lang.Long`	`getTimestamp(java.lang.String type, Schema schema, java.lang.String objectName)` Retrieves the timestamp representing the last modification time of the specified object's metadata.
`java.lang.String`	`getUniqueName(java.lang.String type, DBObject contextObject, java.lang.String base)` Returns a unique name for an object of given type within `contextObject` using `base` name.
`java.lang.String`	`getUniqueName(java.lang.String type, DBObject contextObject, java.lang.String base, java.util.Collection<java.lang.String> bannedNames)` Returns a unique name for an object of given type within `contextObject` using `base` name.
`protected boolean`	`getUniqueNameTreatIndexAsSchemaObject()` Deprecated. this limited mechanism has been superceeded by `DBObjectValidator#getNamespaceType`
`DBObjectValidator`	`getValidatorForType(java.lang.String type)` Retrieves the DBObjectValidator registered for a type of object.
`boolean`	`hasObjectPrivilege(SystemObject object, java.lang.String priv)` Checks to see whether the user has the requisite permissions to perform the specified operation on the given object.
`boolean`	`hasPriviledge(java.lang.String type, Schema schema, java.lang.String priv)` Deprecated. - use `hasSystemPrivilege(java.lang.String, oracle.javatools.db.Schema, java.lang.String)`
`boolean`	`hasSystemPrivilege(java.lang.String type, Schema schema, java.lang.String priv)` Checks to see whether the user has the requisite permissions to perform the specified operation.
`boolean`	`isClosed()` Tests whether the provider has been closed (e.g.
`boolean`	`isEditable(DBObject object)` Tests whether or not the object can be edited.
`boolean`	`isNewFromTemplateType(java.lang.String type)` Test whether the given type is the pseudo type used for new objects that are being created from a template.
`protected boolean`	`isRequestedObject(SystemObject object, java.lang.String type, Schema schema, java.lang.String name)` Deprecated. no longer called - use `isRequestedObject(SystemObject,DBObjectCriteria)`.
`protected <T extends SystemObject> boolean`	`isRequestedObject(T object, DBObjectCriteria<T> criteria)` Checks whether the object that has been returned by a list operation matches the given criteria.
`boolean`	`isValidName(java.lang.String name)` Deprecated. - use isValidName( String type, String name )
`boolean`	`isValidName(java.lang.String type, java.lang.String name)` Checks to see whether a name is valid.
`<T extends SystemObject> java.util.Collection<T>`	`listObjects(DBObjectCriteria<T> criteria)` Lists the objects from this provider that match the given criteria.
`SchemaObject[]`	`listObjects(java.lang.String[] objectTypes, Schema schema)` Lists the objects of multiple types available from this provider.
`SchemaObject[]`	`listObjects(java.lang.String[] objectTypes, Schema schema, java.lang.String ref)` Lists the objects of multiple types available from this provider.
`java.lang.String[]`	`listObjects(java.lang.String objectType, Schema schema)` Lists the objects of a given type available from this provider.
`java.lang.String[]`	`listObjects(java.lang.String objectType, Schema schema, java.lang.String ref)` Lists the objects of a given type available from this provider.
`protected <T extends SystemObject> java.util.Collection<T>`	`listObjectsFromCache(DBObjectCriteria<T> criteria)` Lists the objects that are in the internal memory cache for this provider.
`protected abstract <T extends SystemObject> java.util.Collection<T>`	`listObjectsImpl(DBObjectCriteria<T> criteria)` Internal listObjects implementation.
`protected java.util.Collection<SystemObject>`	`listObjectsImpl(java.lang.String[] objectTypes, Schema schema, java.lang.String ref)` Deprecated. `listObjectsImpl(DBObjectCriteria)` is the list implementation. This method will be removed in a future release. If you override this method it will not be called.
`protected java.lang.String[]`	`listObjectsImpl(java.lang.String type, Schema schema, java.lang.String ref)` List implementation for listing only object names.
`java.lang.String[]`	`listObjectTypes()` Returns a sorted array of the object types supported in this provider.
`Schema[]`	`listSchemas()` Retrieves the list of schemas available from this provider regardless of their visibility to the user.
`Schema[]`	`listSchemas(boolean showAll)` Retrieves the list of schemas available from this provider.
`DataType[]`	`listSupportedDataTypes()` Retrieves the list of datatypes supported by this provider.
`protected SystemObject`	`loadObjectImpl(BaseObjectID id)` This is called when an id is resolved, and there is no object cached for it.
`protected <T extends SystemObject> T`	`loadObjectImpl(DBObjectCriteria<T> criteria)` Loads a SystemObject definition from the underlying metadata.
`protected SystemObject`	`loadObjectImpl(java.lang.String type, Schema schema, java.lang.String name)` Deprecated. no longer used - replaced by `loadObjectImpl(DBObjectCriteria)`
`protected void`	`logEvent(java.lang.String msg, java.lang.Object... params)` Use to log provider events.
`protected void`	`markForLazyInit(AbstractBuildableObject object)`
`protected void`	`markForLazyInit(AbstractBuildableObject object, DBObjectBuilder builder)`
`protected java.lang.String`	`normaliseType(java.lang.String type)`
`protected java.lang.Object`	`putCachedTimestampKey(java.lang.Object obj, java.lang.Object value)` Checks that timestamps are suspended, and if they are caches the given key and value in the timestamp cache.
`java.lang.String`	`quoteIdentifier(java.lang.String internalName, boolean force)` Determines if internalName needs quoting to make it a valid external name, and if so returns a quoted copy of it.
`protected void`	`registerBuilder(java.lang.String type, DBObjectBuilder builder)` Registers a Builder for a specific object type.
`protected void`	`registerSchemaObjectExpander(SchemaObjectExpander expander)` Deprecated.
`protected void`	`registerType(java.lang.String type, DBObjectBuilder builder, DBObjectValidator validator)` Registers a Builder and Validator for a specific object type.
`protected void`	`registerValidator(java.lang.String type, DBObjectValidator validator)` Registers a Validator for a specific object type.
`void`	`removeObjectListener(DBObjectListener list)` Removes the given object listener that had been added using `DBObjectProvider.addObjectListener(DBObjectListener,SystemObject)` or `DBObjectProvider.addObjectListener(DBObjectListener,DBObjectCriteria)`.
`void`	`removeProviderListener(DBObjectProviderListener list)` Removes the given listener from the list of registered listener for events on this provider.
`void`	`removeProviderListener(DBObjectProviderListener list)` Deprecated. use `removeProviderListener(DBObjectProviderListener)`
`protected DBObjectChange`	`resetObject(SystemObject object, SystemObject listed, java.lang.Long timestamp)` If it has been noticed that the timestamp has changed on an object, or we have updated it in the database, we want to turn it back into an object that needs building again.
`protected DBObjectChange`	`resetObject(SystemObject object, SystemObject listed, java.lang.Long timestamp, boolean updated)` If it has been noticed that the timestamp has changed on an object, or we have updated it in the database, we want to turn it back into an object that needs building again.
`protected DBObject`	`resolveID(DBObjectID id)` Finds an object that matches the given id.
`protected SystemObject`	`resolveIDImpl(BaseObjectID id)` Gets an object that is respresented by the given id.
`protected SystemObject`	`resolveReferenceID(ReferenceID id)` Resolves a given reference by trying to find an object with matching details.
`protected SystemObject`	`resolveUnspecifiedTypeID(ReferenceID id)` Resolves a given type-less reference by trying to find an object with matching name details.
`void`	`resumeTimestampQueries(java.lang.String key)` Resumes the calls to get the external timestamp for a given object.
`void`	`setDefaultTemplateForType(java.lang.String type, DBObject template)` Sets the default template object for the given type.
`boolean`	`supportsObjectType(java.lang.String type)` Convinience method to check whether this provider supports the given object type - i.e.
`boolean`	`supportsTimestamps()` Deprecated. replaced by `supportsTimestamps(String)`
`boolean`	`supportsTimestamps(java.lang.String objectType)` Returns true if this provider supports object timestamping for the given object type.
`void`	`suspendTimestampQueries(java.lang.String key)` Limits the call to get the external timestamp for a given object to once until resumeTimestampQueries() is called.
`protected void`	`uncacheObject(SystemObject object)` Removes an object from the cache.
`void`	`updateObject(SystemObject oldObject, SystemObject newObject)` Updates the definition of an object.
`void`	`updateObjects(Difference listDiff, boolean replace, boolean cascade)` Updates the definition of a set of objects.
`void`	`updateObjects(SystemObject[] oldObjects, SystemObject[] newObjects)` Updates the definition of a set of objects.
`void`	`updateSchema(Schema oldSchema, Schema newSchema)` Updates the definition of a Schema.
`void`	`validateName(java.lang.String name)` Deprecated. - use validateName( String type, String name )
`void`	`validateName(java.lang.String type, java.lang.String name)` Final implementation delegates to the registered DBObjectValidator for the given type.
`void`	`validateObject(DBObject object)` Validates the given object using the DBObjectValidator registered against that object's type.
`void`	`validateObject(DBObject original, DBObject update)` Validates the given object update using the DBObjectValidator registered against that object's type.
`void`	`validateObject(DBObject original, DBObject update, java.lang.String property)` Deprecated.
`void`	`validateObject(DBObject object, java.lang.String property)` Deprecated.
`void`	`validateObjectProperty(DBObject original, DBObject updated, java.lang.Object property)` Deprecated.
`void`	`validateObjectProperty(DBObject original, DBObject update, java.lang.String property)` Checks to see if the updated children of a given object are valid.
`void`	`validateObjectProperty(DBObject object, java.lang.Object property)` Deprecated.
`void`	`validateObjectProperty(DBObject object, java.lang.String property)` Checks to see if the children of a given object are valid.
`void`	`validateSchema(Schema schema)` Deprecated. - use validateObject( DBObject object )
`void`	`validateSchema(Schema original, Schema update)` Deprecated. use validateObject( DBObject original, DBObject update )
`void`	`validateUniqueName(DBObject object, DBObject contextObject)` Validates that a name is not used within a context DBObject, and throws NameInUseException if it is.
`void`	`validateUniqueName(java.lang.String type, DBObject contextObject, java.lang.String name)` Validates that a name is not used within a context DBObject, and throws NameInUseException if it is.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.javatools.db.DBObjectProvider
canCreate, canDelete, createObjects, deleteObjects, getDefaultSchema, getDescriptor, getName, getProviderIdentifier, getProviderType, undeleteObject, undeleteObjects

- Field Detail
  - MIXED_CASE_NAME_POLICY
```
public static final int MIXED_CASE_NAME_POLICY
```
    Both quoted and unquoted names are case insensitive, and kept internally in the original case used when they were defined.
    
    See Also:
    Constant Field Values
  - LOWER_CASE_NAME_POLICY
```
public static final int LOWER_CASE_NAME_POLICY
```
    Unquoted Names are case insensitive and converted to lower case internally. Quoted names are case sensitive.
    
    See Also:
    Constant Field Values
  - UPPER_CASE_NAME_POLICY
```
public static final int UPPER_CASE_NAME_POLICY
```
    Unquoted Names are case insensitive and converted to upper case internally. Quoted names are case sensitive.
    
    See Also:
    Constant Field Values
  - CASE_SENSITIVE_NAME_POLICY
```
public static final int CASE_SENSITIVE_NAME_POLICY
```
    Both quoted and unquoted names are case sensitive, and kept internally in the original case used when they were defined.
    
    See Also:
    Constant Field Values
  - TIMESTAMP_PROPERTY
```
public static final java.lang.String TIMESTAMP_PROPERTY
```
    The timestamp of the object - i.e. the last time it was modified in the provider (database). Only used in provider implementations that suppport it. Must be a Long.
    
    See Also:
    Constant Field Values
  - NEW_FROM_TEMPLATE_TYPE
```
public static final java.lang.String NEW_FROM_TEMPLATE_TYPE
```
    See Also:
    Constant Field Values
  - EMPTY_LIST
```
protected static final java.lang.String[] EMPTY_LIST
```
- Constructor Detail
  - AbstractDBObjectProvider
```
protected AbstractDBObjectProvider()
```
    Create a new provider that uses normal (i.e not weak) caching for its objects.
  - AbstractDBObjectProvider
```
protected AbstractDBObjectProvider(boolean weakCaching)
```
    Creates a new provider specifing whether the caching of object instances should be weak or not.
    
    Parameters:
    weakCaching - if true cached DBObject implementations are held by a weak reference so that they are eligible for garbage collection.
- Method Detail
  - getDescription
```
public final java.lang.String getDescription()
```
    Description copied from interface: DBObjectProvider
    
    Gets a short description of the provider. For example for a Database with a connection name of "hr" this will return "database hr".
    
    Specified by:
    
    getDescription in interface DBObjectProvider
    
    Returns:
    a translated description displayable to the user
    See Also:
    DBObjectProviderFactory.getDescription(String,Object)
  - isClosed
```
public boolean isClosed()
```
    Tests whether the provider has been closed (e.g. Connection is closed). The default returns false, override as appropriate.
  - removeProviderListener
```
public final void removeProviderListener(DBObjectProviderListener list)
```
    Description copied from interface: DBObjectProvider
    
    Removes the given listener from the list of registered listener for events on this provider.
    
    Specified by:
    
    removeProviderListener in interface DBObjectProvider
    
    See Also:
    DBObjectProviderListener
  - removeProviderListener
```
@Deprecated
public final void removeProviderListener(DBObjectProviderListener list)
```
    Deprecated. use removeProviderListener(DBObjectProviderListener)
    
    Specified by:
    
    removeProviderListener in interface DBObjectProvider
  - addProviderListener
```
public final void addProviderListener(DBObjectProviderListener list)
```
    Description copied from interface: DBObjectProvider
    
    Adds the given listener to the list of registered listener for events on this provider.
    
    Specified by:
    
    addProviderListener in interface DBObjectProvider
    
    See Also:
    DBObjectProviderListener
  - addProviderListener
```
@Deprecated
public final void addProviderListener(DBObjectProviderListener list)
```
    Deprecated. use addProviderListener(DBObjectProviderListener)
    
    Specified by:
    
    addProviderListener in interface DBObjectProvider
  - addObjectListener
```
public final void addObjectListener(DBObjectListener list,
                     DBObjectCriteria crit)
```
    Description copied from interface: DBObjectProvider
    
    Adds a listener that is notified of any updates to objects that match the given criteria. If the given criteria is null, updates on all objects will be published to the given listener. The criteria will be copied on registration so that subsequent changes to it will not be reflected in this listener's registration.
    
    Specified by:
    
    addObjectListener in interface DBObjectProvider
    
    Parameters:
    list - the listener to register
    crit - a criteria object to use to match objects that update messages are published for
    See Also:
    DBObjectProvider.addObjectListener(DBObjectListener,SystemObject), DBObjectProvider.addObjectListener(DBObjectListener,DBObjectID)
  - addObjectListener
```
public final void addObjectListener(DBObjectListener list,
                     SystemObject obj)
```
    Description copied from interface: DBObjectProvider
    
    Adds a listener that is notified of any updates to the given object. The object must be from this provider, and have a valid DBObjectID.
    This mechanism differs from SystemObject.addObjectListener(DBObjectListener) because that listens to a specific object instance. Registering the listener with the provider through this method ensures that events will be received for the lifetime of the provider (as the particular object instance could be lost - e.g. gc'd).
    
    Specified by:
    
    addObjectListener in interface DBObjectProvider
    
    Parameters:
    list - the listener to register
    obj - the object to receive update events for
    See Also:
    DBObjectProvider.addObjectListener(DBObjectListener,DBObjectCriteria), DBObjectProvider.addObjectListener(DBObjectListener,DBObjectID)
  - addObjectListener
```
public final void addObjectListener(DBObjectListener list,
                     DBObjectID id)
```
    Description copied from interface: DBObjectProvider
    
    Adds a listener that is notified of any updates to the object represented by the given DBObjectID. The id must be for a system object type, you cannot listen to child objects (e.g. a column). To be notified of column changes, listen to the table.
    This mechanism differs from SystemObject.addObjectListener(DBObjectListener) because that listens to a specific object instance. Registering the listener with the provider through this method ensures that events will be received for the lifetime of the provider (as the particular object instance could be lost - e.g. gc'd).
    
    Specified by:
    
    addObjectListener in interface DBObjectProvider
    
    Parameters:
    list - the listener to register
    id - the id of obj the object to receive update events for
    See Also:
    DBObjectProvider.addObjectListener(DBObjectListener,DBObjectCriteria), DBObjectProvider.addObjectListener(DBObjectListener,SystemObject)
  - removeObjectListener
```
public final void removeObjectListener(DBObjectListener list)
```
    Description copied from interface: DBObjectProvider
    
    Removes the given object listener that had been added using DBObjectProvider.addObjectListener(DBObjectListener,SystemObject) or DBObjectProvider.addObjectListener(DBObjectListener,DBObjectCriteria).
    
    Specified by:
    
    removeObjectListener in interface DBObjectProvider
    
    Parameters:
    list - the registered listener to remove
  - getDefaultSchemaName
```
public java.lang.String getDefaultSchemaName(DatabaseLink link)
```
    The default schema of a database link may be different from the username associated with that link. This method will return the name of the default schema of the given link, or null if it cannot be found.
    Any DBObjectProvider implementation that support DatabaseLink should provide an implmentation of this method.
    
    Parameters:
    link - The DatabaseLink
    
    Returns:
    default schema for the link if known
  - fireProviderClosed
```
protected final void fireProviderClosed()
```
    Fires a providerClosed event to all listeners.
  - fireProviderDeleted
```
@Deprecated
public final void fireProviderDeleted()
```
    Deprecated. with no replacement - the "provider deleted" event no longer exists.
  - fireProviderOpened
```
protected final void fireProviderOpened()
```
    Fires a providerOpened event to all listeners.
  - fireProviderReloaded
```
protected final void fireProviderReloaded()
```
    Fires a providerReloaded event to all listeners.
  - fireSchemaAdded
```
@Deprecated
protected final void fireSchemaAdded(Schema schema)
```
    Deprecated. use fireObjectsAdded(Collection)
  - fireObjectsAdded
```
protected final void fireObjectsAdded(java.util.Collection<? extends SystemObject> sysObjs)
```
    Notifies all listeners that the given objects have been added to this provider.
    
    Parameters:
    sysObjs - a collecton of objects that have been added to this provider
  - fireSchemaUpdated
```
@Deprecated
protected final void fireSchemaUpdated(DBObjectChange change)
```
    Deprecated. use fireObjectUpdated(DBObjectChange)
  - fireSchemaObjectUpdated
```
@Deprecated
protected final void fireSchemaObjectUpdated(DBObjectChange change)
```
    Deprecated. use fireObjectUpdated(DBObjectChange)
  - fireObjectUpdated
```
protected final void fireObjectUpdated(DBObjectChange change)
```
    Notifies all listeners of an update to a SystemObject.
  - fireSchemaRemoved
```
@Deprecated
protected final void fireSchemaRemoved(Schema schema)
```
    Deprecated.
    
    Notifies all listeners that the given Schema has been removed from this provider.
  - fireObjectsRemoved
```
protected final void fireObjectsRemoved(java.util.Collection<? extends SystemObject> sysObjs)
```
    Notifies all listeners that the given objects have been removed from this provider.
    
    Parameters:
    sysObjs - a collecton of objects that have been removed from this provider
  - fireObjectsAdded
```
@Deprecated
public final void fireObjectsAdded(Schema schema,
                               SchemaObject[] objs)
```
    Deprecated. use fireObjectsAdded(Collection)
  - fireObjectsRemoved
```
@Deprecated
protected final void fireObjectsRemoved(Schema schema,
                                 SchemaObject[] objs)
```
    Deprecated. use fireObjectsRemoved(Collection)
  - registerType
```
protected final void registerType(java.lang.String type,
                DBObjectBuilder builder,
                DBObjectValidator validator)
```
    Registers a Builder and Validator for a specific object type. If a Builder has already been registered for the specified type, the new builder will replace the previous builder (same with validator). If either parameter is null this will not remove the builder.
    
    Parameters:
    type - a string containing the object type
    builder - the Builder instance to use for the specified type
    validator - the Validator instance to use for the specified type
    See Also:
    DBObject.getType()
  - registerBuilder
```
protected final void registerBuilder(java.lang.String type,
                   DBObjectBuilder builder)
```
    Registers a Builder for a specific object type. If a Builder has already been registered for the specified type, the new builder will replace the previous builder.
    
    Parameters:
    type - a string containing the object type
    builder - the Builder instance to use for the specified type
    See Also:
    DBObject.getType()
  - getBuilderForType
```
protected DBObjectBuilder getBuilderForType(java.lang.String type)
```
    Retrieves the DBObjectBuilder registered for a type of object.
    
    Parameters:
    type - a string containing the object type
    
    Returns:
    the DBObjectBuilder registered for the type, or null if no builder is registered
  - registerValidator
```
protected final void registerValidator(java.lang.String type,
                     DBObjectValidator validator)
```
    Registers a Validator for a specific object type. If a Validator has already been registered for the specified type, the new validator will replace the previous validator.
    
    Parameters:
    type - a string containing the object type
    validator - the Validator instance to use for the specified type
    See Also:
    DBObject.getType()
  - getValidatorForType
```
public final DBObjectValidator getValidatorForType(java.lang.String type)
```
    Retrieves the DBObjectValidator registered for a type of object.
    
    Parameters:
    type - a string containing the object type
    
    Returns:
    the DBObjectValidator registered for the type, or null if no validator is registered
  - findObject
```
protected SystemObject findObject(java.lang.String type,
                      Schema schema,
                      java.lang.String name)
```
    Looks for the specified object in the cache.
    
    Parameters:
    type - a string containing the type of object
    schema - the schema owning the object
    name - a string containing the name of the object
    
    Returns:
    the previously created SchemaObject representing the specified object, or null>/code> if the object does not exist in the cache
  findObject protected final SystemObject findObject(DBObjectID id) Looks for the specified object id in the cache. Parameters: id - the id of the object Returns: the previously created SystemObject representing the specified object, or null if the object does not exist in the cache destroyCache protected void destroyCache() Destroys the object cache. Use clearCaches() unless you are changing the supported object types. Destroying the cache removes all registered builders and validators as well as the objects themselves. clearAllCaches public void clearAllCaches() Clears all cached information in this provider that has been loaded from the underlying database. getCascadeManager public SchemaObjectManager getCascadeManager() By default creates a SchemaObjectManager. Override to customise. Specified by: getCascadeManager in interface DBObjectProvider getObjectManager @Deprecated public final SchemaObjectManager getObjectManager() Deprecated. Specified by: getObjectManager in interface DBObjectProvider createObjectManager protected SchemaObjectManager createObjectManager() Creates the object manager for this provider. Override if a custom object manager is needed. This is guaranteed to only be called once by getCascadeManager() which is synchronized. cacheObject protected void cacheObject(SystemObject object, boolean loadOperation) Adds an object to the cache. If an object of the same type, schema, and name as the specified object is already in the cache, it will be replaced. Parameters: object - the SchemaObject needing to be cached loadOperation - this is a load of the object, not a create or update. uncacheObject protected final void uncacheObject(SystemObject object) Removes an object from the cache. Parameters: object - the SchemaObject needing to be removed from the cache listObjectsImpl protected java.lang.String[] listObjectsImpl(java.lang.String type, Schema schema, java.lang.String ref) throws DBException List implementation for listing only object names. The default implementation calls listObjects(DBObjectCriteria) (thereby creating and caching SystemObjects) and then returns their names. Parameters: type - a string containg the type of object to list schema - the schema ref - a string containing a pattern to match object names against Returns: an array of object names Throws: DBException listObjectsImpl @Deprecated protected java.util.Collection<SystemObject> listObjectsImpl(java.lang.String[] objectTypes, Schema schema, java.lang.String ref) throws DBException Deprecated. listObjectsImpl(DBObjectCriteria) is the list implementation. This method will be removed in a future release. If you override this method it will not be called. Throws: DBException listObjectsImpl protected abstract <T extends SystemObject> java.util.Collection<T> listObjectsImpl(DBObjectCriteria<T> criteria) throws DBException Internal listObjects implementation. All listObjects methods call through to this method and all subclasses must implement it to list the objects in the underlying metadata that match the given criteria. When listing object information and creating SystemObject implementations to return, the cache of objects in the provider should be checked and any cached object reused rather than creating new instances for any list call. Parameters: criteria - the listing criteria Returns: all objects that match the given criteria Throws: DBException listObjectsFromCache protected final <T extends SystemObject> java.util.Collection<T> listObjectsFromCache(DBObjectCriteria<T> criteria) Lists the objects that are in the internal memory cache for this provider. Not really useful as a listObjectsImpl implementation as you need to list what is in the actual dictionary for that. getObjectImpl protected <T extends SystemObject> T getObjectImpl(DBObjectCriteria<T> criteria) throws DBException getObject implementation for looking up a single object in the provider. The criteria might include more than one type, but the method is only expected to return a single object. If this has been called with too ambiguous a criteria set then it will simply return the first object that it finds that matches. Parameters: criteria - the lookup criteria Returns: an object that matches the criteria Throws: DBException getExistingTimestamp protected final java.lang.Long getExistingTimestamp(SystemObject object) checkCachedObject protected <T extends SystemObject> T checkCachedObject(T object) throws DBException Use by getObjectImpl to verify that the given object in the cache is still valid. By default timestamping is used to check the object if available. Parameters: object - the cached object to check Returns: an object ready to return from getObjectImpl, or null if the cached object was invalid and has been removed. Throws: DBException listSchemas public Schema[] listSchemas() throws DBException Description copied from interface: DBObjectProvider Retrieves the list of schemas available from this provider regardless of their visibility to the user. Specified by: listSchemas in interface DBObjectProvider Returns: an array of schemas Throws: DBException - if an error is encountered listing the schemas See Also: DBObjectProvider.listSchemas(boolean) listSchemas public Schema[] listSchemas(boolean showAll) throws DBException Description copied from interface: DBObjectProvider Retrieves the list of schemas available from this provider. The list is optionally restricted to those schemas containing objects belonging (or visible to) the user. Specified by: listSchemas in interface DBObjectProvider Parameters: showAll - if false, only schemas containing objects belonging to (or visible to) the user are returned Returns: an array of schemas Throws: DBException - if an error is encountered listing the schemas. getSchema public Schema getSchema(java.lang.String name) throws DBException Description copied from interface: DBObjectProvider Retrieves the Schema object associated with a specific name. Specified by: getSchema in interface DBObjectProvider Parameters: name - a string containing the name of the schema Returns: a Schema representing the schema Throws: DBException - if an error is encountered getting the schema findSchema protected Schema findSchema(java.lang.String name) throws DBException Method for use within the provider that retrieves a schema and doesn't check the database if the schema is found in the cache. This should only be used withing operations where the existence of the schema is implied or unnecessary. Parameters: name - the name of the schema to find Returns: the schema that matches the given name, or null if the schema cannot be found. Throws: DBException resumeTimestampQueries public final void resumeTimestampQueries(java.lang.String key) Resumes the calls to get the external timestamp for a given object. The key passed in must match that passed into suspendTimestampQueries and the number of keys must reach zero before timestamping will resume. suspendTimestampQueries public final void suspendTimestampQueries(java.lang.String key) Limits the call to get the external timestamp for a given object to once until resumeTimestampQueries() is called. This means that once queried the first time, if an object is changed in the database the API will not notice. getCachedTimestamp protected final java.lang.Object getCachedTimestamp(java.lang.Object obj) Use to check whether timestamps are suspended and that the given object is a key in the cache of timestamp values. If it is a key, its value is returned. Parameters: obj - the key in the timestamp cache to lookup Returns: the value from the timestamp cache for the given key if there was one, and only if timestamps are currently suspended putCachedTimestampKey protected final java.lang.Object putCachedTimestampKey(java.lang.Object obj, java.lang.Object value) Checks that timestamps are suspended, and if they are caches the given key and value in the timestamp cache. Access to the cache is only possible while timestamps are suspended, and the cache is cleared when timestamps are not suspended. Parameters: obj - the key for the timstamp cache value - the value to put against the given key Returns: any existing value that was in the cache already for the given key supportsTimestamps public boolean supportsTimestamps(java.lang.String objectType) Returns true if this provider supports object timestamping for the given object type. An object's timestamp is set in the property map ( getProperties() ) under the TIMESTAMP_PROPERTY key. Returns false by default. Specified by: supportsTimestamps in interface DBObjectProvider supportsTimestamps @Deprecated public boolean supportsTimestamps() Deprecated. replaced by supportsTimestamps(String) getTimestamp public final java.lang.Long getTimestamp(java.lang.String type, Schema schema, java.lang.String objectName) throws DBException Description copied from interface: DBObjectProvider Retrieves the timestamp representing the last modification time of the specified object's metadata. If the provider does not provide timestamp information for metadata, a null value should be returned. Specified by: getTimestamp in interface DBObjectProvider Parameters: type - a String containing the type of the object schema - the Schema containing the object objectName - a String containing the name of the object Returns: the timestamp as a Long value Throws: DBException - if an error is encountered getting the timestamp getTimestamp public final java.lang.Long getTimestamp(DBObjectID id) throws DBException Description copied from interface: DBObjectProvider Retrieves the timestamp for the object represented by the given ID. Specified by: getTimestamp in interface DBObjectProvider Parameters: id - the ID for the object Returns: the timestamp Throws: DBException - if an error is encountered getting the timestamp See Also: DBObjectProvider.getTimestamp(String,Schema,String) resolveID protected DBObject resolveID(DBObjectID id) throws DBException Finds an object that matches the given id. This is how DBObjectIDs (particularly BaseObjectIDs) resolve themselves, and is therefore an internal mechanism. The id must be for a SystemObject, child ids resolve themselves by resolving their parent first. Parameters: id - the id to resolve by finding an object that matches it. Returns: a resolved object, or null if no object can be found. Throws: DBException resolveIDImpl protected SystemObject resolveIDImpl(BaseObjectID id) throws DBException Gets an object that is respresented by the given id. The object might already be cached, or it might need loading from the underlying dictionary. The id must be the returned object's actual DBObjectID, i.e. for a returned SystemObject object the following it true: object.getID().equals( id, true ) Parameters: id - the id to resolve (it will not be a ReferenceID) Returns: the SystemObject respresented by the given id Throws: DBException resolveReferenceID protected SystemObject resolveReferenceID(ReferenceID id) throws DBException Resolves a given reference by trying to find an object with matching details. Parameters: id - the reference to resolve Returns: an object with details that match the reference, or null. Throws: DBException resolveUnspecifiedTypeID protected SystemObject resolveUnspecifiedTypeID(ReferenceID id) throws DBException Resolves a given type-less reference by trying to find an object with matching name details. Parameters: id - the reference to resolve Returns: an object with details that match the reference, or null. Throws: DBException resetObject protected DBObjectChange resetObject(SystemObject object, SystemObject listed, java.lang.Long timestamp) If it has been noticed that the timestamp has changed on an object, or we have updated it in the database, we want to turn it back into an object that needs building again. This method resets an object back to a pre-built state. Parameters: object - the object we want to have cached and reset listed - an object returned by a list/find which is potentially in the cache, and potentially has a different id. timestamp - the timestamp for the new object (can be null) resetObject protected DBObjectChange resetObject(SystemObject object, SystemObject listed, java.lang.Long timestamp, boolean updated) If it has been noticed that the timestamp has changed on an object, or we have updated it in the database, we want to turn it back into an object that needs building again. This method resets an object back to a pre-built state. If the object is already being reset and this method is called again (e.g. recursively) then this method will do nothing but log a warning, and return null. Parameters: object - the object we want to have cached and reset listed - an object returned by a list/find which is potentially in the cache, and potentially has a different id. timestamp - the timestamp for the new object (can be null) updated - whether is the reset of an existing object (true) Returns: a DBObjectChange that, if inspected, will describe the differences between the reset object and its previous state. null is returned if the object is already being reset. loadObjectImpl protected <T extends SystemObject> T loadObjectImpl(DBObjectCriteria<T> criteria) throws DBException Loads a SystemObject definition from the underlying metadata. The default implementation uses listObjects(DBObjectCriteria) to list the objects with the given type/schema/name and then selects one using isRequestedObject(SystemObject,DBObjectCriteria). If the object is already cached (which can happen during an update operation) then if it still exists in the underlying metadata it will simply be returned without resetting it (i.e. checking the timestamp). The calling code is expected to deal with timestamps if it needs to. Parameters: criteria - the criteria for the object we want to load Returns: an object matching the given criteria Throws: DBException loadObjectImpl @Deprecated protected SystemObject loadObjectImpl(java.lang.String type, Schema schema, java.lang.String name) throws DBException Deprecated. no longer used - replaced by loadObjectImpl(DBObjectCriteria) Throws: DBException isRequestedObject @Deprecated protected boolean isRequestedObject(SystemObject object, java.lang.String type, Schema schema, java.lang.String name) Deprecated. no longer called - use isRequestedObject(SystemObject,DBObjectCriteria). isRequestedObject protected <T extends SystemObject> boolean isRequestedObject(T object, DBObjectCriteria<T> criteria) Checks whether the object that has been returned by a list operation matches the given criteria. This method exists to allow subclasses to override and provide custom logic for cases where the object that exists in the database might not match the criteria as exactly as the default implementation requires. The default implementation simply calls DBObjectCriteria.accept(SystemObject). Parameters: object - the listed object criteria - the criteria used to list the object Returns: true if the object matches the criteria sufficiently for a get or list operation. loadObjectImpl protected SystemObject loadObjectImpl(BaseObjectID id) throws DBException This is called when an id is resolved, and there is no object cached for it. If an object exists in the underlying metadata that matches the given id then this method should create an appropriate SystemObject instance for the object and return it. The returned object should be marked for lazy loading if appropriate. The default implementaion calls loadObjectImpl(DBObjectCriteria) with a criteria matching the name information for the given id. To support identifier based ids this method must be overridden. It is expected that the object will not be in the cache already when this method is called. Parameters: id - the id to load an object for - not a ReferenceID Returns: a new SystemObject instance, or null if no object matching the id exists. Throws: DBException getExternalTimestampImpl protected java.lang.Long getExternalTimestampImpl(SystemObject object) throws DBException Retrieves the external timestamp for the specified object. The external timestamp represents the last modification time for the object in the backend store (database, file system, or whatever else this provider is representing). Parameters: object - Returns: Throws: DBException getExternalTimestamp protected final java.lang.Long getExternalTimestamp(SystemObject object) throws DBException Throws: DBException markForLazyInit protected final void markForLazyInit(AbstractBuildableObject object) markForLazyInit protected final void markForLazyInit(AbstractBuildableObject object, DBObjectBuilder builder) convertObject public static java.lang.String convertObject(DBObject obj) Converts a DBObject into a String representation of the object name. Parameters: obj - the DBObject Returns: a String representing the object name; if the object is null, an empty String is returned. getIdentifierQuoteString public java.lang.String getIdentifierQuoteString() Description copied from interface: DBObjectProvider Retrieves the string used to quote identifiers. By default, the quote string is assumed to be ". If the quoting of identifiers is not supported by a subclass, that subclass should return null. Specified by: getIdentifierQuoteString in interface DBObjectProvider Returns: the string containing the character or characters used to quote an identifier. listObjectTypes public java.lang.String[] listObjectTypes() Returns a sorted array of the object types supported in this provider. If overridden the returned array must be sorted by the natural ordering of the elements (i.e. so that Arrays.binarySearch will work). Specified by: listObjectTypes in interface DBObjectProvider Returns: an array of strings containing the supported types of objects See Also: DBObjectProvider.listObjects(oracle.javatools.db.DBObjectCriteria<T>) supportsObjectType public boolean supportsObjectType(java.lang.String type) Description copied from interface: DBObjectProvider Convinience method to check whether this provider supports the given object type - i.e. whether it is contained in the array returned by listObjectTypes(). Specified by: supportsObjectType in interface DBObjectProvider See Also: DBObjectProvider.listObjectTypes() listObjects public final java.lang.String[] listObjects(java.lang.String objectType, Schema schema) throws DBException Description copied from interface: DBObjectProvider Lists the objects of a given type available from this provider. Specified by: listObjects in interface DBObjectProvider Parameters: objectType - the type of objects to list schema - the schema to list from Returns: an array of object names Throws: DBException listObjects public final java.lang.String[] listObjects(java.lang.String objectType, Schema schema, java.lang.String ref) throws DBException Description copied from interface: DBObjectProvider Lists the objects of a given type available from this provider. Specified by: listObjects in interface DBObjectProvider Parameters: objectType - the type of objects to list schema - the schema to list from ref - a pattern to match against. Returns: an array of object names Throws: DBException listObjects public final SchemaObject[] listObjects(java.lang.String[] objectTypes, Schema schema) throws DBException Description copied from interface: DBObjectProvider Lists the objects of multiple types available from this provider. Specified by: listObjects in interface DBObjectProvider Parameters: objectTypes - an array of Strings representing the desired types schema - the Schema to list from Returns: an array of SchemaObjects representing the objects Throws: DBException - if an error is encountered listing the objects listObjects public final SchemaObject[] listObjects(java.lang.String[] objectTypes, Schema schema, java.lang.String ref) throws DBException Description copied from interface: DBObjectProvider Lists the objects of multiple types available from this provider. Specified by: listObjects in interface DBObjectProvider Parameters: objectTypes - an array of Strings representing the desired types schema - the Schema to list from ref - a pattern to match against. Returns: an array of SchemaObjects representing the objects Throws: DBException - if an error is encountered listing the objects listObjects public final <T extends SystemObject> java.util.Collection<T> listObjects(DBObjectCriteria<T> criteria) throws DBException Description copied from interface: DBObjectProvider Lists the objects from this provider that match the given criteria. Examples: // list Tables beginning with E in a given schema DBObjectProvider pro = ... Schema schema = ... SystemObject obj = pro.listObjects( DBObjectCriteria.createCriteria( Table.TYPE, schema, "E%" ) ); // list all objects that have columns and constraints in schema HR DBObjectCriteria<Relation> c = new DBObjectCriteria<Relation>(Relation.class); c.setSchemaName( "HR" ); Collection<Relation> rels = pro.listObjects( c ); // list all the schemas in this provider Collection<Schema> schemas = pro.listObjects( new DBObjectCriteria<Schema>(Schema.class) ); Specified by: listObjects in interface DBObjectProvider Parameters: criteria - the filter to use for listing objects (cannot be null) Returns: a collection of objects Throws: DBException - if an error is encountered listing the objects getObject public final <T extends SystemObject> T getObject(DBObjectCriteria<T> criteria) throws DBException Description copied from interface: DBObjectProvider Retrieves the SystemObject representing a specific database object. The given criteria must match only one object. Examples: // find EMP in a given provider and schema DBObjectProvider pro = ... Schema schema = ... SystemObject obj = pro.getObject( DBObjectCriteria.createSingleObjectCriteria( Table.TYPE, schema, "EMP" ) ); // find Table HR.EMPLOYEES DBObjectCriteria<Table> c = new DBObjectCriteria<Table>(Table.class); c.setName( "EMPLOYEES" ); c.setSchemaName( "HR" ); Table employees = pro.getObject( c ); Specified by: getObject in interface DBObjectProvider Parameters: criteria - the criteria to match the object required Returns: the SystemObject matching the specified criteria Throws: DBException - if an error is encountered retrieving the object getObject public final SchemaObject getObject(java.lang.String objectType, Schema schema, java.lang.String name) throws DBException Description copied from interface: DBObjectProvider Retrieves the SchemaObject representing a specific database object. Note to get a SystemObject that is not a SchemaObject (e.g. a Tablesapce) you must use DBObjectProvider.getObject(DBObjectCriteria). Specified by: getObject in interface DBObjectProvider Parameters: objectType - the type of object desired. schema - the name of the schema containing the object name - the name of the object Returns: the SchemaObject matching the specified criteria Throws: DBException - if an error is encountered retrieving the object See Also: DBObject.getType() hasPriviledge @Deprecated public boolean hasPriviledge(java.lang.String type, Schema schema, java.lang.String priv) Deprecated. - use hasSystemPrivilege(java.lang.String, oracle.javatools.db.Schema, java.lang.String) Specified by: hasPriviledge in interface DBObjectProvider hasSystemPrivilege public boolean hasSystemPrivilege(java.lang.String type, Schema schema, java.lang.String priv) Checks to see whether the user has the requisite permissions to perform the specified operation. For example, whether the user has permission to create a new table in a specific schema. NB The return value should be used as guide only and is not guarenteed to truely reflect the current set of privileges. The default implementation will always return true, and other implementations may choose to cache the result. Specified by: hasSystemPrivilege in interface DBObjectProvider Parameters: type - the object type on which the operation is being performed. schema - the schema to check. A value of null checks for the current schema. priv - a pre-defined operation. Returns: whether the specified operation can be completed. hasObjectPrivilege public boolean hasObjectPrivilege(SystemObject object, java.lang.String priv) Checks to see whether the user has the requisite permissions to perform the specified operation on the given object. For example, whether the user has permission to alter a table. NB The return value should be used as guide only and is not guarenteed to truely reflect the current set of privileges. The default implementation will always return true, and other implementations may choose to cache the result. Specified by: hasObjectPrivilege in interface DBObjectProvider Parameters: object - the object on which the operation is being performed. priv - a pre-defined operation. Returns: whether the specified operation can be completed. canUpdate public void canUpdate(Difference listDiff, boolean replace, boolean cascade) throws DBException Description copied from interface: DBObjectProvider Tests whether the given update can be performed. If the update is not allowed with the given options then a DBException will be thrown detailing the exact reasons why. This is in contract to the canCreate and canDelete methods which return a simple boolean so the reason cannot be determined. Specified by: canUpdate in interface DBObjectProvider Parameters: listDiff - a LIST Difference containing new and old schema objects replace - whether existing objects can be replaced cascade - whether to cascade any changes. If this is false and there are dependent objects a CascadeRequiredException will be thrown. Throws: DBException See Also: DBObjectProvider.updateObjects(Difference,boolean,boolean) createObject public final void createObject(SystemObject obj, boolean replace) throws DBException Description copied from interface: DBObjectProvider Causes the creation of the object described by the specified meta data. Specified by: createObject in interface DBObjectProvider Parameters: obj - the SystemObject describing the object to create. replace - whether to replace an existing object. If replace is false and the object exists, createObject will fail. Throws: DBException - if an error is encountered creating the object. deleteObject public final void deleteObject(SystemObject obj, boolean cascade) throws DBException Description copied from interface: DBObjectProvider Deletes the object. Specified by: deleteObject in interface DBObjectProvider Parameters: obj - the object to delete cascade - whether to delete dependent objects Throws: DBException - if an error is encountered performing the delete updateObject public final void updateObject(SystemObject oldObject, SystemObject newObject) throws DBException Description copied from interface: DBObjectProvider Updates the definition of an object. By default this will not cascade any changes to dependent objects. Specified by: updateObject in interface DBObjectProvider Parameters: oldObject - the old version of the object newObject - the new version of the object Throws: DBException - if the update fails See Also: DBObjectProvider.updateObjects(Difference,boolean,boolean) updateObjects public final void updateObjects(SystemObject[] oldObjects, SystemObject[] newObjects) throws DBException Description copied from interface: DBObjectProvider Updates the definition of a set of objects. By default this will not cascade any changes to dependent objects. Specified by: updateObjects in interface DBObjectProvider Parameters: oldObjects - the old version of the objects newObjects - the new version of the objects Throws: DBException - if the update fails See Also: DBObjectProvider.updateObjects(Difference,boolean,boolean) createSchema public void createSchema(Schema schema, boolean replace) throws DBException Description copied from interface: DBObjectProvider Causes the creation of a new Schema in the persistent storage. Specified by: createSchema in interface DBObjectProvider Parameters: schema - the schema being created replace - whether to replace an existing schema Throws: DBException - if an error is encountered creating the schema deleteSchema public void deleteSchema(Schema schema, boolean cascade) throws DBException Description copied from interface: DBObjectProvider Deletes the schema. Specified by: deleteSchema in interface DBObjectProvider Parameters: schema - the schema to delete cascade - whether to delete dependent objects (i.e. all SchemaObjects contained in the Schema). Throws: DBException - if an error is encountered performing the delete updateSchema public void updateSchema(Schema oldSchema, Schema newSchema) throws DBException Description copied from interface: DBObjectProvider Updates the definition of a Schema. Specified by: updateSchema in interface DBObjectProvider Parameters: oldSchema - the old version of the schema newSchema - the new version of the schema Throws: DBException - if the update fails getPropertyManager public PropertyManager getPropertyManager() Description copied from interface: DBObjectProvider Gets the PropertyManager (if available) for this provider. The property manager provides information about which properties are supported on which objects, and what operations (create/replace/update/delete) are supported for any particular object or property. Specified by: getPropertyManager in interface DBObjectProvider Returns: this provider's property manager, or null if no property manager exists. getDDLGenerator public final DDLGenerator getDDLGenerator() Gets the DDLGenerator for this provider. This uses DatabaseDescriptor.getDDLGenerator(oracle.javatools.db.DBObjectProvider). Specified by: getDDLGenerator in interface DBObjectProvider getCasePolicy protected final int getCasePolicy() Retrieves the provider's case policy for unquoted names. Returns: the Database's case policy for unquoted names. See Also: LOWER_CASE_NAME_POLICY, MIXED_CASE_NAME_POLICY, UPPER_CASE_NAME_POLICY, CASE_SENSITIVE_NAME_POLICY getQuotedNameCasePolicy @Deprecated protected final int getQuotedNameCasePolicy() Deprecated. getCasePolicy() covers both quoted and unquoted names. isValidName @Deprecated public final boolean isValidName(java.lang.String name) Deprecated. - use isValidName( String type, String name ) Checks to see whether a name is valid. Note that a valid name does not guarantee uniqueness. The default implementation is allow all names. Specified by: isValidName in interface DBObjectProvider Parameters: name - the name to check Returns: whether the name is valid isValidName public final boolean isValidName(java.lang.String type, java.lang.String name) Checks to see whether a name is valid. Note that a valid name does not guarantee uniqueness. The default implementation is allow all names. Specified by: isValidName in interface DBObjectProvider Parameters: name - the name to check type - the type of object the name is intended for Returns: whether the name is valid validateName @Deprecated public final void validateName(java.lang.String name) throws InvalidNameException Deprecated. - use validateName( String type, String name ) Description copied from interface: DBObjectProvider Checks to see whether a name is valid. Note that a valid name does not guarantee uniqueness. Specified by: validateName in interface DBObjectProvider Parameters: name - the name to check Throws: InvalidNameException - with appropriate message if the name is invalid. validateName public final void validateName(java.lang.String type, java.lang.String name) throws InvalidNameException Final implementation delegates to the registered DBObjectValidator for the given type. If the type is missing the DatabaseDescriptor is called directly. Specified by: validateName in interface DBObjectProvider Parameters: type - the type of object that the name is intended for (e.g. Table.TYPE) name - the external name to check Throws: InvalidNameException - with appropriate message if the name is invalid. See Also: DBObjectValidator#validateName(String,String), DatabaseDescriptor.validateName(String,String) quoteIdentifier public final java.lang.String quoteIdentifier(java.lang.String internalName, boolean force) throws DBException Determines if internalName needs quoting to make it a valid external name, and if so returns a quoted copy of it. If it doesn't need quoting, it returns the name unquoted. If internalName is empty, or quoted names aren't supported by the provider and the name isn't valid, it returns null. Specified by: quoteIdentifier in interface DBObjectProvider Parameters: internalName - force - Always quote the name Returns: Throws: DBException getInternalName public final java.lang.String getInternalName(java.lang.String name, java.lang.String objectType) Description copied from interface: DBObjectProvider Converts the specified name into the format used internally within the metadata. This should only be called on a valid external name to avoid corruption. Generally, internal names are not quoted; quoted names have the quotes removed. Unquoted names may be converted to a single case if the underlying provider does not support mixed case identifiers. Specified by: getInternalName in interface DBObjectProvider Parameters: name - a String containing the name to convert objectType - a String containing the type of object being named Returns: the internal version of the name See Also: DBObjectProvider.getExternalName(String,String), DBObjectProvider.validateName(String,String) getInternalName public final java.lang.String getInternalName(java.lang.String name) Description copied from interface: DBObjectProvider Converts the specified name into the format used internally within the metadata. This should only be called on a valid external name to avoid corruption. Generally, internal names are not quoted; quoted names have the quotes removed. Unquoted names may be converted to a single case if the underlying provider does not support mixed case identifiers. Specified by: getInternalName in interface DBObjectProvider Parameters: name - a String containing the name to convert Returns: the internal version of the name See Also: DBObjectProvider.getInternalName(String,String) getExternalName public final java.lang.String getExternalName(java.lang.String name, java.lang.String objectType) Description copied from interface: DBObjectProvider Converts the specified name into the format used externally to represent the identifier. In most cases, this is equivalent to calling quoteIdentifier, specifying false for the force argument. Note, however, that exceptions are not thrown; rather, the original name will be returned. Specified by: getExternalName in interface DBObjectProvider Parameters: name - a String containing the name to externalize objectType - a String containing the type of object being named Returns: a String containing the externalized name See Also: DBObjectProvider.getInternalName(String,String) getExternalName public final java.lang.String getExternalName(java.lang.String name) Description copied from interface: DBObjectProvider Converts the specified name into the format used externally to represent the identifier. In most cases, this is equivalent to calling quoteIdentifier, specifying false for the force argument. Note, however, that exceptions are not thrown; rather, the original name will be returned. Specified by: getExternalName in interface DBObjectProvider Parameters: name - a String containing the name to externalize Returns: a String containing the externalized name listSupportedDataTypes public DataType[] listSupportedDataTypes() Description copied from interface: DBObjectProvider Retrieves the list of datatypes supported by this provider. Specified by: listSupportedDataTypes in interface DBObjectProvider Returns: an array of DataType objects representing the supported datatypes. getDataType public DataType getDataType(java.lang.String typeName) Description copied from interface: DBObjectProvider Retrieves the datatype represented by a specific name. Specified by: getDataType in interface DBObjectProvider Parameters: typeName - a String containing the name of the datatype. Returns: the DataType represented by the specified name or null if none can be found. getOrCreateDataType public DataType getOrCreateDataType(java.lang.String typeName) Description copied from interface: DBObjectProvider Gets (or creates) the datatype represented by a specific name. If one is not registered a new, dummy datatype is returned to represent the data type. Do not use this to lookup a data type, use DBObjectProvider.getDataType(String). Specified by: getOrCreateDataType in interface DBObjectProvider Parameters: typeName - a String containing the name of the datatype. Returns: a DataType represented by the specified name. validateObject public void validateObject(DBObject object) throws ValidationException Validates the given object using the DBObjectValidator registered against that object's type. A ValidationException is thrown if the object fails to validate, or if no DBObjectValidator is registered for that object type. Specified by: validateObject in interface DBObjectProvider Parameters: object - The object to validate Throws: ValidationException - if the object is not valid. The exception will describe the validation failure. A MissingValidatorException is thrown if the provider has no validator for the given object type. validateObject @Deprecated public final void validateObject(DBObject object, java.lang.String property) throws ValidationException Deprecated. Specified by: validateObject in interface DBObjectProvider Throws: ValidationException validateObjectProperty @Deprecated public final void validateObjectProperty(DBObject object, java.lang.Object property) throws ValidationException Deprecated. Specified by: validateObjectProperty in interface DBObjectProvider Throws: ValidationException validateObjectProperty public void validateObjectProperty(DBObject object, java.lang.String property) throws ValidationException Description copied from interface: DBObjectProvider Checks to see if the children of a given object are valid. If the object has no children of the given type a MissingValidatorException will be thrown. This is a convinience method to perform validation to a specific property on an object - all properties will be validated if DBObjectProvider.validateObject(DBObject)is called. Specified by: validateObjectProperty in interface DBObjectProvider Parameters: object - The object to validate property - An identifier for a specific property to validate Throws: ValidationException - if the object is not valid. The exception will describe the validation failure. A MissingValidatorException is thrown if the provider has no validator for the given object type, or property. validateSchema @Deprecated public void validateSchema(Schema schema) throws ValidationException Deprecated. - use validateObject( DBObject object ) Description copied from interface: DBObjectProvider Checks to see if the Schema is valid. Specified by: validateSchema in interface DBObjectProvider Parameters: schema - The Schema to validate Throws: ValidationException - if the Schema is not valid. The exception will describe the validation failure. validateObject public void validateObject(DBObject original, DBObject update) throws ValidationException Validates the given object update using the DBObjectValidator registered against that object's type. A ValidationException is thrown if the update fails to validate, or if no DBObjectValidator is registered for that object type. Specified by: validateObject in interface DBObjectProvider Parameters: original - the original object update - the updated object to validate Throws: ValidationException - if the updated object is not valid. The exception will describe the validation failure. A MissingValidatorException is thrown if the provider has no validator for the given object type. validateObject @Deprecated public final void validateObject(DBObject original, DBObject update, java.lang.String property) throws ValidationException Deprecated. Specified by: validateObject in interface DBObjectProvider Throws: ValidationException validateObjectProperty @Deprecated public final void validateObjectProperty(DBObject original, DBObject updated, java.lang.Object property) throws ValidationException Deprecated. Specified by: validateObjectProperty in interface DBObjectProvider Throws: ValidationException validateObjectProperty public void validateObjectProperty(DBObject original, DBObject update, java.lang.String property) throws ValidationException Description copied from interface: DBObjectProvider Checks to see if the updated children of a given object are valid. If the object has no children of the given type a MissingValidatorException will be thrown. This is a convinience method to perform validation to a specific property on an object - all properties will be validated if DBObjectProvider.validateObject(DBObject,DBObject)is called. Specified by: validateObjectProperty in interface DBObjectProvider Parameters: original - The original version of the edited object update - The edited object to validate property - An identifier for a specific property to validate Throws: ValidationException - if the object is not valid. The exception will describe the validation failure. A MissingValidatorExceptionis thrown if the provider has no validator for the given object type, or property. validateSchema @Deprecated public void validateSchema(Schema original, Schema update) throws ValidationException Deprecated. use validateObject( DBObject original, DBObject update ) Description copied from interface: DBObjectProvider Checks to see if the schema update is valid. Specified by: validateSchema in interface DBObjectProvider Parameters: original - the original schema update - the updated schema to validate Throws: ValidationException - if the updated schema is not valid. The exception will describe the validation failure. validateUniqueName public final void validateUniqueName(java.lang.String type, DBObject contextObject, java.lang.String name) throws NameInUseException Validates that a name is not used within a context DBObject, and throws NameInUseException if it is. The NameInUseException should contain the name, and the DBObject containing the name. This implementation creates a dummy DBObject with the given type and name and calls validateUniqueName(DBObject,DBObject). Specified by: validateUniqueName in interface DBObjectProvider Parameters: type - the type of name being validated contextObject - the database object context to use when determining the uniqueness of the name (can be a parent, or a Schema, or null). name - the name to be checked Throws: java.lang.IllegalStateException - if type is not a recognised or valid (instantiable) object type. NameInUseException - if the name is in use. validateUniqueName public void validateUniqueName(DBObject object, DBObject contextObject) throws NameInUseException Description copied from interface: DBObjectProvider Validates that a name is not used within a context DBObject, and throws NameInUseException if it is. The NameInUseException should contain the name, and the DBObject containing the name. Specified by: validateUniqueName in interface DBObjectProvider Parameters: object - the object whose name is to be validated as unique contextObject - the database object context to use when determining the uniqueness of the name (can be a parent, or a Schema, or null). Throws: NameInUseException - if the name is in use. getUniqueName public java.lang.String getUniqueName(java.lang.String type, DBObject contextObject, java.lang.String base) Returns a unique name for an object of given type within contextObject using base name. This default implementation ensures that you cannot have two SchemaObjects of any type with the same name, two indexes with the same name or two constraints with the same name, within contextObject. Specified by: getUniqueName in interface DBObjectProvider Parameters: type - the type of the object contextObject - the context object, e.g. the owning schema or the parent object base - a candidate base name Returns: a unique name within the context object getUniqueName public java.lang.String getUniqueName(java.lang.String type, DBObject contextObject, java.lang.String base, java.util.Collection<java.lang.String> bannedNames) Returns a unique name for an object of given type within contextObject using base name. This default implementation ensures that you cannot have two SchemaObjects of any type with the same name, two indexes with the same name or two constraints with the same name, within contextObject. Specified by: getUniqueName in interface DBObjectProvider Parameters: type - the type of the object contextObject - the context object, e.g. the owning schema or the parent object base - a candidate base name bannedNames - a collection of names not to be used when determining a unique name. This collection is in addition to any existing objects in the provider. Returns: a unique name within the context object getUniqueNameTreatIndexAsSchemaObject @Deprecated protected boolean getUniqueNameTreatIndexAsSchemaObject() Deprecated. this limited mechanism has been superceeded by DBObjectValidator#getNamespaceType normaliseType protected java.lang.String normaliseType(java.lang.String type) getDiffEngine public DiffEngine getDiffEngine() Description copied from interface: DBObjectProvider Returns a diff engine setup with the appropriate set of differs for object updating. Providers which do not support object updating should return null. Specified by: getDiffEngine in interface DBObjectProvider ensureSystemObjectListDifference protected Difference ensureSystemObjectListDifference(Difference diff) throws java.lang.IllegalArgumentException Call this to ensure that the caller of an API method that takes a Difference of SystemObject[] objects has a correct Difference arg. Parameters: diff - the diff to check Returns: an ensured SystemObject[] diff Throws: java.lang.IllegalArgumentException - if the diff isn't a SystemObject[] diff and can't be turned in to one. getLogger protected java.util.logging.Logger getLogger() Gets the logger to use in this provider. logEvent protected void logEvent(java.lang.String msg, java.lang.Object... params) Use to log provider events. isEditable public boolean isEditable(DBObject object) Description copied from interface: DBObjectProvider Tests whether or not the object can be edited. Specified by: isEditable in interface DBObjectProvider getDefaultTemplateForType public DBObject getDefaultTemplateForType(java.lang.String type) Returns the default template object for the given type, or null if none defined. Specified by: getDefaultTemplateForType in interface DBObjectProvider setDefaultTemplateForType public void setDefaultTemplateForType(java.lang.String type, DBObject template) Sets the default template object for the given type. Default (online) implementation throws a RuntimeException. Specified by: setDefaultTemplateForType in interface DBObjectProvider isNewFromTemplateType public boolean isNewFromTemplateType(java.lang.String type) Description copied from interface: DBObjectProvider Test whether the given type is the pseudo type used for new objects that are being created from a template. Specified by: isNewFromTemplateType in interface DBObjectProvider Parameters: type - the type to test Returns: true if the type is a "new from template" type registerSchemaObjectExpander @Deprecated protected void registerSchemaObjectExpander(SchemaObjectExpander expander) Deprecated. getSchemaObjectExpanders @Deprecated public SchemaObjectExpander[] getSchemaObjectExpanders() Deprecated. getObjectFactory public DBObjectFactory getObjectFactory() Description copied from interface: DBObjectProvider Get the object factory for this provider. Specified by: getObjectFactory in interface DBObjectProvider createObjectFactory protected DBObjectFactory createObjectFactory() Called once to create a factory for creating objects, and ensuring IDs, etc in this provider. Returns: a factory for this provider. updateObjects public final void updateObjects(Difference listDiff, boolean replace, boolean cascade) throws DBException Description copied from interface: DBObjectProvider Updates the definition of a set of objects. The changes required are described by the Difference which must have been created using the DiffEngine returned by DBObjectProvider.getDiffEngine() The 'change' maybe to create, alter, or delete objects. Example usage to rename a simple table and cascade the change: final Table orig = provider.getObject( Table.TYPE, schema, "OLD_NAME" ); // create a temporary copy that can be used to update final Table update = (Table)orig.copyTo( null, true ); update.setName( "NEW_NAME" ); // create a LIST Difference containing the new and old objects final Difference diff = provider.getDiffEngine().difference( new SystemObject[]{ orig }, new SystemObject[]{ update } ); provider.updateObjects( diff , false, true ); Specified by: updateObjects in interface DBObjectProvider Parameters: listDiff - the changes described as a Difference - this should be a LIST Difference with the old objects as a() and the new objects as b(). replace - true if existing objects can be replaced (used when creating - i.e. the "old" update in the Difference is null) cascade - true if changes can be cascaded throughout the provider (e.g. deletes cascaded, renames propogated etc). If this is false and the operation cannot continue without cascading a CascadeRequiredException will be thrown. Some DBObjectProvider implementations will automatically cascade some changes - for example an Oracle Database will propogate a Table rename to its Triggers. Throws: DBException commitTransaction public final void commitTransaction(DBObjectTransaction txn) throws DBException Description copied from interface: DBObjectProvider Commits a transaction of object changes. The transaction can contain new objects to create, updates to existing objects and objects to delete. Specified by: commitTransaction in interface DBObjectProvider Parameters: txn - the transaction to commit Throws: DBException - if the operation fails. commitTransaction protected abstract java.util.Collection<DBObjectChange> commitTransaction(DBObjectTransaction txn, Difference listDiff) throws DBException Implement to commit the given transaction's difference. This is used for all create, update and delete operations. Parameters: txn - the transaction (create/update/delete of objects) to commit listDiff - the difference detailing the changes that the are in the transaction and that require commiting Returns: a collection of the changes that have been commited Throws: DBException - if the commit could not be performed

Class AbstractDBObjectProvider

Field Summary

Fields inherited from interface oracle.javatools.db.DBObjectProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface oracle.javatools.db.DBObjectProvider

Field Detail

MIXED_CASE_NAME_POLICY

LOWER_CASE_NAME_POLICY

UPPER_CASE_NAME_POLICY

CASE_SENSITIVE_NAME_POLICY

TIMESTAMP_PROPERTY

NEW_FROM_TEMPLATE_TYPE

EMPTY_LIST

Constructor Detail

AbstractDBObjectProvider

AbstractDBObjectProvider

Method Detail

getDescription

isClosed

removeProviderListener

removeProviderListener

addProviderListener

addProviderListener

addObjectListener

addObjectListener

addObjectListener

removeObjectListener

getDefaultSchemaName

fireProviderClosed

fireProviderDeleted

fireProviderOpened

fireProviderReloaded

fireSchemaAdded

fireObjectsAdded

fireSchemaUpdated

fireSchemaObjectUpdated

fireObjectUpdated

fireSchemaRemoved

fireObjectsRemoved

fireObjectsAdded

fireObjectsRemoved

registerType

registerBuilder

getBuilderForType

registerValidator

getValidatorForType

findObject

findObject

destroyCache

clearAllCaches

getCascadeManager

getObjectManager

createObjectManager

cacheObject

uncacheObject

listObjectsImpl

listObjectsImpl

listObjectsImpl

listObjectsFromCache

getObjectImpl

getExistingTimestamp

checkCachedObject

listSchemas

listSchemas

getSchema

findSchema

resumeTimestampQueries

suspendTimestampQueries

getCachedTimestamp

putCachedTimestampKey

supportsTimestamps

supportsTimestamps

getTimestamp

getTimestamp

resolveID

resolveIDImpl

resolveReferenceID

resolveUnspecifiedTypeID