|
Kodo 4.2.0. generated on July 28 2008 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface KodoFetchPlan
Interface implemented by all Kodo fetch plans.
Field Summary | |
---|---|
static int |
DEFAULT_VALUE
Constant to revert any setting back to its default value. |
static int |
DETACH_ALL_FIELDS
Detachment option to detach all fields. |
Fields inherited from interface javax.jdo.FetchPlan |
---|
ALL, DEFAULT, DETACH_LOAD_FIELDS, DETACH_UNLOAD_FIELDS, FETCH_SIZE_GREEDY, FETCH_SIZE_OPTIMAL |
Fields inherited from interface org.apache.openjpa.kernel.LockLevels |
---|
LOCK_NONE, LOCK_READ, LOCK_WRITE |
Fields inherited from interface org.apache.openjpa.kernel.QueryFlushModes |
---|
FLUSH_FALSE, FLUSH_TRUE, FLUSH_WITH_CONNECTION |
Method Summary | |
---|---|
KodoFetchPlan |
addField(Class cls,
String field)
Adds field to the set of field names to
use when loading objects. |
KodoFetchPlan |
addField(String field)
Adds field to the set of fully-qualified field names to
use when loading objects. |
KodoFetchPlan |
clearFields()
Clears the set of field names to use when loading data. |
Set |
getFields()
Returns the names of the fields that this component will use when loading objects, in addition to fetch groups. |
int |
getFlushBeforeQueries()
The query automatic flush configuration. |
int |
getLockTimeout()
The number of milliseconds to wait for an object lock, or -1 for no limit. |
boolean |
getQueryResultCache()
Return whether or not query caching is enabled. |
int |
getReadLockLevel()
The lock level to use for locking loaded objects. |
int |
getWriteLockLevel()
The lock level to use for locking dirtied objects. |
boolean |
hasField(Class cls,
String field)
Return true if the given field has been added. |
KodoFetchPlan |
removeField(Class cls,
String field)
Remove the given field. |
KodoFetchPlan |
removeField(String field)
Remove the given fully-qualified field. |
KodoFetchPlan |
resetGroups()
Resets the set of fetch groups to the list in the global configuration. |
KodoFetchPlan |
setFields(Class cls,
Collection fields)
Sets fields as the set of field names to
use when loading objects. |
KodoFetchPlan |
setFields(Class cls,
String[] fields)
Sets fields as the set of field names to
use when loading objects. |
KodoFetchPlan |
setFields(Collection fields)
Sets fields as the set of fully-qualified field names to
use when loading objects. |
KodoFetchPlan |
setFields(String[] fields)
Sets fields as the set of fully-qualified field names to
use when loading objects. |
KodoFetchPlan |
setFlushBeforeQueries(int flush)
The query automatic flush configuration. |
KodoFetchPlan |
setLockTimeout(int timeout)
The number of milliseconds to wait for an object lock, or -1 for no limit. |
KodoFetchPlan |
setQueryResultCache(boolean cache)
Control whether or not query caching is enabled. |
KodoFetchPlan |
setReadLockLevel(int level)
The lock level to use for locking loaded objects. |
KodoFetchPlan |
setWriteLockLevel(int level)
The lock level to use for locking dirtied objects. |
Methods inherited from interface javax.jdo.FetchPlan |
---|
addGroup, clearGroups, getDetachmentOptions, getDetachmentRootClasses, getDetachmentRoots, getFetchSize, getGroups, getMaxFetchDepth, removeGroup, setDetachmentOptions, setDetachmentRootClasses, setDetachmentRoots, setFetchSize, setGroup, setGroups, setGroups, setMaxFetchDepth |
Field Detail |
---|
static final int DEFAULT_VALUE
static final int DETACH_ALL_FIELDS
Method Detail |
---|
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.
KodoFetchPlan setQueryResultCache(boolean cache)
int getFlushBeforeQueries()
KodoFetchPlan setFlushBeforeQueries(int flush)
KodoFetchPlan resetGroups()
Set getFields()
boolean hasField(Class cls, String field)
KodoFetchPlan addField(String field)
field
to the set of fully-qualified field names to
use when loading objects.
KodoFetchPlan addField(Class cls, String field)
field
to the set of field names to
use when loading objects.
KodoFetchPlan setFields(String[] fields)
fields
as the set of fully-qualified field names to
use when loading objects.
KodoFetchPlan setFields(Class cls, String[] fields)
fields
as the set of field names to
use when loading objects.
KodoFetchPlan setFields(Collection fields)
fields
as the set of fully-qualified field names to
use when loading objects.
KodoFetchPlan setFields(Class cls, Collection fields)
fields
as the set of field names to
use when loading objects.
KodoFetchPlan removeField(String field)
KodoFetchPlan removeField(Class cls, String field)
KodoFetchPlan clearFields()
int getLockTimeout()
KodoFetchPlan setLockTimeout(int timeout)
int getReadLockLevel()
KodoFetchPlan setReadLockLevel(int level)
int getWriteLockLevel()
KodoFetchPlan setWriteLockLevel(int level)
|
Kodo 4.2.0. generated on July 28 2008 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |