|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.openjpa.persistence.FetchPlanImpl
public class FetchPlanImpl
Implements FetchPlan via delegation to FetchConfiguration.
| Field Summary | |
|---|---|
protected static Map<String,HintValueConverter[]> |
_hints
Structure holds one or more converters for a user-specified hint value. |
protected static Map<String,List<String>> |
_precedence
Structure holds ranking of equivalent hint keys. |
| 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. |
(package private) Object |
convertHintValue(String key,
Object value)
|
boolean |
equals(Object other)
|
DataCacheRetrieveMode |
getCacheRetrieveMode()
Gets the current retrieve mode for data cache. |
DataCacheStoreMode |
getCacheStoreMode()
Gets the current storage mode for data cache. |
FetchConfiguration |
getDelegate()
Delegate. |
boolean |
getExtendedPathLookup()
Affirms if extended path lookup feature is active. |
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. |
Object |
getHint(String key)
Get the hint value for the given key. |
Map<String,Object> |
getHints()
Get the hints and their values currently set on this receiver. |
PessimisticLockScope |
getLockScope()
The lock scope to use for locking loaded 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()
|
boolean |
getQueryResultCacheEnabled()
Return whether or not query caching is enabled. |
int |
getQueryTimeout()
The number of milliseconds to wait for a query, or -1 for no limit. |
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()
|
(package private) boolean |
intersects(Collection<String> keys,
Collection<String> b)
|
(package private) boolean |
isRecognizedHint(String key)
|
protected DelegatingFetchConfiguration |
newDelegatingFetchConfiguration(FetchConfiguration fetch)
Create a new exception-translating delegating fetch configuration. |
protected static void |
registerHint(String[] keys,
HintValueConverter... converters)
Registers a hint key with its value converters. |
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 |
setCacheRetrieveMode(DataCacheRetrieveMode mode)
Sets the current retrieve mode for data cache. |
FetchPlan |
setCacheStoreMode(DataCacheStoreMode mode)
Sets the current storage mode for data cache. |
FetchPlan |
setExtendedPathLookup(boolean flag)
Sets extended path lookup feature. |
FetchPlan |
setFetchBatchSize(int fetchBatchSize)
Set the fetch batch size for large result set support. |
void |
setHint(String key,
Object value)
Sets the hint after converting the value appropriately. |
void |
setHints(Map<String,Object> hints)
|
FetchPlan |
setLockScope(PessimisticLockScope scope)
The lock scope to use for locking loaded objects. |
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)
|
FetchPlan |
setQueryResultCacheEnabled(boolean cache)
Control whether or not query caching is enabled. |
FetchPlan |
setQueryTimeout(int timeout)
The number of milliseconds to wait for a query, or -1 for no limit. |
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 |
| Field Detail |
|---|
protected static Map<String,List<String>> _precedence
protected static Map<String,HintValueConverter[]> _hints
| Constructor Detail |
|---|
public FetchPlanImpl(FetchConfiguration fetch)
| Method Detail |
|---|
protected static void registerHint(String[] keys,
HintValueConverter... converters)
keys - a set of keys in increasing order of ranking. Can not be null or empty.converters - array of converters that are attempts in order to convert a user-specified hint value
to a value that is consumable by the kernel.protected DelegatingFetchConfiguration newDelegatingFetchConfiguration(FetchConfiguration fetch)
public FetchConfiguration getDelegate()
getDelegate in interface FetchPlanpublic int getMaxFetchDepth()
FetchPlan
getMaxFetchDepth in interface FetchPlanpublic FetchPlan setMaxFetchDepth(int depth)
FetchPlan
setMaxFetchDepth in interface FetchPlanpublic int getFetchBatchSize()
FetchPlanopenjpa.FetchBatchSize setting. Note
that this property will be ignored under some data stores.
getFetchBatchSize in interface FetchPlanpublic FetchPlan setFetchBatchSize(int fetchBatchSize)
FetchPlanopenjpa.FetchBatchSize setting. Note
that this property will be ignored under some data stores.
setFetchBatchSize in interface FetchPlanpublic boolean getQueryResultCacheEnabled()
FetchPlantrue 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.
getQueryResultCacheEnabled in interface FetchPlanpublic FetchPlan setQueryResultCacheEnabled(boolean cache)
FetchPlan
setQueryResultCacheEnabled in interface FetchPlanpublic boolean getQueryResultCache()
getQueryResultCache in interface FetchPlanpublic FetchPlan setQueryResultCache(boolean cache)
setQueryResultCache in interface FetchPlanpublic Collection<String> getFetchGroups()
FetchPlanopenjpa.FetchGroups setting.
getFetchGroups in interface FetchPlanpublic FetchPlan addFetchGroup(String group)
FetchPlangroup to the set of fetch group to
use when loading objects.
addFetchGroup in interface FetchPlanpublic FetchPlan addFetchGroups(String... groups)
FetchPlangroups to the set of fetch group names to
use when loading objects.
addFetchGroups in interface FetchPlanpublic FetchPlan addFetchGroups(Collection groups)
FetchPlangroups to the set of fetch group names to
use when loading objects.
addFetchGroups in interface FetchPlanpublic FetchPlan removeFetchGroup(String group)
FetchPlan
removeFetchGroup in interface FetchPlanpublic FetchPlan removeFetchGroups(String... groups)
FetchPlangroups from the set of fetch group names
to use when loading objects.
removeFetchGroups in interface FetchPlanpublic FetchPlan removeFetchGroups(Collection groups)
FetchPlangroups from the set of fetch group names
to use when loading objects.
removeFetchGroups in interface FetchPlanpublic FetchPlan clearFetchGroups()
FetchPlan
clearFetchGroups in interface FetchPlanpublic FetchPlan resetFetchGroups()
FetchPlan
resetFetchGroups in interface FetchPlanpublic Collection<String> getFields()
FetchPlan
getFields in interface FetchPlanpublic boolean hasField(String field)
FetchPlan
hasField in interface FetchPlan
public boolean hasField(Class cls,
String field)
FetchPlan
hasField in interface FetchPlanpublic FetchPlan addField(String field)
FetchPlanfield to the set of fully-qualified field names to
use when loading objects.
addField in interface FetchPlan
public FetchPlan addField(Class cls,
String field)
FetchPlanfield to the set of field names to
use when loading objects.
addField in interface FetchPlanpublic FetchPlan addFields(String... fields)
FetchPlanfields to the set of fully-qualified field names to
use when loading objects.
addFields in interface FetchPlan
public FetchPlan addFields(Class cls,
String... fields)
FetchPlanfields to the set of field names to
use when loading objects.
addFields in interface FetchPlanpublic FetchPlan addFields(Collection fields)
FetchPlanfields to the set of fully-qualified field names to
use when loading objects.
addFields in interface FetchPlan
public FetchPlan addFields(Class cls,
Collection fields)
FetchPlanfields to the set of field names to
use when loading objects.
addFields in interface FetchPlanpublic FetchPlan removeField(String field)
FetchPlan
removeField in interface FetchPlan
public FetchPlan removeField(Class cls,
String field)
FetchPlan
removeField in interface FetchPlanpublic FetchPlan removeFields(String... fields)
FetchPlanfields from the set of fully-qualified field names
to use when loading objects.
removeFields in interface FetchPlan
public FetchPlan removeFields(Class cls,
String... fields)
FetchPlanfields from the set of field names
to use when loading objects.
removeFields in interface FetchPlanpublic FetchPlan removeFields(Collection fields)
FetchPlanfields from the set of fully-qualified field names
to use when loading objects.
removeFields in interface FetchPlan
public FetchPlan removeFields(Class cls,
Collection fields)
FetchPlanfields from the set of field names
to use when loading objects.
removeFields in interface FetchPlanpublic FetchPlan clearFields()
FetchPlan
clearFields in interface FetchPlanpublic int getLockTimeout()
FetchPlan
getLockTimeout in interface FetchPlanpublic FetchPlan setLockTimeout(int timeout)
FetchPlan
setLockTimeout in interface FetchPlanpublic PessimisticLockScope getLockScope()
FetchPlan
getLockScope in interface FetchPlanpublic FetchPlan setLockScope(PessimisticLockScope scope)
FetchPlan
setLockScope in interface FetchPlanpublic int getQueryTimeout()
FetchPlan
getQueryTimeout in interface FetchPlanpublic FetchPlan setQueryTimeout(int timeout)
FetchPlan
setQueryTimeout in interface FetchPlanpublic LockModeType getReadLockMode()
FetchPlan
getReadLockMode in interface FetchPlanpublic FetchPlan setReadLockMode(LockModeType mode)
FetchPlan
setReadLockMode in interface FetchPlanpublic LockModeType getWriteLockMode()
FetchPlan
getWriteLockMode in interface FetchPlanpublic FetchPlan setWriteLockMode(LockModeType mode)
FetchPlan
setWriteLockMode in interface FetchPlanpublic boolean getExtendedPathLookup()
FetchPlan
getExtendedPathLookup in interface FetchPlanpublic FetchPlan setExtendedPathLookup(boolean flag)
FetchPlan
setExtendedPathLookup in interface FetchPlanpublic Object getHint(String key)
FetchPlan
getHint in interface FetchPlan
public void setHint(String key,
Object value)
setHint in interface FetchPlanvalue - the value of the hint.public void setHints(Map<String,Object> hints)
public Map<String,Object> getHints()
FetchPlan
getHints in interface FetchPlanpublic int hashCode()
hashCode in class Objectpublic boolean equals(Object other)
equals in class Objectpublic DataCacheRetrieveMode getCacheRetrieveMode()
FetchPlan
getCacheRetrieveMode in interface FetchPlanpublic DataCacheStoreMode getCacheStoreMode()
FetchPlan
getCacheStoreMode in interface FetchPlanpublic FetchPlan setCacheStoreMode(DataCacheStoreMode mode)
FetchPlan
setCacheStoreMode in interface FetchPlanpublic FetchPlan setCacheRetrieveMode(DataCacheRetrieveMode mode)
FetchPlan
setCacheRetrieveMode in interface FetchPlan
Object convertHintValue(String key,
Object value)
boolean isRecognizedHint(String key)
boolean intersects(Collection<String> keys,
Collection<String> b)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||