org.apache.openjpa.persistence.jdbc
Interface JDBCFetchPlan

All Superinterfaces:
FetchPlan
All Known Implementing Classes:
JDBCFetchPlanImpl

public interface JDBCFetchPlan
extends FetchPlan

JDBC extensions to the fetch plan.

Since:
0.4.1
Author:
Abe White, Pinaki Poddar

Field Summary
static int EAGER_JOIN
          Deprecated. use the FetchMode enum instead.
static int EAGER_NONE
          Deprecated. use the FetchMode enum instead.
static int EAGER_PARALLEL
          Deprecated. use the FetchMode enum instead.
static int SIZE_LAST
          Deprecated. use the LRSSizeAlgorithm enum instead.
static int SIZE_QUERY
          Deprecated. use the LRSSizeAlgorithm enum instead.
static int SIZE_UNKNOWN
          Deprecated. use the LRSSizeAlgorithm enum instead.
static int SYNTAX_DATABASE
          Deprecated. use the JoinSyntax enum instead.
static int SYNTAX_SQL92
          Deprecated. use the JoinSyntax enum instead.
static int SYNTAX_TRADITIONAL
          Deprecated. use the JoinSyntax enum instead.
 
Fields inherited from interface org.apache.openjpa.persistence.FetchPlan
DEFAULT, DEPTH_INFINITE, GROUP_ALL, GROUP_DEFAULT
 
Method Summary
 JDBCFetchPlan addFetchGroup(String group)
           
 JDBCFetchPlan addFetchGroups(Collection groups)
           
 JDBCFetchPlan addFetchGroups(String... groups)
           
 JDBCFetchPlan addField(Class cls, String field)
           
 JDBCFetchPlan addField(String field)
           
 JDBCFetchPlan addFields(Class cls, Collection fields)
           
 JDBCFetchPlan addFields(Class cls, String... fields)
           
 JDBCFetchPlan addFields(Collection fields)
           
 JDBCFetchPlan addFields(String... fields)
           
 JDBCFetchPlan clearFetchGroups()
           
 JDBCFetchPlan clearFields()
           
 FetchMode getEagerFetchMode()
          Eager fetch mode in loading relations.
 FetchDirection getFetchDirection()
          Result set fetch direction.
 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)
           
 JDBCFetchPlan removeFetchGroups(Collection groups)
           
 JDBCFetchPlan removeFetchGroups(String... groups)
           
 JDBCFetchPlan removeField(Class cls, String field)
           
 JDBCFetchPlan removeField(String field)
           
 JDBCFetchPlan removeFields(Class cls, Collection fields)
           
 JDBCFetchPlan removeFields(Class cls, String... fields)
           
 JDBCFetchPlan removeFields(Collection fields)
           
 JDBCFetchPlan removeFields(String... fields)
           
 JDBCFetchPlan resetFetchGroups()
           
 JDBCFetchPlan setEagerFetchMode(FetchMode mode)
          Eager fetch mode in loading relations.
 JDBCFetchPlan setEagerFetchMode(int mode)
          Deprecated. use setEagerFetchMode(FetchMode) instead.
 JDBCFetchPlan setFetchBatchSize(int fetchBatchSize)
           
 JDBCFetchPlan setFetchDirection(FetchDirection direction)
          Result set fetch direction.
 JDBCFetchPlan setFetchDirection(int direction)
          Deprecated. use setFetchDirection(FetchDirection) instead.
 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)
           
 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)
           
 JDBCFetchPlan setQueryResultCacheEnabled(boolean cache)
           
 JDBCFetchPlan setReadLockMode(javax.persistence.LockModeType mode)
           
 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(javax.persistence.LockModeType mode)
           
 
Methods inherited from interface org.apache.openjpa.persistence.FetchPlan
getDelegate, getFetchBatchSize, getFetchGroups, getFields, getLockTimeout, getMaxFetchDepth, getQueryResultCache, getQueryResultCacheEnabled, getReadLockMode, getWriteLockMode, hasField, hasField, setQueryResultCache
 

Field Detail

EAGER_NONE

static final int EAGER_NONE
Deprecated. use the FetchMode enum instead.
See Also:
Constant Field Values

EAGER_JOIN

static final int EAGER_JOIN
Deprecated. use the FetchMode enum instead.
See Also:
Constant Field Values

EAGER_PARALLEL

static final int EAGER_PARALLEL
Deprecated. use the FetchMode enum instead.
See Also:
Constant Field Values

SIZE_UNKNOWN

static final int SIZE_UNKNOWN
Deprecated. use the LRSSizeAlgorithm enum instead.
See Also:
Constant Field Values

SIZE_LAST

static final int SIZE_LAST
Deprecated. use the LRSSizeAlgorithm enum instead.
See Also:
Constant Field Values

SIZE_QUERY

static final int SIZE_QUERY
Deprecated. use the LRSSizeAlgorithm enum instead.
See Also:
Constant Field Values

SYNTAX_SQL92

static final int SYNTAX_SQL92
Deprecated. use the JoinSyntax enum instead.
See Also:
Constant Field Values

SYNTAX_TRADITIONAL

static final int SYNTAX_TRADITIONAL
Deprecated. use the JoinSyntax enum instead.
See Also:
Constant Field Values

SYNTAX_DATABASE

static final int SYNTAX_DATABASE
Deprecated. use the JoinSyntax enum instead.
See Also:
Constant Field Values
Method Detail

getEagerFetchMode

FetchMode getEagerFetchMode()
Eager fetch mode in loading relations.


setEagerFetchMode

JDBCFetchPlan setEagerFetchMode(FetchMode mode)
Eager fetch mode in loading relations.


getSubclassFetchMode

FetchMode getSubclassFetchMode()
Eager fetch mode in loading subclasses.


setSubclassFetchMode

JDBCFetchPlan setSubclassFetchMode(FetchMode mode)
Eager fetch mode in loading subclasses.


getResultSetType

ResultSetType getResultSetType()
Type of JDBC result set to use for query results.


setResultSetType

JDBCFetchPlan setResultSetType(ResultSetType type)
Type of JDBC result set to use for query results.


getFetchDirection

FetchDirection getFetchDirection()
Result set fetch direction.


setFetchDirection

JDBCFetchPlan setFetchDirection(FetchDirection direction)
Result set fetch direction.


getLRSSizeAlgorithm

LRSSizeAlgorithm getLRSSizeAlgorithm()
How to determine the size of a large result set.


setLRSSizeAlgorithm

JDBCFetchPlan setLRSSizeAlgorithm(LRSSizeAlgorithm lrsSizeAlgorithm)
How to determine the size of a large result set.


getJoinSyntax

JoinSyntax getJoinSyntax()
SQL join syntax.


setJoinSyntax

JDBCFetchPlan setJoinSyntax(JoinSyntax syntax)
SQL join syntax.


getIsolation

IsolationLevel getIsolation()
The isolation level for queries issued to the database. This overrides the persistence-unit-wide openjpa.jdbc.TransactionIsolation value.

Since:
0.9.7

setIsolation

JDBCFetchPlan setIsolation(IsolationLevel level)
The isolation level for queries issued to the database. This overrides the persistence-unit-wide openjpa.jdbc.TransactionIsolation value.

Since:
0.9.7

addFetchGroup

JDBCFetchPlan addFetchGroup(String group)
Specified by:
addFetchGroup in interface FetchPlan

addFetchGroups

JDBCFetchPlan addFetchGroups(Collection groups)
Specified by:
addFetchGroups in interface FetchPlan

addFetchGroups

JDBCFetchPlan addFetchGroups(String... groups)
Specified by:
addFetchGroups in interface FetchPlan

addField

JDBCFetchPlan addField(Class cls,
                       String field)
Specified by:
addField in interface FetchPlan

addField

JDBCFetchPlan addField(String field)
Specified by:
addField in interface FetchPlan

addFields

JDBCFetchPlan addFields(Class cls,
                        Collection fields)
