DelegatingFetchConfiguration (OpenJPA Parent POM 2.1.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.openjpa.kernel
Class DelegatingFetchConfiguration

java.lang.Object
  org.apache.openjpa.kernel.DelegatingFetchConfiguration

All Implemented Interfaces:: Serializable, Cloneable, FetchConfiguration, LockLevels, LockScopes, QueryFlushModes

Direct Known Subclasses:: DelegatingJDBCFetchConfiguration

public class DelegatingFetchConfiguration
extends Object
implements FetchConfiguration
extends Object
implements FetchConfiguration

Delegating fetch configuration that can also perform exception translation for use in facades.

Author:: Abe White
See Also:: Serialized Form

Field Summary

Fields inherited from interface org.apache.openjpa.kernel.FetchConfiguration
`DEFAULT, FETCH_LOAD, FETCH_NONE, FETCH_REF`

Fields inherited from interface org.apache.openjpa.kernel.LockLevels
`LOCK_NONE, LOCK_READ, LOCK_WRITE`

Fields inherited from interface org.apache.openjpa.kernel.LockScopes
`LOCKSCOPE_EXTENDED, LOCKSCOPE_NORMAL`

Fields inherited from interface org.apache.openjpa.kernel.QueryFlushModes
`FLUSH_FALSE, FLUSH_TRUE, FLUSH_WITH_CONNECTION`

Constructor Summary
`DelegatingFetchConfiguration(FetchConfiguration fetch)` Constructor; supply delegate.
`DelegatingFetchConfiguration(FetchConfiguration fetch, RuntimeExceptionTranslator trans)` Constructor; supply delegate and exception translator.

Method Summary
`FetchConfiguration`	`addFetchGroup(String group)` Adds `group` to the set of fetch group names to use when loading objects.
`FetchConfiguration`	`addFetchGroups(Collection groups)` Adds `groups` to the set of fetch group names to use when loading objects.
`FetchConfiguration`	`addField(String field)` Adds `field` to the set of fully-qualified field names to use when loading objects.
`FetchConfiguration`	`addFields(Collection fields)` Adds `fields` to the set of fully-qualified field names to use when loading objects.
`FetchConfiguration`	`clearFetchGroups()` Clears the set of fetch group names to use when loading data.
`FetchConfiguration`	`clearFields()` Clears the set of field names to use when loading data.
`Object`	`clone()` Clone this instance.
`void`	`copy(FetchConfiguration fetch)` Copy the state from the given fetch configuration to this one.
`boolean`	`equals(Object other)`
`DataCacheRetrieveMode`	`getCacheRetrieveMode()` Gets the current retrieve mode for data cache.
`DataCacheStoreMode`	`getCacheStoreMode()` Gets the current storage mode for data cache.
`StoreContext`	`getContext()` Return the context associated with this configuration; may be null if it has not been set or this object has been serialized.
`FetchConfiguration`	`getDelegate()` Return the direct delegate.
`boolean`	`getExtendedPathLookup()` Affirms if extended path lookup feature is active.
`int`	`getFetchBatchSize()` Return the fetch batch size for large result set support.
`Set`	`getFetchGroups()` Returns immutable set of names of the fetch groups that this component will use when loading objects.
`Set`	`getFields()` Returns the set of fully-qualified field names that this component will use when loading objects.
`int`	`getFlushBeforeQueries()` The query automatic flush configuration.
`Object`	`getHint(String name)` Get the hint value for the specific key as originally set by the caller, or null if the hint is not specified.
`Map<String,Object>`	`getHints()` Get an immutable view of the currently active hints and their values.
`FetchConfiguration`	`getInnermostDelegate()` Return the native delegate.
`int`	`getLockScope()` The lock scope for next fetch.
`int`	`getLockTimeout()` The number of milliseconds to wait for an object lock, or -1 for no limit.
`int`	`getMaxFetchDepth()` Return the maximum depth of fetched instance graph.
`boolean`	`getQueryCacheEnabled()` Return whether or not query caching is enabled.
`int`	`getQueryTimeout()` The number of milliseconds to wait for a query, or -1 for no limit.
`int`	`getReadLockLevel()` The lock level to use for locking loaded objects.
`Set`	`getRootClasses()` Root classes for recursive operations.
`Set`	`getRootInstances()` Root instances for recursive operations.
`int`	`getWriteLockLevel()` The lock level to use for locking dirtied objects.
`boolean`	`hasFetchGroup(String group)` Return true if the given fetch group has been added.
`boolean`	`hasField(String field)` Return true if the given fully-qualified field has been added.
`int`	`hashCode()`
`boolean`	`isHintSet(String key)` Affirm if the given hint has been set in this receiver.
`void`	`lock()` Synchronize on internal lock if multithreaded is true.
`ResultList`	`newResultList(ResultObjectProvider rop)` Return a new result list for the current fetch configuration.
`FetchConfiguration`	`removeFetchGroup(String group)` Remove the given fetch group.
`FetchConfiguration`	`removeFetchGroups(Collection groups)` Removes `groups` from the set of fetch group names to use when loading objects.
`FetchConfiguration`	`removeField(String field)` Remove the given fully-qualified field.
`FetchConfiguration`	`removeFields(Collection fields)` Removes `fields` from the set of fully-qualified field names to use when loading objects.
`int`	`requiresFetch(FieldMetaData fmd)` Affirms if the given field requires to be fetched in the context of current fetch operation.
`boolean`	`requiresLoad()` Return false if we know that the object being fetched with this configuration does not require a load, because this configuration came from a traversal of a `FetchConfiguration.FETCH_REF` field.
`FetchConfiguration`	`resetFetchGroups()` Resets the set of fetch groups to the list in the global configuration.
`void`	`setCacheRetrieveMode(DataCacheRetrieveMode mode)` Sets the current retrieve mode for data cache.
`void`	`setCacheStoreMode(DataCacheStoreMode mode)` Sets the current storage mode for data cache.
`void`	`setContext(StoreContext ctx)` Called automatically by the system to associate the fetch configuration with a context before use.
`FetchConfiguration`	`setExtendedPathLookup(boolean flag)` Sets extended path lookup feature.
`FetchConfiguration`	`setFetchBatchSize(int fetchBatchSize)` Set the fetch batch size for large result set support.
`FetchConfiguration`	`setFlushBeforeQueries(int flush)` The query automatic flush configuration.
`void`	`setHint(String name, Object value)` Sets an arbitrary query hint that may be utilized during execution.
`void`	`setHint(String name, Object value, Object original)` Sets an arbitrary query hint that may be utilized during execution.
`FetchConfiguration`	`setLockScope(int scope)` The lock scope for next fetch.
`FetchConfiguration`	`setLockTimeout(int timeout)` The number of milliseconds to wait for an object lock, or -1 for no limit.
`FetchConfiguration`	`setMaxFetchDepth(int depth)` Set the maximum depth of the fetched instance graph.
`FetchConfiguration`	`setQueryCacheEnabled(boolean cache)` Control whether or not query caching is enabled.
`FetchConfiguration`	`setQueryTimeout(int timeout)` The number of milliseconds to wait for a query, or -1 for no limit.
`FetchConfiguration`	`setReadLockLevel(int level)` The lock level to use for locking loaded objects.
`FetchConfiguration`	`setRootClasses(Collection roots)` Root classes for recursive operations.
`FetchConfiguration`	`setRootInstances(Collection roots)` Root instances for recursive operations.
`FetchConfiguration`	`setWriteLockLevel(int level)` The lock level to use for locking dirtied objects.
`protected RuntimeException`	`translate(RuntimeException re)` Translate the OpenJPA exception.
`FetchConfiguration`	`traverse(FieldMetaData fmd)` Traverse the given field to generate (possibly) a new configuration state.
`void`	`unlock()` Release internal lock if multithreaded is true.

Methods inherited from class java.lang.Object
`finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

DelegatingFetchConfiguration

public DelegatingFetchConfiguration(FetchConfiguration fetch)

Constructor; supply delegate.

DelegatingFetchConfiguration

public DelegatingFetchConfiguration(FetchConfiguration fetch,
                                    RuntimeExceptionTranslator trans)

Constructor; supply delegate and exception translator.

Method Detail

getDelegate

public FetchConfiguration getDelegate()

Return the direct delegate.

getInnermostDelegate

public FetchConfiguration getInnermostDelegate()

Return the native delegate.

hashCode

public int hashCode()

Overrides:: hashCode in class Object

equals

public boolean equals(Object other)

Overrides:: equals in class Object

translate

protected RuntimeException translate(RuntimeException re)

Translate the OpenJPA exception.