|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.openjpa.persistence.FetchPlan
public class FetchPlan
The fetch plan allows you to dynamically alter eager fetching configuration and other aspects of data loading.
Field Summary | |
---|---|
static int |
DEFAULT
Constant to revert any setting to its default value. |
static int |
DEPTH_INFINITE
Infinite fetch depth. |
static java.lang.String |
GROUP_ALL
Fetch group representing all fields. |
static java.lang.String |
GROUP_DEFAULT
The default fetch group. |
Constructor Summary | |
---|---|
FetchPlan(org.apache.openjpa.kernel.FetchConfiguration fetch)
Constructor; supply delegate. |
Method Summary | |
---|---|
FetchPlan |
addFetchGroup(java.lang.String group)
Adds group to the set of fetch group to
use when loading objects. |
FetchPlan |
addFetchGroups(java.util.Collection groups)
Adds groups to the set of fetch group names to
use when loading objects. |
FetchPlan |
addFetchGroups(java.lang.String... groups)
Adds groups to the set of fetch group names to
use when loading objects. |
FetchPlan |
addField(java.lang.Class cls,
java.lang.String field)
Adds field to the set of field names to
use when loading objects. |
FetchPlan |
addField(java.lang.String field)
Adds field to the set of fully-qualified field names to
use when loading objects. |
FetchPlan |
addFields(java.lang.Class cls,
java.util.Collection fields)
Adds fields to the set of field names to
use when loading objects. |
FetchPlan |
addFields(java.lang.Class cls,
java.lang.String... fields)
Adds fields to the set of field names to
use when loading objects. |
FetchPlan |
addFields(java.util.Collection fields)
Adds fields to the set of fully-qualified field names to
use when loading objects. |
FetchPlan |
addFields(java.lang.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(java.lang.Object other)
|
org.apache.openjpa.kernel.FetchConfiguration |
getDelegate()
Delegate. |
int |
getFetchBatchSize()
Return the fetch batch size for large result set support. |
java.util.Collection<java.lang.String> |
getFetchGroups()
Returns the names of the fetch groups that this component will use when loading objects. |
java.util.Collection<java.lang.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. |
javax.persistence.LockModeType |
getReadLockMode()
The lock level to use for locking loaded objects. |
javax.persistence.LockModeType |
getWriteLockMode()
The lock level to use for locking dirtied objects. |
boolean |
hasField(java.lang.Class cls,
java.lang.String field)
Return true if the given field has been added. |
boolean |
hasField(java.lang.String field)
Return true if the given field has been added. |
int |
hashCode()
|
protected org.apache.openjpa.kernel.DelegatingFetchConfiguration |
newDelegatingFetchConfiguration(org.apache.openjpa.kernel.FetchConfiguration fetch)
Create a new exception-translating delegating fetch configuration. |
FetchPlan |
removeFetchGroup(java.lang.String group)
Remove the given fetch group. |
FetchPlan |
removeFetchGroups(java.util.Collection groups)
Removes groups from the set of fetch group names
to use when loading objects. |
FetchPlan |
removeFetchGroups(java.lang.String... groups)
Removes groups from the set of fetch group names
to use when loading objects. |
FetchPlan |
removeField(java.lang.Class cls,
java.lang.String field)
Remove the given field. |
FetchPlan |
removeField(java.lang.String field)
Remove the given fully-qualified field. |
FetchPlan |
removeFields(java.lang.Class cls,
java.util.Collection fields)
Removes fields from the set of field names
to use when loading objects. |
FetchPlan |
removeFields(java.lang.Class cls,
java.lang.String... fields)
Removes fields from the set of field names
to use when loading objects. |
FetchPlan |
removeFields(java.util.Collection fields)
Removes fields from the set of fully-qualified field names
to use when loading objects. |
FetchPlan |
removeFields(java.lang.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(javax.persistence.LockModeType mode)
The lock level to use for locking loaded objects. |
FetchPlan |
setWriteLockMode(javax.persistence.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 |
Field Detail |
---|
public static final java.lang.String GROUP_ALL
public static final java.lang.String GROUP_DEFAULT
public static final int DEPTH_INFINITE
public static final int DEFAULT
Constructor Detail |
---|
public FetchPlan(org.apache.openjpa.kernel.FetchConfiguration fetch)
Method Detail |
---|
protected org.apache.openjpa.kernel.DelegatingFetchConfiguration newDelegatingFetchConfiguration(org.apache.openjpa.kernel.FetchConfiguration fetch)
public org.apache.openjpa.kernel.FetchConfiguration getDelegate()
public int getMaxFetchDepth()
public FetchPlan setMaxFetchDepth(int depth)
public int getFetchBatchSize()
openjpa.FetchBatchSize
setting. Note
that this property will be ignored under some data stores.
public FetchPlan setFetchBatchSize(int fetchBatchSize)
openjpa.FetchBatchSize
setting. Note
that this property will be ignored under some data stores.
public boolean getQueryResultCache()
true
but the datacache plugin is not installed, caching
will not be enabled. If this
returns false
, query caching will not be used
even if the datacache plugin is installed.
public FetchPlan setQueryResultCache(boolean cache)
public java.util.Collection<java.lang.String> getFetchGroups()
org.apache.openjpa.FetchGroups
setting.
public FetchPlan addFetchGroup(java.lang.String group)
group
to the set of fetch group to
use when loading objects.
public FetchPlan addFetchGroups(java.lang.String... groups)
groups
to the set of fetch group names to
use when loading objects.
public FetchPlan addFetchGroups(java.util.Collection groups)
groups
to the set of fetch group names to
use when loading objects.
public FetchPlan removeFetchGroup(java.lang.String group)
public FetchPlan removeFetchGroups(java.lang.String... groups)
groups
from the set of fetch group names
to use when loading objects.
public FetchPlan removeFetchGroups(java.util.Collection groups)
groups
from the set of fetch group names
to use when loading objects.
public FetchPlan clearFetchGroups()
public FetchPlan resetFetchGroups()
public java.util.Collection<java.lang.String> getFields()
public boolean hasField(java.lang.String field)
public boolean hasField(java.lang.Class cls, java.lang.String field)
public FetchPlan addField(java.lang.String field)
field
to the set of fully-qualified field names to
use when loading objects.
public FetchPlan addField(java.lang.Class cls, java.lang.String field)
field
to the set of field names to
use when loading objects.
public FetchPlan addFields(java.lang.String... fields)
fields
to the set of fully-qualified field names to
use when loading objects.
public FetchPlan addFields(java.lang.Class cls, java.lang.String... fields)
fields
to the set of field names to
use when loading objects.
public FetchPlan addFields(java.util.Collection fields)
fields
to the set of fully-qualified field names to
use when loading objects.
public FetchPlan addFields(java.lang.Class cls, java.util.Collection fields)
fields
to the set of field names to
use when loading objects.
public FetchPlan removeField(java.lang.String field)
public FetchPlan removeField(java.lang.Class cls, java.lang.String field)
public FetchPlan removeFields(java.lang.String... fields)
fields
from the set of fully-qualified field names
to use when loading objects.
public FetchPlan removeFields(java.lang.Class cls, java.lang.String... fields)
fields
from the set of field names
to use when loading objects.
public FetchPlan removeFields(java.util.Collection fields)
fields
from the set of fully-qualified field names
to use when loading objects.
public FetchPlan removeFields(java.lang.Class cls, java.util.Collection fields)
fields
from the set of field names
to use when loading objects.
public FetchPlan clearFields()
public int getLockTimeout()
public FetchPlan setLockTimeout(int timeout)
public javax.persistence.LockModeType getReadLockMode()
public FetchPlan setReadLockMode(javax.persistence.LockModeType mode)
public javax.persistence.LockModeType getWriteLockMode()
public FetchPlan setWriteLockMode(javax.persistence.LockModeType mode)
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |