| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface JDBCFetchPlan
JDBC extensions to the fetch plan.
| Field Summary | |
|---|---|
| static int | EAGER_JOINDeprecated. use the FetchModeenum instead. | 
| static int | EAGER_NONEDeprecated. use the FetchModeenum instead. | 
| static int | EAGER_PARALLELDeprecated. use the FetchModeenum instead. | 
| static int | SIZE_LASTDeprecated. use the LRSSizeAlgorithmenum instead. | 
| static int | SIZE_QUERYDeprecated. use the LRSSizeAlgorithmenum instead. | 
| static int | SIZE_UNKNOWNDeprecated. use the LRSSizeAlgorithmenum instead. | 
| static int | SYNTAX_DATABASEDeprecated. use the JoinSyntaxenum instead. | 
| static int | SYNTAX_SQL92Deprecated. use the JoinSyntaxenum instead. | 
| static int | SYNTAX_TRADITIONALDeprecated. use the JoinSyntaxenum instead. | 
| Fields inherited from interface org.apache.openjpa.persistence.FetchPlan | 
|---|
| DEFAULT, DEPTH_INFINITE, GROUP_ALL, GROUP_DEFAULT | 
| Method Summary | |
|---|---|
|  JDBCFetchPlan | addFetchGroup(String group)Adds groupto the set of fetch group to
 use when loading objects. | 
|  JDBCFetchPlan | addFetchGroups(Collection groups)Adds groupsto the set of fetch group names to
 use when loading objects. | 
|  JDBCFetchPlan | addFetchGroups(String... groups)Adds groupsto the set of fetch group names to
 use when loading objects. | 
|  JDBCFetchPlan | addField(Class cls,
         String field)Adds fieldto the set of field names to
 use when loading objects. | 
|  JDBCFetchPlan | addField(String field)Adds fieldto the set of fully-qualified field names to
 use when loading objects. | 
|  JDBCFetchPlan | addFields(Class cls,
          Collection fields)Adds fieldsto the set of field names to
 use when loading objects. | 
|  JDBCFetchPlan | addFields(Class cls,
          String... fields)Adds fieldsto the set of field names to
 use when loading objects. | 
|  JDBCFetchPlan | addFields(Collection fields)Adds fieldsto the set of fully-qualified field names to
 use when loading objects. | 
|  JDBCFetchPlan | addFields(String... fields)Adds fieldsto the set of fully-qualified field names to
 use when loading objects. | 
|  JDBCFetchPlan | clearFetchGroups()Clears the set of fetch group names to use wen loading data. | 
|  JDBCFetchPlan | clearFields()Clears the set of field names to use wen loading data. | 
|  FetchMode | getEagerFetchMode()Eager fetch mode in loading relations. | 
|  FetchDirection | getFetchDirection()Result set fetch direction. | 
|  boolean | getIgnoreDfgForFkSelect()Affirms if foreign key for a relation field will be pre-fetched as part of the owning object irrespective of whether the field is included in the default fetch group of this fetch configuration. | 
|  IsolationLevel | getIsolation()The isolation level for queries issued to the database. | 
|  JoinSyntax | getJoinSyntax()SQL join syntax. | 
|  int | getLRSSize()Deprecated. use getLRSSizeAlgorithm()instead. | 
|  LRSSizeAlgorithm | getLRSSizeAlgorithm()How to determine the size of a large result set. | 
|  ResultSetType | getResultSetType()Type of JDBC result set to use for query results. | 
|  FetchMode | getSubclassFetchMode()Eager fetch mode in loading subclasses. | 
|  JDBCFetchPlan | removeFetchGroup(String group)Remove the given fetch group. | 
|  JDBCFetchPlan | removeFetchGroups(Collection groups)Removes groupsfrom the set of fetch group names
 to use when loading objects. | 
|  JDBCFetchPlan | removeFetchGroups(String... groups)Removes groupsfrom the set of fetch group names
 to use when loading objects. | 
|  JDBCFetchPlan | removeField(Class cls,
            String field)Remove the given field. | 
|  JDBCFetchPlan | removeField(String field)Remove the given fully-qualified field. | 
|  JDBCFetchPlan | removeFields(Class cls,
             Collection fields)Removes fieldsfrom the set of field names
 to use when loading objects. | 
|  JDBCFetchPlan | removeFields(Class cls,
             String... fields)Removes fieldsfrom the set of field names
 to use when loading objects. | 
|  JDBCFetchPlan | removeFields(Collection fields)Removes fieldsfrom the set of fully-qualified field names
 to use when loading objects. | 
|  JDBCFetchPlan | removeFields(String... fields)Removes fieldsfrom the set of fully-qualified field names
 to use when loading objects. | 
|  JDBCFetchPlan | resetFetchGroups()Resets the set of fetch groups to the list in the global configuration. | 
|  JDBCFetchPlan | setEagerFetchMode(FetchMode mode)Eager fetch mode in loading relations. | 
|  JDBCFetchPlan | setEagerFetchMode(int mode)Deprecated. use setEagerFetchMode(FetchMode)instead. | 
|  JDBCFetchPlan | setFetchBatchSize(int fetchBatchSize)Set the fetch batch size for large result set support. | 
|  JDBCFetchPlan | setFetchDirection(FetchDirection direction)Result set fetch direction. | 
|  JDBCFetchPlan | setFetchDirection(int direction)Deprecated. use setFetchDirection(FetchDirection)instead. | 
|  void | setIgnoreDfgForFkSelect(boolean b)Affirms if foreign key for a relation field will be pre-fetched as part of the owning object irrespective of whether the field is included in the default fetch group of this fetch configuration. | 
|  JDBCFetchPlan | setIsolation(IsolationLevel level)The isolation level for queries issued to the database. | 
|  JDBCFetchPlan | setJoinSyntax(int syntax)Deprecated. use setJoinSyntax(JoinSyntax)instead. | 
|  JDBCFetchPlan | setJoinSyntax(JoinSyntax syntax)SQL join syntax. | 
|  JDBCFetchPlan | setLockTimeout(int timeout)The number of milliseconds to wait for an object lock, or -1 for no limit. | 
|  JDBCFetchPlan | setLRSSize(int lrsSizeMode)Deprecated. use setLRSSizeAlgorithm(LRSSizeAlgorithm)instead. | 
|  JDBCFetchPlan | setLRSSizeAlgorithm(LRSSizeAlgorithm lrsSizeAlgorithm)How to determine the size of a large result set. | 
|  JDBCFetchPlan | setMaxFetchDepth(int depth)The maximum fetch depth when loading an object. | 
|  JDBCFetchPlan | setQueryResultCacheEnabled(boolean cache)Control whether or not query caching is enabled. | 
|  JDBCFetchPlan | setQueryTimeout(int timeout)The number of milliseconds to wait for a query, or -1 for no limit. | 
|  JDBCFetchPlan | setReadLockMode(LockModeType mode)The lock level to use for locking loaded objects. | 
|  JDBCFetchPlan | setResultSetType(int mode)Deprecated. use setResultSetType(ResultSetType)instead. | 
|  JDBCFetchPlan | setResultSetType(ResultSetType type)Type of JDBC result set to use for query results. | 
|  JDBCFetchPlan | setSubclassFetchMode(FetchMode mode)Eager fetch mode in loading subclasses. | 
|  JDBCFetchPlan | setSubclassFetchMode(int mode)Deprecated. use setSubclassFetchMode(FetchMode)instead. | 
|  JDBCFetchPlan | setWriteLockMode(LockModeType mode)The lock level to use for locking dirtied objects. | 
| Methods inherited from interface org.apache.openjpa.persistence.FetchPlan | 
|---|
| getCacheRetrieveMode, getCacheStoreMode, getDelegate, getExtendedPathLookup, getFetchBatchSize, getFetchGroups, getFields, getHint, getHints, getLockScope, getLockTimeout, getMaxFetchDepth, getQueryResultCache, getQueryResultCacheEnabled, getQueryTimeout, getReadLockMode, getWriteLockMode, hasField, hasField, setCacheRetrieveMode, setCacheStoreMode, setExtendedPathLookup, setHint, setLockScope, setQueryResultCache | 
| Field Detail | 
|---|
static final int EAGER_NONE
FetchMode enum instead.static final int EAGER_JOIN
FetchMode enum instead.static final int EAGER_PARALLEL
FetchMode enum instead.static final int SIZE_UNKNOWN
LRSSizeAlgorithm enum instead.static final int SIZE_LAST
LRSSizeAlgorithm enum instead.static final int SIZE_QUERY
LRSSizeAlgorithm enum instead.static final int SYNTAX_SQL92
JoinSyntax enum instead.static final int SYNTAX_TRADITIONAL
JoinSyntax enum instead.static final int SYNTAX_DATABASE
JoinSyntax enum instead.| Method Detail | 
|---|
FetchMode getEagerFetchMode()
JDBCFetchPlan setEagerFetchMode(FetchMode mode)
FetchMode getSubclassFetchMode()
JDBCFetchPlan setSubclassFetchMode(FetchMode mode)
ResultSetType getResultSetType()
JDBCFetchPlan setResultSetType(ResultSetType type)
FetchDirection getFetchDirection()
JDBCFetchPlan setFetchDirection(FetchDirection direction)
LRSSizeAlgorithm getLRSSizeAlgorithm()
JDBCFetchPlan setLRSSizeAlgorithm(LRSSizeAlgorithm lrsSizeAlgorithm)
JoinSyntax getJoinSyntax()
JDBCFetchPlan setJoinSyntax(JoinSyntax syntax)
IsolationLevel getIsolation()
openjpa.jdbc.TransactionIsolation
 value.
JDBCFetchPlan setIsolation(IsolationLevel level)
openjpa.jdbc.TransactionIsolation
 value.
JDBCFetchPlan addFetchGroup(String group)
FetchPlangroup to the set of fetch group to
 use when loading objects.
addFetchGroup in interface FetchPlanJDBCFetchPlan addFetchGroups(Collection groups)
FetchPlangroups to the set of fetch group names to
 use when loading objects.
addFetchGroups in interface FetchPlanJDBCFetchPlan addFetchGroups(String... groups)
FetchPlangroups to the set of fetch group names to
 use when loading objects.
addFetchGroups in interface FetchPlan
JDBCFetchPlan addField(Class cls,
                       String field)
FetchPlanfield to the set of field names to
 use when loading objects.
addField in interface FetchPlanJDBCFetchPlan addField(String field)
FetchPlanfield to the set of fully-qualified field names to
 use when loading objects.
addField in interface FetchPlan
JDBCFetchPlan addFields(Class cls,
                        Collection fields)
FetchPlanfields to the set of field names to
 use when loading objects.
addFields in interface FetchPlan
JDBCFetchPlan addFields(Class cls,
                        String... fields)
FetchPlanfields to the set of field names to
 use when loading objects.
addFields in interface FetchPlanJDBCFetchPlan addFields(Collection fields)
FetchPlanfields to the set of fully-qualified field names to
 use when loading objects.
addFields in interface FetchPlanJDBCFetchPlan addFields(String... fields)
FetchPlanfields to the set of fully-qualified field names to
 use when loading objects.
addFields in interface FetchPlanJDBCFetchPlan clearFetchGroups()
FetchPlan
clearFetchGroups in interface FetchPlanJDBCFetchPlan clearFields()
FetchPlan
clearFields in interface FetchPlanJDBCFetchPlan removeFetchGroup(String group)
FetchPlan
removeFetchGroup in interface FetchPlanJDBCFetchPlan removeFetchGroups(Collection groups)
FetchPlangroups from the set of fetch group names
 to use when loading objects.
removeFetchGroups in interface FetchPlanJDBCFetchPlan removeFetchGroups(String... groups)
FetchPlangroups from the set of fetch group names
 to use when loading objects.
removeFetchGroups in interface FetchPlan
JDBCFetchPlan removeField(Class cls,
                          String field)
FetchPlan
removeField in interface FetchPlanJDBCFetchPlan removeField(String field)
FetchPlan
removeField in interface FetchPlan
JDBCFetchPlan removeFields(Class cls,
                           Collection fields)
FetchPlanfields from the set of field names
 to use when loading objects.
removeFields in interface FetchPlan
JDBCFetchPlan removeFields(Class cls,
                           String... fields)
FetchPlanfields from the set of field names
 to use when loading objects.
removeFields in interface FetchPlanJDBCFetchPlan removeFields(String... fields)
FetchPlanfields from the set of fully-qualified field names
 to use when loading objects.
removeFields in interface FetchPlanJDBCFetchPlan removeFields(Collection fields)
FetchPlanfields from the set of fully-qualified field names
 to use when loading objects.
removeFields in interface FetchPlanJDBCFetchPlan resetFetchGroups()
FetchPlan
resetFetchGroups in interface FetchPlanJDBCFetchPlan setQueryResultCacheEnabled(boolean cache)
FetchPlan
setQueryResultCacheEnabled in interface FetchPlanJDBCFetchPlan setFetchBatchSize(int fetchBatchSize)
FetchPlanopenjpa.FetchBatchSize setting. Note
 that this property will be ignored under some data stores.
setFetchBatchSize in interface FetchPlanJDBCFetchPlan setLockTimeout(int timeout)
FetchPlan
setLockTimeout in interface FetchPlanJDBCFetchPlan setMaxFetchDepth(int depth)
FetchPlan
setMaxFetchDepth in interface FetchPlanJDBCFetchPlan setReadLockMode(LockModeType mode)
FetchPlan
setReadLockMode in interface FetchPlanJDBCFetchPlan setWriteLockMode(LockModeType mode)
FetchPlan
setWriteLockMode in interface FetchPlanJDBCFetchPlan setQueryTimeout(int timeout)
FetchPlan
setQueryTimeout in interface FetchPlanJDBCFetchPlan setEagerFetchMode(int mode)
setEagerFetchMode(FetchMode) instead.
JDBCFetchPlan setSubclassFetchMode(int mode)
setSubclassFetchMode(FetchMode) instead.
JDBCFetchPlan setResultSetType(int mode)
setResultSetType(ResultSetType) instead.
JDBCFetchPlan setFetchDirection(int direction)
setFetchDirection(FetchDirection) instead.
int getLRSSize()
getLRSSizeAlgorithm() instead.
JDBCFetchPlan setLRSSize(int lrsSizeMode)
setLRSSizeAlgorithm(LRSSizeAlgorithm) instead.
JDBCFetchPlan setJoinSyntax(int syntax)
setJoinSyntax(JoinSyntax) instead.
boolean getIgnoreDfgForFkSelect()
void setIgnoreDfgForFkSelect(boolean b)
| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||