|
||||||||||
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 |
---|
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. |
void |
addHint(String key,
Object value)
Adds the hint and the associated value to the list. |
void |
addHints(Map<String,Object> hints)
Sets the hint keys and values currently set of this receiver. |
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. |
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)
Gets the hint for the given key. |
Map<String,Object> |
getHints()
Gets the hint keys and values currently set of this receiver. |
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()
|
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 |
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 for the given key to the given value. |
void |
setHint(String key,
Object value,
boolean validThrowException)
Sets the hint for the given key to the given value. |
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 |
Constructor Detail |
---|
public FetchPlanImpl(FetchConfiguration fetch)
Method Detail |
---|
protected DelegatingFetchConfiguration newDelegatingFetchConfiguration(FetchConfiguration fetch)
public FetchConfiguration getDelegate()
getDelegate
in interface FetchPlan
public int getMaxFetchDepth()
FetchPlan
getMaxFetchDepth
in interface FetchPlan
public FetchPlan setMaxFetchDepth(int depth)
FetchPlan
setMaxFetchDepth
in interface FetchPlan
public int getFetchBatchSize()
FetchPlan
openjpa.FetchBatchSize
setting. Note
that this property will be ignored under some data stores.
getFetchBatchSize
in interface FetchPlan
public FetchPlan setFetchBatchSize(int fetchBatchSize)
FetchPlan
openjpa.FetchBatchSize
setting. Note
that this property will be ignored under some data stores.
setFetchBatchSize
in interface FetchPlan
public boolean getQueryResultCacheEnabled()
FetchPlan
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.
getQueryResultCacheEnabled
in interface FetchPlan
public FetchPlan setQueryResultCacheEnabled(boolean cache)
FetchPlan
setQueryResultCacheEnabled
in interface FetchPlan
public boolean getQueryResultCache()
getQueryResultCache
in interface FetchPlan
public FetchPlan setQueryResultCache(boolean cache)
setQueryResultCache
in interface FetchPlan
public Collection<String> getFetchGroups()
FetchPlan
openjpa.FetchGroups
setting.
getFetchGroups
in interface FetchPlan
public FetchPlan addFetchGroup(String group)
FetchPlan
group
to the set of fetch group to
use when loading objects.
addFetchGroup
in interface FetchPlan
public FetchPlan addFetchGroups(String... groups)
FetchPlan
groups
to the set of fetch group names to
use when loading objects.
addFetchGroups
in interface FetchPlan
public FetchPlan addFetchGroups(Collection groups)
FetchPlan
groups
to the set of fetch group names to
use when loading objects.
addFetchGroups
in interface FetchPlan
public FetchPlan removeFetchGroup(String group)
FetchPlan
removeFetchGroup
in interface FetchPlan
public FetchPlan removeFetchGroups(String... groups)
FetchPlan
groups
from the set of fetch group names
to use when loading objects.
removeFetchGroups
in interface FetchPlan
public FetchPlan removeFetchGroups(Collection groups)
FetchPlan
groups
from the set of fetch group names
to use when loading objects.
removeFetchGroups
in interface FetchPlan
public FetchPlan clearFetchGroups()
FetchPlan
clearFetchGroups
in interface FetchPlan
public FetchPlan resetFetchGroups()
FetchPlan
resetFetchGroups
in interface FetchPlan
public Collection<String> getFields()
FetchPlan
getFields
in interface FetchPlan
public boolean hasField(String field)
FetchPlan
hasField
in interface FetchPlan
public boolean hasField(Class cls, String field)
FetchPlan
hasField
in interface FetchPlan
public FetchPlan addField(String field)
FetchPlan
field
to the set of fully-qualified field names to
use when loading objects.
addField
in interface FetchPlan
public FetchPlan addField(Class cls, String field)
FetchPlan
field
to the set of field names to
use when loading objects.
addField
in interface FetchPlan
public FetchPlan addFields(String... fields)
FetchPlan
fields
to the set of fully-qualified field names to
use when loading objects.
addFields
in interface FetchPlan
public FetchPlan addFields(Class cls, String... fields)
FetchPlan
fields
to the set of field names to
use when loading objects.
addFields
in interface FetchPlan
public FetchPlan addFields(Collection fields)
FetchPlan
fields
to the set of fully-qualified field names to
use when loading objects.
addFields
in interface FetchPlan
public FetchPlan addFields(Class cls, Collection fields)
FetchPlan
fields
to the set of field names to
use when loading objects.
addFields
in interface FetchPlan
public FetchPlan removeField(String field)
FetchPlan
removeField
in interface FetchPlan
public FetchPlan removeField(Class cls, String field)
FetchPlan
removeField
in interface FetchPlan
public FetchPlan removeFields(String... fields)
FetchPlan
fields
from the set of fully-qualified field names
to use when loading objects.
removeFields
in interface FetchPlan
public FetchPlan removeFields(Class cls, String... fields)
FetchPlan
fields
from the set of field names
to use when loading objects.
removeFields
in interface FetchPlan
public FetchPlan removeFields(Collection fields)
FetchPlan
fields
from the set of fully-qualified field names
to use when loading objects.
removeFields
in interface FetchPlan
public FetchPlan removeFields(Class cls, Collection fields)
FetchPlan
fields
from the set of field names
to use when loading objects.
removeFields
in interface FetchPlan
public FetchPlan clearFields()
FetchPlan
clearFields
in interface FetchPlan
public int getLockTimeout()
FetchPlan
getLockTimeout
in interface FetchPlan
public FetchPlan setLockTimeout(int timeout)
FetchPlan
setLockTimeout
in interface FetchPlan
public int getQueryTimeout()
FetchPlan
getQueryTimeout
in interface FetchPlan
public FetchPlan setQueryTimeout(int timeout)
FetchPlan
setQueryTimeout
in interface FetchPlan
public LockModeType getReadLockMode()
FetchPlan
getReadLockMode
in interface FetchPlan
public FetchPlan setReadLockMode(LockModeType mode)
FetchPlan
setReadLockMode
in interface FetchPlan
public LockModeType getWriteLockMode()
FetchPlan
getWriteLockMode
in interface FetchPlan
public FetchPlan setWriteLockMode(LockModeType mode)
FetchPlan
setWriteLockMode
in interface FetchPlan
public boolean getExtendedPathLookup()
FetchPlan
getExtendedPathLookup
in interface FetchPlan
public FetchPlan setExtendedPathLookup(boolean flag)
FetchPlan
setExtendedPathLookup
in interface FetchPlan
public Object getHint(String key)
FetchPlan
getHint
in interface FetchPlan
public void addHint(String key, Object value)
FetchPlan
addHint
in interface FetchPlan
key
- the name of the hintvalue
- the value of the hintpublic void setHint(String key, Object value)
FetchPlan
setHint
in interface FetchPlan
public void setHint(String key, Object value, boolean validThrowException)
FetchPlan
setHint
in interface FetchPlan
public void addHints(Map<String,Object> hints)
FetchPlan
addHints
in interface FetchPlan
public Map<String,Object> getHints()
FetchPlan
getHints
in interface FetchPlan
public int hashCode()
hashCode
in class Object
public boolean equals(Object other)
equals
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |