oracle.javatools.db

Class BuiltInObjectCache

java.lang.Object

oracle.javatools.db.marshal.AbstractResourceCache

oracle.javatools.db.BuiltInObjectCache

public class BuiltInObjectCache
extends oracle.javatools.db.marshal.AbstractResourceCache

A cache of objects that are "built-in" to a database version in the API. This allows emulating DBObjectProvider implementations to have built-in support for objects that are always available in a database connection.

Since:

12.1.3

See Also:

DatabaseDescriptor.listBuiltInObjects(DBObjectCriteria)

Constructor Summary

Constructors

Constructor and Description
BuiltInObjectCache(DatabaseDescriptor desc, java.lang.String resourceDir) Creates a new cache for the given DatabaseDescriptor.

Method Summary

Modifier and Type	Method and Description
boolean	isEmpty() Tests whether this cache is empty - i.e.
java.util.List<BuiltInFunction>	listBuiltInFunctions() Lists the Built-in functions that are specific to the version of the database that owns this BuiltInObjectCache (and later).
<T extends SystemObject> java.util.Collection<T>	listBuiltInObjects(DBObjectCriteria<T> criteria) Lists the built in objects from this cache that match the given criteria.
void	registerBuiltInObject(java.lang.String type, java.lang.String schema, java.lang.String name) Registers a built in object that will be loaded as a resource file under the resource root.
void	registerBuiltInObject(SystemObject obj) Registers a built in object that is not loaded from a resource file.

Methods inherited from class oracle.javatools.db.marshal.AbstractResourceCache

getDatabaseDescriptor, getHandler, getLogger, getResourceClassLoader, getResourcePath, getResourceRoot, lazyObjectBuilt, markForLazyInit

Methods inherited from class java.lang.Object

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

Constructor Detail

BuiltInObjectCache

public BuiltInObjectCache(DatabaseDescriptor desc,
                          java.lang.String resourceDir)

Creates a new cache for the given DatabaseDescriptor.

Parameters:

desc - the DatabaseDescriptor this is the cache for.

resourceDir - the resource root directory for lazy loading built in objects from.

Method Detail

isEmpty

public boolean isEmpty()

Tests whether this cache is empty - i.e. nothing has been registered and no resource files exist.

Returns:

true if this cache is empty

listBuiltInFunctions

public final java.util.List<BuiltInFunction> listBuiltInFunctions()

Lists the Built-in functions that are specific to the version of the database that owns this BuiltInObjectCache (and later).

Parameters:

bundle - The resource bundle that contains the description of functions keyed by function name. Can be null.

listBuiltInObjects

public final <T extends SystemObject> java.util.Collection<T> listBuiltInObjects(DBObjectCriteria<T> criteria)

Lists the built in objects from this cache that match the given criteria.

Parameters:

criteria - the criteria of which objects to list

Returns:

the cached objects that match the criteria

registerBuiltInObject

public void registerBuiltInObject(java.lang.String type,
                                  java.lang.String schema,
                                  java.lang.String name)

Registers a built in object that will be loaded as a resource file under the resource root.

Parameters:

type - the type of the object.

schema - the name of the object's schema (and therefore subdirectory of the resource root). Can be null for system objects.

name - the name of the object.

registerBuiltInObject

public void registerBuiltInObject(SystemObject obj)

Registers a built in object that is not loaded from a resource file.

Parameters:

obj - the object to register