FetchPlanImpl (OpenJPA 0.9.7-incubating 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.persistence
Class FetchPlanImpl

java.lang.Object
  org.apache.openjpa.persistence.FetchPlanImpl

All Implemented Interfaces:: FetchPlan

Direct Known Subclasses:: JDBCFetchPlanImpl

public class FetchPlanImpl
extends Object
implements FetchPlan
extends Object
implements FetchPlan

Implements FetchPlan via delegation to FetchConfiguration.

Since:: 0.4.1
Author:: Abe White, Pinaki Poddar

Field Summary

Fields inherited from interface org.apache.openjpa.persistence.FetchPlan
`DEFAULT, DEPTH_INFINITE, GROUP_ALL, GROUP_DEFAULT`

Constructor Summary
`FetchPlanImpl(FetchConfiguration fetch)` Constructor; supply delegate.

Method Summary
`FetchPlan`	`addFetchGroup(String group)` Adds `group` to the set of fetch group to use when loading objects.
`FetchPlan`	`addFetchGroups(Collection groups)` Adds `groups` to the set of fetch group names to use when loading objects.
`FetchPlan`	`addFetchGroups(String... groups)` Adds `groups` to the set of fetch group names to use when loading objects.
`FetchPlan`	`addField(Class cls, String field)` Adds `field` to the set of field names to use when loading objects.
`FetchPlan`	`addField(String field)` Adds `field` to the set of fully-qualified field names to use when loading objects.
`FetchPlan`	`addFields(Class cls, Collection fields)` Adds `fields` to the set of field names to use when loading objects.
`FetchPlan`	`addFields(Class cls, String... fields)` Adds `fields` to the set of field names to use when loading objects.
`FetchPlan`	`addFields(Collection fields)` Adds `fields` to the set of fully-qualified field names to use when loading objects.
`FetchPlan`	`addFields(String... fields)` Adds `fields` to the set of fully-qualified field names to use when loading objects.
`FetchPlan`	`clearFetchGroups()` Clears the set of fetch group names to use wen loading data.
`FetchPlan`	`clearFields()` Clears the set of field names to use wen loading data.
`boolean`	`equals(Object other)`
`FetchConfiguration`	`getDelegate()` Delegate.
`int`	`getFetchBatchSize()` Return the fetch batch size for large result set support.
`Collection<String>`	`getFetchGroups()` Returns the names of the fetch groups that this component will use when loading objects.
`Collection<String>`	`getFields()` Returns the fully qualified names of the fields that this component will use when loading objects.
`int`	`getLockTimeout()` The number of milliseconds to wait for an object lock, or -1 for no limit.
`int`	`getMaxFetchDepth()` The maximum fetch depth when loading an object.
`boolean`	`getQueryResultCache()` Return whether or not query caching is enabled.
`LockModeType`	`getReadLockMode()` The lock level to use for locking loaded objects.
`LockModeType`	`getWriteLockMode()` The lock level to use for locking dirtied objects.
`boolean`	`hasField(Class cls, String field)` Return true if the given field has been added.
`boolean`	`hasField(String field)` Return true if the given field has been added.
`int`	`hashCode()`
`protected DelegatingFetchConfiguration`	`newDelegatingFetchConfiguration(FetchConfiguration fetch)` Create a new exception-translating delegating fetch configuration.
`FetchPlan`	`removeFetchGroup(String group)` Remove the given fetch group.
`FetchPlan`	`removeFetchGroups(Collection groups)` Removes `groups` from the set of fetch group names to use when loading objects.
`FetchPlan`	`removeFetchGroups(String... groups)` Removes `groups` from the set of fetch group names to use when loading objects.
`FetchPlan`	`removeField(Class cls, String field)` Remove the given field.
`FetchPlan`	`removeField(String field)` Remove the given fully-qualified field.
`FetchPlan`	`removeFields(Class cls, Collection fields)` Removes `fields` from the set of field names to use when loading objects.
`FetchPlan`	`removeFields(Class cls, String... fields)` Removes `fields` from the set of field names to use when loading objects.
`FetchPlan`	`removeFields(Collection fields)` Removes `fields` from the set of fully-qualified field names to use when loading objects.
`FetchPlan`	`removeFields(String... fields)` Removes `fields` from the set of fully-qualified field names to use when loading objects.
`FetchPlan`	`resetFetchGroups()` Resets the set of fetch groups to the list in the global configuration.
`FetchPlan`	`setFetchBatchSize(int fetchBatchSize)` Set the fetch batch size for large result set support.
`FetchPlan`	`setLockTimeout(int timeout)` The number of milliseconds to wait for an object lock, or -1 for no limit.
`FetchPlan`	`setMaxFetchDepth(int depth)` The maximum fetch depth when loading an object.
`FetchPlan`	`setQueryResultCache(boolean cache)` Control whether or not query caching is enabled.
`FetchPlan`	`setReadLockMode(LockModeType mode)` The lock level to use for locking loaded objects.
`FetchPlan`	`setWriteLockMode(LockModeType mode)` The lock level to use for locking dirtied objects.

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

Constructor Detail

FetchPlanImpl

public FetchPlanImpl(FetchConfiguration fetch)

Constructor; supply delegate.

Method Detail

newDelegatingFetchConfiguration

protected DelegatingFetchConfiguration newDelegatingFetchConfiguration(FetchConfiguration fetch)

Create a new exception-translating delegating fetch configuration.

getDelegate

public FetchConfiguration getDelegate()

Delegate.

Specified by:: getDelegate in interface FetchPlan