| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface FetchPlan
The fetch plan allows you to dynamically alter eager fetching configuration and other aspects of data loading.
| Field Summary | |
|---|---|
| static int | DEFAULTConstant to revert any setting to its default value. | 
| static int | DEPTH_INFINITEInfinite fetch depth. | 
| static java.lang.String | GROUP_ALLFetch group representing all fields. | 
| static java.lang.String | GROUP_DEFAULTThe default fetch group. | 
| Method Summary | |
|---|---|
|  FetchPlan | addFetchGroup(java.lang.String group)Adds groupto the set of fetch group to
 use when loading objects. | 
|  FetchPlan | addFetchGroups(java.util.Collection groups)Adds groupsto the set of fetch group names to
 use when loading objects. | 
|  FetchPlan | addFetchGroups(java.lang.String... groups)Adds groupsto the set of fetch group names to
 use when loading objects. | 
|  FetchPlan | addField(java.lang.Class cls,
         java.lang.String field)Adds fieldto the set of field names to
 use when loading objects. | 
|  FetchPlan | addField(java.lang.String field)Adds fieldto the set of fully-qualified field names to
 use when loading objects. | 
|  FetchPlan | addFields(java.lang.Class cls,
          java.util.Collection fields)Adds fieldsto the set of field names to
 use when loading objects. | 
|  FetchPlan | addFields(java.lang.Class cls,
          java.lang.String... fields)Adds fieldsto the set of field names to
 use when loading objects. | 
|  FetchPlan | addFields(java.util.Collection fields)Adds fieldsto the set of fully-qualified field names to
 use when loading objects. | 
|  FetchPlan | addFields(java.lang.String... fields)Adds fieldsto 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. | 
|  FetchConfiguration | getDelegate()Deprecated. cast to FetchPlanImplinstead. This
 method pierces the published-API boundary, as does the SPI cast. | 
|  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()Deprecated. use getQueryResultCacheEnabled()instead. | 
|  boolean | getQueryResultCacheEnabled()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. | 
|  FetchPlan | removeFetchGroup(java.lang.String group)Remove the given fetch group. | 
|  FetchPlan | removeFetchGroups(java.util.Collection groups)Removes groupsfrom the set of fetch group names
 to use when loading objects. | 
|  FetchPlan | removeFetchGroups(java.lang.String... groups)Removes groupsfrom 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 fieldsfrom the set of field names
 to use when loading objects. | 
|  FetchPlan | removeFields(java.lang.Class cls,
             java.lang.String... fields)Removes fieldsfrom the set of field names
 to use when loading objects. | 
|  FetchPlan | removeFields(java.util.Collection fields)Removes fieldsfrom the set of fully-qualified field names
 to use when loading objects. | 
|  FetchPlan | removeFields(java.lang.String... fields)Removes fieldsfrom 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)Deprecated. use setQueryResultCacheEnabled(boolean)instead. | 
|  FetchPlan | setQueryResultCacheEnabled(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. | 
| Field Detail | 
|---|
static final java.lang.String GROUP_ALL
static final java.lang.String GROUP_DEFAULT
static final int DEPTH_INFINITE
static final int DEFAULT
| Method Detail | 
|---|
int getMaxFetchDepth()
FetchPlan setMaxFetchDepth(int depth)
int getFetchBatchSize()
openjpa.FetchBatchSize setting. Note
 that this property will be ignored under some data stores.
FetchPlan setFetchBatchSize(int fetchBatchSize)
openjpa.FetchBatchSize setting. Note
 that this property will be ignored under some data stores.
boolean getQueryResultCacheEnabled()
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.
FetchPlan setQueryResultCacheEnabled(boolean cache)
boolean getQueryResultCache()
getQueryResultCacheEnabled() instead.
FetchPlan setQueryResultCache(boolean cache)
setQueryResultCacheEnabled(boolean) instead.
java.util.Collection<java.lang.String> getFetchGroups()
openjpa.FetchGroups setting.
FetchPlan addFetchGroup(java.lang.String group)
group to the set of fetch group to
 use when loading objects.
FetchPlan addFetchGroups(java.lang.String... groups)
groups to the set of fetch group names to
 use when loading objects.
FetchPlan addFetchGroups(java.util.Collection groups)
groups to the set of fetch group names to
 use when loading objects.
FetchPlan removeFetchGroup(java.lang.String group)
FetchPlan removeFetchGroups(java.lang.String... groups)
groups from the set of fetch group names
 to use when loading objects.
FetchPlan removeFetchGroups(java.util.Collection groups)
groups from the set of fetch group names
 to use when loading objects.
FetchPlan clearFetchGroups()
FetchPlan resetFetchGroups()
java.util.Collection<java.lang.String> getFields()
boolean hasField(java.lang.String field)
boolean hasField(java.lang.Class cls,
                 java.lang.String field)
FetchPlan addField(java.lang.String field)
field to the set of fully-qualified field names to
 use when loading objects.
FetchPlan addField(java.lang.Class cls,
                   java.lang.String field)
field to the set of field names to
 use when loading objects.
FetchPlan addFields(java.lang.String... fields)
fields to the set of fully-qualified field names to
 use when loading objects.
FetchPlan addFields(java.lang.Class cls,
                    java.lang.String... fields)
fields to the set of field names to
 use when loading objects.
FetchPlan addFields(java.util.Collection fields)
fields to the set of fully-qualified field names to
 use when loading objects.
FetchPlan addFields(java.lang.Class cls,
                    java.util.Collection fields)
fields to the set of field names to
 use when loading objects.
FetchPlan removeField(java.lang.String field)
FetchPlan removeField(java.lang.Class cls,
                      java.lang.String field)
FetchPlan removeFields(java.lang.String... fields)
fields from the set of fully-qualified field names
 to use when loading objects.
FetchPlan removeFields(java.lang.Class cls,
                       java.lang.String... fields)
fields from the set of field names
 to use when loading objects.
FetchPlan removeFields(java.util.Collection fields)
fields from the set of fully-qualified field names
 to use when loading objects.
FetchPlan removeFields(java.lang.Class cls,
                       java.util.Collection fields)
fields from the set of field names
 to use when loading objects.
FetchPlan clearFields()
int getLockTimeout()
FetchPlan setLockTimeout(int timeout)
javax.persistence.LockModeType getReadLockMode()
FetchPlan setReadLockMode(javax.persistence.LockModeType mode)
javax.persistence.LockModeType getWriteLockMode()
FetchPlan setWriteLockMode(javax.persistence.LockModeType mode)
FetchConfiguration getDelegate()
FetchPlanImpl instead. This
 method pierces the published-API boundary, as does the SPI cast.
| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||