|
SolarMetric Kodo JDO 3.3.5 generated on August 31 2005 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Allows configuration and optimization of how objects are loaded from the data store.
Field Summary | |
static int |
DEFAULT
Constant to revert any setting back to its default value. |
static int |
EAGER_FETCH_MULTIPLE
Deprecated. Use EAGER_PARALLEL |
static int |
EAGER_FETCH_NONE
Deprecated. Use EAGER_NONE |
static int |
EAGER_FETCH_SINGLE
Deprecated. Use EAGER_JOIN |
static int |
EAGER_JOIN
Constant indicating to load relations and subclass data if possible without separate queries. |
static int |
EAGER_NONE
Constant indicating not to try to load subclass data and related objects when querying for an object. |
static int |
EAGER_PARALLEL
Constant indicating to load relations and subclass data if possible using either "joins" or parallel queries. |
static String |
FETCH_GROUP_ALL
Special fetch group name that is used by Kodo to indicate that all fetch groups should be loaded by this configuration. |
static int |
LOCK_NONE
No lock. |
static int |
LOCK_READ
Generic read lock level. |
static int |
LOCK_WRITE
Generic write lock level. |
static int |
QUERY_FLUSH_FALSE
Constant denoting that queries should never flush data to the database automatically before executing a query, but should instead execute queries in-memory if necessary. |
static int |
QUERY_FLUSH_TRUE
Constant denoting that queries should flush data to the database automatically whenever Kodo determines that relevant modifications have been made and IgnoreCache is false . |
static int |
QUERY_FLUSH_WITH_CONNECTION
Constant denoting that queries should flush data to the database automatically when Kodo determines that relevant modifications have been made and the current PersistenceManager already has a dedicated connection. |
Method Summary | |
boolean |
addFetchGroup(String group)
Adds group to the set of fetch group names to
use when loading objects. |
boolean |
addFetchGroups(Collection groups)
Adds groups to the set of fetch group names to
use when loading objects. |
boolean |
addFetchGroups(String[] groups)
Adds groups to the set of fetch group names to
use when loading objects. |
boolean |
addField(Class cls,
String field)
Adds field to the set of field names to
use when loading objects. |
boolean |
addField(String field)
Adds field to the set of fully-qualified field names to
use when loading objects. |
boolean |
addFields(Class cls,
Collection fields)
Adds fields to the set of field names to
use when loading objects. |
boolean |
addFields(Class cls,
String[] fields)
Adds fields to the set of field names to
use when loading objects. |
boolean |
addFields(Collection fields)
Adds fields to the set of fully-qualified field names to
use when loading objects. |
boolean |
addFields(String[] fields)
Adds fields to the set of fully-qualified field names to
use when loading objects. |
void |
clearFetchGroups()
Clears the set of fetch group names to use wen loading data. |
void |
clearFields()
Clears the set of field names to use wen loading data. |
Object |
clone()
Fetch configurations are cloneable. |
void |
copy(FetchConfiguration fetch)
Copy the state from the given fetch configuration to this one. |
int |
getEagerFetchMode()
Return the eager fetch mode. |
int |
getFetchBatchSize()
Return the fetch batch size for large result set support. |
String[] |
getFetchGroups()
Returns the names of the fetch groups that this component will use when loading objects. |
String[] |
getFields()
Returns the names of the fields that this component will use when loading objects. |
int |
getFlushBeforeQueries()
The query automatic flush configuration. |
int |
getLockTimeout()
The number of milliseconds to wait for an object lock, or -1 for no limit. |
KodoPersistenceManager |
getPersistenceManager()
Return the persistence manager assiciated with this configuration; may be null if it has not been set or this object has been serialized. |
int |
getReadLockLevel()
The lock level to use for locking loaded objects. |
int |
getSubclassFetchMode()
Return the subclass fetch mode. |
int |
getWriteLockLevel()
The lock level to use for locking dirtied objects. |
boolean |
hasFetchGroup(String group)
Return true if the given fetch group has been added. |
boolean |
hasField(Class cls,
String field)
Return true if the given field has been added. |
boolean |
hasField(String field)
Return true if the given fully-qualified field has been added. |
boolean |
isQueryCacheEnabled()
Return whether or not query caching is enabled. |
ResultList |
newResultList(ResultObjectProvider rop)
Return a new result list for the current fetch configuration. |
boolean |
removeFetchGroup(String group)
Remove the given fetch group. |
boolean |
removeFetchGroups(Collection groups)
Removes groups from the set of fetch group names
to use when loading objects. |
boolean |
removeFetchGroups(String[] groups)
Removes groups from the set of fetch group names
to use when loading objects. |
boolean |
removeField(Class cls,
String field)
Remove the given field. |
boolean |
removeField(String field)
Remove the given fully-qualified field. |
boolean |
removeFields(Class cls,
Collection fields)
Removes fields from the set of field names
to use when loading objects. |
boolean |
removeFields(Class cls,
String[] fields)
Removes fields from the set of field names
to use when loading objects. |
boolean |
removeFields(Collection fields)
Removes fields from the set of fully-qualified field names
to use when loading objects. |
boolean |
removeFields(String[] fields)
Removes fields from the set of fully-qualified field names
to use when loading objects. |
void |
resetFetchGroups()
Resets the set of fetch groups to the list in the global configuration. |
void |
setEagerFetchMode(int mode)
Set the eager fetch mode. |
void |
setFetchBatchSize(int fetchBatchSize)
Set the fetch batch size for large result set support. |
void |
setFlushBeforeQueries(int flush)
The query automatic flush configuration. |
void |
setLockTimeout(int timeout)
The number of milliseconds to wait for an object lock, or -1 for no limit. |
void |
setPersistenceManager(KodoPersistenceManager pm)
Called automatically by the system to associate the fetch configuration with a persistence manager before use. |
void |
setQueryCacheEnabled(boolean cache)
Control whether or not query caching is enabled. |
void |
setReadLockLevel(int level)
The lock level to use for locking loaded objects. |
void |
setSubclassFetchMode(int mode)
Set the subclass fetch mode. |
void |
setWriteLockLevel(int level)
The lock level to use for locking dirtied objects. |
Field Detail |
public static final int DEFAULT
public static final int EAGER_NONE
public static final int EAGER_JOIN
public static final int EAGER_PARALLEL
public static final int EAGER_FETCH_NONE
EAGER_NONE
public static final int EAGER_FETCH_SINGLE
EAGER_JOIN
public static final int EAGER_FETCH_MULTIPLE
EAGER_PARALLEL
public static final int QUERY_FLUSH_TRUE
false
. See JDOConfiguration.getFlushBeforeQueries()
for more info.public static final int QUERY_FLUSH_FALSE
JDOConfiguration.getFlushBeforeQueries()
for more info.public static final int QUERY_FLUSH_WITH_CONNECTION
JDOConfiguration.getFlushBeforeQueries()
for more info.public static final int LOCK_NONE
KodoPersistenceManager.LOCK_NONE
public static final int LOCK_READ
KodoPersistenceManager.LOCK_READ
public static final int LOCK_WRITE
KodoPersistenceManager.LOCK_WRITE
public static final String FETCH_GROUP_ALL
Method Detail |
public KodoPersistenceManager getPersistenceManager()
public void setPersistenceManager(KodoPersistenceManager pm)
public int getEagerFetchMode()
kodo.EagerFetchMode
setting.public void setEagerFetchMode(int mode)
kodo.EagerFetchMode
setting.public int getSubclassFetchMode()
kodo.SubclassFetchMode
setting.public void setSubclassFetchMode(int mode)
kodo.SubclassFetchMode
setting.public int getFetchBatchSize()
kodo.FetchBatchSize
setting. Note
that this property will be ignored under some data stores.public void setFetchBatchSize(int fetchBatchSize)
kodo.FetchBatchSize
setting. Note
that this property will be ignored under some data stores.public boolean isQueryCacheEnabled()
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 void setQueryCacheEnabled(boolean cache)
public int getFlushBeforeQueries()
public void setFlushBeforeQueries(int flush)
public String[] getFetchGroups()
kodo.FetchGroups
setting.public boolean hasFetchGroup(String group)
public boolean addFetchGroup(String group)
group
to the set of fetch group names to
use when loading objects.true
if group
was added;
false
if group
was already
in the fetch group setpublic boolean addFetchGroups(String[] groups)
groups
to the set of fetch group names to
use when loading objects.true
if the set of fetch group names to
load was updated as a result of this operationpublic boolean addFetchGroups(Collection groups)
groups
to the set of fetch group names to
use when loading objects.true
if the set of fetch group names to
load was updated as a result of this operationpublic boolean removeFetchGroup(String group)
public boolean removeFetchGroups(String[] groups)
groups
from the set of fetch group names
to use when loading objects.true
if the set of fetch group names to
load was updated as a result of this operationpublic boolean removeFetchGroups(Collection groups)
groups
from the set of fetch group names
to use when loading objects.true
if the set of fetch group names to
load was updated as a result of this operationpublic void clearFetchGroups()
public void resetFetchGroups()
public String[] getFields()
public boolean hasField(String field)
public boolean hasField(Class cls, String field)
public boolean addField(String field)
field
to the set of fully-qualified field names to
use when loading objects.true
if field
was added;
false
if field
was already
in the field setpublic boolean addField(Class cls, String field)
field
to the set of field names to
use when loading objects.true
if field
was added;
false
if field
was already
in the field setpublic boolean addFields(String[] fields)
fields
to the set of fully-qualified field names to
use when loading objects.true
if the set of field names to
load was updated as a result of this operationpublic boolean addFields(Class cls, String[] fields)
fields
to the set of field names to
use when loading objects.true
if the set of field names to
load was updated as a result of this operationpublic boolean addFields(Collection fields)
fields
to the set of fully-qualified field names to
use when loading objects.true
if the set of field names to
load was updated as a result of this operationpublic boolean addFields(Class cls, Collection fields)
fields
to the set of field names to
use when loading objects.true
if the set of field names to
load was updated as a result of this operationpublic boolean removeField(String field)
public boolean removeField(Class cls, String field)
public boolean removeFields(String[] fields)
fields
from the set of fully-qualified field names
to use when loading objects.true
if the set of field names to
load was updated as a result of this operationpublic boolean removeFields(Class cls, String[] fields)
fields
from the set of field names
to use when loading objects.true
if the set of field names to
load was updated as a result of this operationpublic boolean removeFields(Collection fields)
fields
from the set of fully-qualified field names
to use when loading objects.true
if the set of field names to
load was updated as a result of this operationpublic boolean removeFields(Class cls, Collection fields)
fields
from the set of field names
to use when loading objects.true
if the set of field names to
load was updated as a result of this operationpublic void clearFields()
public int getLockTimeout()
public void setLockTimeout(int timeout)
public int getReadLockLevel()
public void setReadLockLevel(int level)
public int getWriteLockLevel()
public void setWriteLockLevel(int level)
public ResultList newResultList(ResultObjectProvider rop)
public void copy(FetchConfiguration fetch)
public Object clone()
clone
in class Object
|
SolarMetric Kodo JDO 3.3.5 generated on August 31 2005 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |