org.apache.openjpa.persistence.jdbc
Interface JDBCFetchPlan

All Superinterfaces:

org.apache.openjpa.persistence.FetchPlan

All Known Implementing Classes:

JDBCFetchPlanImpl

public interface JDBCFetchPlan
extends org.apache.openjpa.persistence.FetchPlan

JDBC extensions to the fetch plan.

Since:

0.4.1

Author:

Abe White, Pinaki Poddar

Field Summary

Fields inherited from interface org.apache.openjpa.persistence.FetchPlan

DEFAULT, DEPTH_INFINITE, GROUP_ALL, GROUP_DEFAULT

Method Summary

JDBCFetchPlan	addFetchGroup(java.lang.String group)
JDBCFetchPlan	addFetchGroups(java.util.Collection groups)
JDBCFetchPlan	addFetchGroups(java.lang.String... groups)
JDBCFetchPlan	addField(java.lang.Class cls, java.lang.String field)
JDBCFetchPlan	addField(java.lang.String field)
JDBCFetchPlan	addFields(java.lang.Class cls, java.util.Collection fields)
JDBCFetchPlan	addFields(java.lang.Class cls, java.lang.String... fields)
JDBCFetchPlan	addFields(java.util.Collection fields)
JDBCFetchPlan	addFields(java.lang.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.
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(java.lang.String group)
JDBCFetchPlan	removeFetchGroups(java.util.Collection groups)
JDBCFetchPlan	removeFetchGroups(java.lang.String... groups)
JDBCFetchPlan	removeField(java.lang.Class cls, java.lang.String field)
JDBCFetchPlan	removeField(java.lang.String field)
JDBCFetchPlan	removeFields(java.lang.Class cls, java.util.Collection fields)
JDBCFetchPlan	removeFields(java.lang.Class cls, java.lang.String... fields)
JDBCFetchPlan	removeFields(java.util.Collection fields)
JDBCFetchPlan	removeFields(java.lang.String... fields)
JDBCFetchPlan	resetFetchGroups()
JDBCFetchPlan	setEagerFetchMode(FetchMode mode) Eager fetch mode in loading relations.
JDBCFetchPlan	setFetchBatchSize(int fetchBatchSize)
JDBCFetchPlan	setFetchDirection(FetchDirection direction) Result set fetch direction.
JDBCFetchPlan	setIsolation(IsolationLevel level) The isolation level for queries issued to the database.
JDBCFetchPlan	setJoinSyntax(JoinSyntax syntax) SQL join syntax.
JDBCFetchPlan	setLockTimeout(int timeout)
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(ResultSetType type) Type of JDBC result set to use for query results.
JDBCFetchPlan	setSubclassFetchMode(FetchMode mode) Eager fetch mode in loading subclasses.
JDBCFetchPlan	setWriteLockMode(javax.persistence.LockModeType mode)

Methods inherited from interface org.apache.openjpa.persistence.FetchPlan

getFetchBatchSize, getFetchGroups, getFields, getLockTimeout, getMaxFetchDepth, getQueryResultCacheEnabled, getReadLockMode, getWriteLockMode, hasField, hasField

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(java.lang.String group)

Specified by:

addFetchGroup in interface org.apache.openjpa.persistence.FetchPlan

addFetchGroups

JDBCFetchPlan addFetchGroups(java.util.Collection groups)

Specified by:

addFetchGroups in interface org.apache.openjpa.persistence.FetchPlan

addFetchGroups

JDBCFetchPlan addFetchGroups(java.lang.String... groups)

Specified by:

addFetchGroups in interface org.apache.openjpa.persistence.FetchPlan

addField

JDBCFetchPlan addField(java.lang.Class cls,
                       java.lang.String field)

Specified by:

addField in interface org.apache.openjpa.persistence.FetchPlan

addField

JDBCFetchPlan addField(java.lang.String field)

Specified by:

addField in interface org.apache.openjpa.persistence.FetchPlan

addFields

JDBCFetchPlan addFields(java.lang.Class cls,
                        java.util.Collection fields)

Specified by:

addFields in interface org.apache.openjpa.persistence.FetchPlan

addFields

JDBCFetchPlan addFields(java.lang.Class cls,
                        java.lang.String... fields)

Specified by:

addFields in interface org.apache.openjpa.persistence.FetchPlan

addFields

JDBCFetchPlan addFields(java.util.Collection fields)

Specified by:

addFields in interface org.apache.openjpa.persistence.FetchPlan

addFields

JDBCFetchPlan addFields(java.lang.String... fields)

Specified by:

addFields in interface org.apache.openjpa.persistence.FetchPlan

clearFetchGroups

JDBCFetchPlan clearFetchGroups()

Specified by:

clearFetchGroups in interface org.apache.openjpa.persistence.FetchPlan

clearFields

JDBCFetchPlan clearFields()

Specified by:

clearFields in interface org.apache.openjpa.persistence.FetchPlan

removeFetchGroup

JDBCFetchPlan removeFetchGroup(java.lang.String group)

Specified by:

removeFetchGroup in interface org.apache.openjpa.persistence.FetchPlan

removeFetchGroups

JDBCFetchPlan removeFetchGroups(java.util.Collection groups)

Specified by:

removeFetchGroups in interface org.apache.openjpa.persistence.FetchPlan

removeFetchGroups

JDBCFetchPlan removeFetchGroups(java.lang.String... groups)

Specified by:

removeFetchGroups in interface org.apache.openjpa.persistence.FetchPlan

removeField

JDBCFetchPlan removeField(java.lang.Class cls,
                          java.lang.String field)

Specified by:

removeField in interface org.apache.openjpa.persistence.FetchPlan

removeField

JDBCFetchPlan removeField(java.lang.String field)

Specified by:

removeField in interface org.apache.openjpa.persistence.FetchPlan

removeFields

JDBCFetchPlan removeFields(java.lang.Class cls,
                           java.util.Collection fields)

Specified by:

removeFields in interface org.apache.openjpa.persistence.FetchPlan

removeFields

JDBCFetchPlan removeFields(java.lang.Class cls,
                           java.lang.String... fields)

Specified by:

removeFields in interface org.apache.openjpa.persistence.FetchPlan

removeFields

JDBCFetchPlan removeFields(java.lang.String... fields)

Specified by:

removeFields in interface org.apache.openjpa.persistence.FetchPlan

removeFields

JDBCFetchPlan removeFields(java.util.Collection fields)

Specified by:

removeFields in interface org.apache.openjpa.persistence.FetchPlan

resetFetchGroups

JDBCFetchPlan resetFetchGroups()

Specified by:

resetFetchGroups in interface org.apache.openjpa.persistence.FetchPlan

setQueryResultCacheEnabled

JDBCFetchPlan setQueryResultCacheEnabled(boolean cache)

Specified by:

setQueryResultCacheEnabled in interface org.apache.openjpa.persistence.FetchPlan

setFetchBatchSize

JDBCFetchPlan setFetchBatchSize(int fetchBatchSize)

Specified by:

setFetchBatchSize in interface org.apache.openjpa.persistence.FetchPlan

setLockTimeout

JDBCFetchPlan setLockTimeout(int timeout)

Specified by:

setLockTimeout in interface org.apache.openjpa.persistence.FetchPlan

setMaxFetchDepth

JDBCFetchPlan setMaxFetchDepth(int depth)

Specified by:

setMaxFetchDepth in interface org.apache.openjpa.persistence.FetchPlan

setReadLockMode

JDBCFetchPlan setReadLockMode(javax.persistence.LockModeType mode)

Specified by:

setReadLockMode in interface org.apache.openjpa.persistence.FetchPlan

setWriteLockMode

JDBCFetchPlan setWriteLockMode(javax.persistence.LockModeType mode)

Specified by:

setWriteLockMode in interface org.apache.openjpa.persistence.FetchPlan