org.apache.openjpa.persistence.jdbc
Class JDBCFetchPlanImpl

java.lang.Object
  org.apache.openjpa.persistence.FetchPlanImpl
      org.apache.openjpa.persistence.jdbc.JDBCFetchPlanImpl

All Implemented Interfaces:

org.apache.openjpa.persistence.FetchPlan, JDBCFetchPlan

public class JDBCFetchPlanImpl
extends org.apache.openjpa.persistence.FetchPlanImpl
implements JDBCFetchPlan

JDBC extensions to the fetch plan.

Since:

0.4.0

Author:

Abe White

Field Summary

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

DEFAULT, DEPTH_INFINITE, GROUP_ALL, GROUP_DEFAULT

Constructor Summary

JDBCFetchPlanImpl(org.apache.openjpa.kernel.FetchConfiguration fetch)
Constructor; supply delegate.

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.
protected org.apache.openjpa.kernel.DelegatingFetchConfiguration	newDelegatingFetchConfiguration(org.apache.openjpa.kernel.FetchConfiguration fetch)
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()
JDBCFetchPlanImpl	setEagerFetchMode(FetchMode mode) Eager fetch mode in loading relations.
JDBCFetchPlan	setFetchBatchSize(int fetchBatchSize)
JDBCFetchPlanImpl	setFetchDirection(FetchDirection direction) Result set fetch direction.
JDBCFetchPlan	setIsolation(IsolationLevel level) The isolation level for queries issued to the database.
JDBCFetchPlanImpl	setJoinSyntax(JoinSyntax syntax) SQL join syntax.
JDBCFetchPlan	setLockTimeout(int timeout)
JDBCFetchPlanImpl	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)
JDBCFetchPlanImpl	setResultSetType(ResultSetType type) Type of JDBC result set to use for query results.
JDBCFetchPlanImpl	setSubclassFetchMode(FetchMode mode) Eager fetch mode in loading subclasses.
JDBCFetchPlan	setWriteLockMode(javax.persistence.LockModeType mode)

Methods inherited from class org.apache.openjpa.persistence.FetchPlanImpl

equals, getDelegate, getFetchBatchSize, getFetchGroups, getFields, getLockTimeout, getMaxFetchDepth, getQueryResultCacheEnabled, getReadLockMode, getWriteLockMode, hasField, hasField, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

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

Constructor Detail

JDBCFetchPlanImpl

public JDBCFetchPlanImpl(org.apache.openjpa.kernel.FetchConfiguration fetch)

Constructor; supply delegate.

Method Detail

newDelegatingFetchConfiguration

protected org.apache.openjpa.kernel.DelegatingFetchConfiguration newDelegatingFetchConfiguration(org.apache.openjpa.kernel.FetchConfiguration fetch)

Overrides:

newDelegatingFetchConfiguration in class org.apache.openjpa.persistence.FetchPlanImpl

getEagerFetchMode

public FetchMode getEagerFetchMode()

Description copied from interface: JDBCFetchPlan

Eager fetch mode in loading relations.

Specified by:

getEagerFetchMode in interface JDBCFetchPlan

setEagerFetchMode

public JDBCFetchPlanImpl setEagerFetchMode(FetchMode mode)

Description copied from interface: JDBCFetchPlan

Eager fetch mode in loading relations.

Specified by:

setEagerFetchMode in interface JDBCFetchPlan

getSubclassFetchMode

public FetchMode getSubclassFetchMode()

Description copied from interface: JDBCFetchPlan

Eager fetch mode in loading subclasses.

Specified by:

getSubclassFetchMode in interface JDBCFetchPlan

setSubclassFetchMode

public JDBCFetchPlanImpl setSubclassFetchMode(FetchMode mode)

Description copied from interface: JDBCFetchPlan

Eager fetch mode in loading subclasses.

Specified by:

setSubclassFetchMode in interface JDBCFetchPlan

getResultSetType

public ResultSetType getResultSetType()

Description copied from interface: JDBCFetchPlan

Type of JDBC result set to use for query results.

Specified by:

getResultSetType in interface JDBCFetchPlan

setResultSetType

public JDBCFetchPlanImpl setResultSetType(ResultSetType type)

Description copied from interface: JDBCFetchPlan

Type of JDBC result set to use for query results.