Specified by:
addFields in interface FetchPlan

addFields

JDBCFetchPlan addFields(Class cls,
                        String... fields)
Specified by:
addFields in interface FetchPlan

addFields

JDBCFetchPlan addFields(Collection fields)
Specified by:
addFields in interface FetchPlan

addFields

JDBCFetchPlan addFields(String... fields)
Specified by:
addFields in interface FetchPlan

clearFetchGroups

JDBCFetchPlan clearFetchGroups()
Specified by:
clearFetchGroups in interface FetchPlan

clearFields

JDBCFetchPlan clearFields()
Specified by:
clearFields in interface FetchPlan

removeFetchGroup

JDBCFetchPlan removeFetchGroup(String group)
Specified by:
removeFetchGroup in interface FetchPlan

removeFetchGroups

JDBCFetchPlan removeFetchGroups(Collection groups)
Specified by:
removeFetchGroups in interface FetchPlan

removeFetchGroups

JDBCFetchPlan removeFetchGroups(String... groups)
Specified by:
removeFetchGroups in interface FetchPlan

removeField

JDBCFetchPlan removeField(Class cls,
                          String field)
Specified by:
removeField in interface FetchPlan

removeField

JDBCFetchPlan removeField(String field)
Specified by:
removeField in interface FetchPlan

removeFields

JDBCFetchPlan removeFields(Class cls,
                           Collection fields)
Specified by:
removeFields in interface FetchPlan

removeFields

JDBCFetchPlan removeFields(Class cls,
                           String... fields)
Specified by:
removeFields in interface FetchPlan

removeFields

JDBCFetchPlan removeFields(String... fields)
Specified by:
removeFields in interface FetchPlan

removeFields

JDBCFetchPlan removeFields(Collection fields)
Specified by:
removeFields in interface FetchPlan

resetFetchGroups

JDBCFetchPlan resetFetchGroups()
Specified by:
resetFetchGroups in interface FetchPlan

setQueryResultCacheEnabled

JDBCFetchPlan setQueryResultCacheEnabled(boolean cache)
Specified by:
setQueryResultCacheEnabled in interface FetchPlan

setFetchBatchSize

JDBCFetchPlan setFetchBatchSize(int fetchBatchSize)
Specified by:
setFetchBatchSize in interface FetchPlan

setLockTimeout

JDBCFetchPlan setLockTimeout(int timeout)
Specified by:
setLockTimeout in interface FetchPlan

setMaxFetchDepth

JDBCFetchPlan setMaxFetchDepth(int depth)
Specified by:
setMaxFetchDepth in interface FetchPlan

setReadLockMode

JDBCFetchPlan setReadLockMode(javax.persistence.LockModeType mode)
Specified by:
setReadLockMode in interface FetchPlan

setWriteLockMode

JDBCFetchPlan setWriteLockMode(javax.persistence.LockModeType mode)
Specified by:
setWriteLockMode in interface FetchPlan

setEagerFetchMode

JDBCFetchPlan setEagerFetchMode(int mode)
Deprecated. use setEagerFetchMode(FetchMode) instead.


setSubclassFetchMode

JDBCFetchPlan setSubclassFetchMode(int mode)
Deprecated. use setSubclassFetchMode(FetchMode) instead.


setResultSetType

JDBCFetchPlan setResultSetType(int mode)
Deprecated. use setResultSetType(ResultSetType) instead.


setFetchDirection

JDBCFetchPlan setFetchDirection(int direction)
Deprecated. use setFetchDirection(FetchDirection) instead.


getLRSSize

int getLRSSize()
Deprecated. use getLRSSizeAlgorithm() instead.


setLRSSize

JDBCFetchPlan setLRSSize(int lrsSizeMode)
Deprecated. use setLRSSizeAlgorithm(LRSSizeAlgorithm) instead.


setJoinSyntax

JDBCFetchPlan setJoinSyntax(int syntax)
Deprecated. use setJoinSyntax(JoinSyntax) instead.



Copyright © 2006-2012 Apache Software Foundation. All Rights Reserved.