Specified by:

setResultSetType in interface JDBCFetchPlan

getFetchDirection

public FetchDirection getFetchDirection()

Description copied from interface: JDBCFetchPlan

Result set fetch direction.

Specified by:

getFetchDirection in interface JDBCFetchPlan

setFetchDirection

public JDBCFetchPlanImpl setFetchDirection(FetchDirection direction)

Description copied from interface: JDBCFetchPlan

Result set fetch direction.

Specified by:

setFetchDirection in interface JDBCFetchPlan

getLRSSizeAlgorithm

public LRSSizeAlgorithm getLRSSizeAlgorithm()

Description copied from interface: JDBCFetchPlan

How to determine the size of a large result set.

Specified by:

getLRSSizeAlgorithm in interface JDBCFetchPlan

setLRSSizeAlgorithm

public JDBCFetchPlanImpl setLRSSizeAlgorithm(LRSSizeAlgorithm lrsSizeAlgorithm)

Description copied from interface: JDBCFetchPlan

How to determine the size of a large result set.

Specified by:

setLRSSizeAlgorithm in interface JDBCFetchPlan

getJoinSyntax

public JoinSyntax getJoinSyntax()

Description copied from interface: JDBCFetchPlan

SQL join syntax.

Specified by:

getJoinSyntax in interface JDBCFetchPlan

setJoinSyntax

public JDBCFetchPlanImpl setJoinSyntax(JoinSyntax syntax)

Description copied from interface: JDBCFetchPlan

SQL join syntax.

Specified by:

setJoinSyntax in interface JDBCFetchPlan

getIsolation

public IsolationLevel getIsolation()

Description copied from interface: JDBCFetchPlan

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

Specified by:

getIsolation in interface JDBCFetchPlan

setIsolation

public JDBCFetchPlan setIsolation(IsolationLevel level)

Description copied from interface: JDBCFetchPlan

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

Specified by:

setIsolation in interface JDBCFetchPlan

addFetchGroup

public JDBCFetchPlan addFetchGroup(java.lang.String group)

Specified by:

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

Specified by:

addFetchGroup in interface JDBCFetchPlan

Overrides:

addFetchGroup in class org.apache.openjpa.persistence.FetchPlanImpl

addFetchGroups

public JDBCFetchPlan addFetchGroups(java.util.Collection groups)

Specified by:

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

Specified by:

addFetchGroups in interface JDBCFetchPlan

Overrides:

addFetchGroups in class org.apache.openjpa.persistence.FetchPlanImpl

addFetchGroups

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

Specified by:

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

Specified by:

addFetchGroups in interface JDBCFetchPlan

Overrides:

addFetchGroups in class org.apache.openjpa.persistence.FetchPlanImpl

addField

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

Specified by:

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

Specified by:

addField in interface JDBCFetchPlan

Overrides:

addField in class org.apache.openjpa.persistence.FetchPlanImpl

addField

public JDBCFetchPlan addField(java.lang.String field)

Specified by:

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

Specified by:

addField in interface JDBCFetchPlan

Overrides:

addField in class org.apache.openjpa.persistence.FetchPlanImpl

addFields

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

Specified by:

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

Specified by:

addFields in interface JDBCFetchPlan

Overrides:

addFields in class org.apache.openjpa.persistence.FetchPlanImpl

addFields

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

Specified by:

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

Specified by:

addFields in interface JDBCFetchPlan

Overrides:

addFields in class org.apache.openjpa.persistence.FetchPlanImpl

addFields

public JDBCFetchPlan addFields(java.util.Collection fields)

Specified by:

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

Specified by:

addFields in interface JDBCFetchPlan

Overrides:

addFields in class org.apache.openjpa.persistence.FetchPlanImpl

addFields

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

Specified by:

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

Specified by:

addFields in interface JDBCFetchPlan

Overrides:

addFields in class org.apache.openjpa.persistence.FetchPlanImpl

clearFetchGroups

public JDBCFetchPlan clearFetchGroups()

Specified by:

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

Specified by:

clearFetchGroups in interface JDBCFetchPlan

Overrides:

clearFetchGroups in class org.apache.openjpa.persistence.FetchPlanImpl

clearFields

public JDBCFetchPlan clearFields()

Specified by:

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

Specified by:

clearFields in interface JDBCFetchPlan

Overrides:

clearFields in class org.apache.openjpa.persistence.FetchPlanImpl

removeFetchGroup

public JDBCFetchPlan removeFetchGroup(java.lang.String group)

Specified by:

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

Specified by:

removeFetchGroup in interface JDBCFetchPlan

Overrides:

removeFetchGroup in class org.apache.openjpa.persistence.FetchPlanImpl

removeFetchGroups

public JDBCFetchPlan removeFetchGroups(java.util.Collection groups)

Specified by:

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

Specified by:

removeFetchGroups in interface JDBCFetchPlan

Overrides:

removeFetchGroups in class org.apache.openjpa.persistence.FetchPlanImpl

removeFetchGroups

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

Specified by:

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

Specified by:

removeFetchGroups in interface JDBCFetchPlan

Overrides:

removeFetchGroups in class org.apache.openjpa.persistence.FetchPlanImpl

removeField

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

Specified by:

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

Specified by:

removeField in interface JDBCFetchPlan

Overrides:

removeField in class org.apache.openjpa.persistence.FetchPlanImpl

removeField

public JDBCFetchPlan removeField(java.lang.String field)

Specified by:

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

Specified by:

removeField in interface JDBCFetchPlan

Overrides:

removeField in class org.apache.openjpa.persistence.FetchPlanImpl

removeFields

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

Specified by:

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

Specified by:

removeFields in interface JDBCFetchPlan

Overrides:

removeFields in class org.apache.openjpa.persistence.FetchPlanImpl

removeFields

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

Specified by:

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

Specified by:

removeFields in interface JDBCFetchPlan

Overrides:

removeFields in class org.apache.openjpa.persistence.FetchPlanImpl

removeFields

public JDBCFetchPlan removeFields(java.util.Collection fields)

Specified by:

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

Specified by:

removeFields in interface JDBCFetchPlan

Overrides:

removeFields in class org.apache.openjpa.persistence.FetchPlanImpl

removeFields

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

Specified by:

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

Specified by:

removeFields in interface JDBCFetchPlan

Overrides:

removeFields in class org.apache.openjpa.persistence.FetchPlanImpl

resetFetchGroups

public JDBCFetchPlan resetFetchGroups()

Specified by:

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

Specified by:

resetFetchGroups in interface JDBCFetchPlan

Overrides:

resetFetchGroups in class org.apache.openjpa.persistence.FetchPlanImpl

setQueryResultCacheEnabled

public JDBCFetchPlan setQueryResultCacheEnabled(boolean cache)

Specified by:

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

Specified by:

setQueryResultCacheEnabled in interface JDBCFetchPlan

Overrides:

setQueryResultCacheEnabled in class org.apache.openjpa.persistence.FetchPlanImpl

setFetchBatchSize

public JDBCFetchPlan setFetchBatchSize(int fetchBatchSize)

Specified by:

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

Specified by:

setFetchBatchSize in interface JDBCFetchPlan

Overrides:

setFetchBatchSize in class org.apache.openjpa.persistence.FetchPlanImpl

setLockTimeout

public JDBCFetchPlan setLockTimeout(int timeout)

Specified by:

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

Specified by:

setLockTimeout in interface JDBCFetchPlan

Overrides:

setLockTimeout in class org.apache.openjpa.persistence.FetchPlanImpl

setMaxFetchDepth

public JDBCFetchPlan setMaxFetchDepth(int depth)

Specified by:

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

Specified by:

setMaxFetchDepth in interface JDBCFetchPlan

Overrides:

setMaxFetchDepth in class org.apache.openjpa.persistence.FetchPlanImpl

setReadLockMode

public JDBCFetchPlan setReadLockMode(javax.persistence.LockModeType mode)

Specified by:

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

Specified by:

setReadLockMode in interface JDBCFetchPlan

Overrides:

setReadLockMode in class org.apache.openjpa.persistence.FetchPlanImpl

setWriteLockMode

public JDBCFetchPlan setWriteLockMode(javax.persistence.LockModeType mode)

Specified by:

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

Specified by:

setWriteLockMode in interface JDBCFetchPlan

Overrides:

setWriteLockMode in class org.apache.openjpa.persistence.FetchPlanImpl