|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.openjpa.kernel.FetchConfigurationImpl org.apache.openjpa.jdbc.kernel.JDBCFetchConfigurationImpl
public class JDBCFetchConfigurationImpl
JDBC extensions to OpenJPA's FetchConfiguration
.
Nested Class Summary | |
---|---|
protected static class |
JDBCFetchConfigurationImpl.JDBCConfigurationState
Configurable JDBC state shared throughout a traversal chain. |
Nested classes/interfaces inherited from class org.apache.openjpa.kernel.FetchConfigurationImpl |
---|
FetchConfigurationImpl.ConfigurationState |
Field Summary | |
---|---|
protected JDBCFetchConfigurationImpl.JDBCConfigurationState |
_state
|
Fields inherited from interface org.apache.openjpa.kernel.FetchConfiguration |
---|
DEFAULT, FETCH_LOAD, FETCH_NONE, FETCH_REF |
Fields inherited from interface org.apache.openjpa.kernel.LockLevels |
---|
LOCK_NONE, LOCK_READ, LOCK_WRITE |
Fields inherited from interface org.apache.openjpa.kernel.LockScopes |
---|
LOCKSCOPE_EXTENDED, LOCKSCOPE_NORMAL |
Fields inherited from interface org.apache.openjpa.kernel.QueryFlushModes |
---|
FLUSH_FALSE, FLUSH_TRUE, FLUSH_WITH_CONNECTION |
Fields inherited from interface org.apache.openjpa.jdbc.kernel.EagerFetchModes |
---|
EAGER_JOIN, EAGER_NONE, EAGER_PARALLEL |
Fields inherited from interface org.apache.openjpa.jdbc.kernel.LRSSizes |
---|
SIZE_LAST, SIZE_QUERY, SIZE_UNKNOWN |
Fields inherited from interface org.apache.openjpa.jdbc.sql.JoinSyntaxes |
---|
SYNTAX_DATABASE, SYNTAX_SQL92, SYNTAX_TRADITIONAL |
Constructor Summary | |
---|---|
|
JDBCFetchConfigurationImpl()
|
protected |
JDBCFetchConfigurationImpl(FetchConfigurationImpl.ConfigurationState state,
JDBCFetchConfigurationImpl.JDBCConfigurationState jstate)
|
Method Summary | |
---|---|
JDBCFetchConfiguration |
addFetchInnerJoin(String join)
Adds field to the set of fully-qualified field names to
eagerly join when loading objects. |
JDBCFetchConfiguration |
addFetchInnerJoins(Collection<String> joins)
Adds fields to the set of fully-qualified field names to
eagerly join when loading objects. |
JDBCFetchConfiguration |
addJoin(String join)
Adds field to the set of fully-qualified field names to
eagerly join when loading objects. |
JDBCFetchConfiguration |
addJoins(Collection<String> joins)
Adds fields to the set of fully-qualified field names to
eagerly join when loading objects. |
JDBCFetchConfiguration |
clearJoins()
Clears the set of field names to join when loading data. |
void |
copy(FetchConfiguration fetch)
Copy the state from the given fetch configuration to this one. |
int |
getEagerFetchMode()
Return the eager fetch mode. |
int |
getFetchDirection()
The fetch direction to use as a constant from ResultSet . |
Set<String> |
getFetchInnerJoins()
Returns the names of the inner fetch joins that this component will use when loading objects. |
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. |
int |
getIsolation()
The isolation level for queries issued to the database. |
Set<String> |
getJoins()
Returns the names of the joins that this component will use when loading objects. |
int |
getJoinSyntax()
The join syntax to use. |
int |
getLRSSize()
The large result set size mode to use. |
int |
getResultSetType()
The result set type to use as a constant from ResultSet . |
int |
getSubclassFetchMode()
Return the subclass fetch mode. |
int |
getSubclassFetchMode(ClassMapping cls)
Return the effective subclass fetch mode for the given type. |
boolean |
hasFetchInnerJoin(String field)
Return true if the given fully-qualified inner fetch join has been added. |
boolean |
hasJoin(String field)
Return true if the given fully-qualified join has been added. |
protected FetchConfigurationImpl |
newInstance(FetchConfigurationImpl.ConfigurationState state)
Return a new hollow instance. |
ResultList<?> |
newResultList(ResultObjectProvider rop)
Return a new result list for the current fetch configuration. |
JDBCFetchConfiguration |
removeJoin(String field)
Removes field to the set of fully-qualified field names to
eagerly join when loading objects. |
JDBCFetchConfiguration |
removeJoins(Collection<String> joins)
Removes fields from the set of fully-qualified
field names to eagerly join when loading objects. |
void |
setContext(StoreContext ctx)
Called automatically by the system to associate the fetch configuration with a context before use. |
JDBCFetchConfiguration |
setEagerFetchMode(int mode)
Set the eager fetch mode. |
JDBCFetchConfiguration |
setFetchDirection(int direction)
The fetch direction to use as a constant from ResultSet . |
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. |
JDBCFetchConfiguration |
setIsolation(int level)
The isolation level for queries issued to the database. |
JDBCFetchConfiguration |
setJoinSyntax(int syntax)
The join syntax to use. |
JDBCFetchConfiguration |
setLRSSize(int size)
The large result set size mode to use. |
JDBCFetchConfiguration |
setResultSetType(int type)
The result set type to use as a constant from ResultSet . |
JDBCFetchConfiguration |
setSubclassFetchMode(int mode)
Set the subclass fetch mode. |
JDBCFetchConfiguration |
traverseJDBC(FieldMetaData fm)
Convenience method to cast traversal to store-specific type. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected final JDBCFetchConfigurationImpl.JDBCConfigurationState _state
Constructor Detail |
---|
public JDBCFetchConfigurationImpl()
protected JDBCFetchConfigurationImpl(FetchConfigurationImpl.ConfigurationState state, JDBCFetchConfigurationImpl.JDBCConfigurationState jstate)
Method Detail |
---|
protected FetchConfigurationImpl newInstance(FetchConfigurationImpl.ConfigurationState state)
FetchConfigurationImpl
newInstance
in class FetchConfigurationImpl
public void setContext(StoreContext ctx)
FetchConfiguration
setContext
in interface FetchConfiguration
setContext
in class FetchConfigurationImpl
public void copy(FetchConfiguration fetch)
FetchConfiguration
copy
in interface FetchConfiguration
copy
in class FetchConfigurationImpl
public boolean getIgnoreDfgForFkSelect()
JDBCFetchConfiguration
getIgnoreDfgForFkSelect
in interface JDBCFetchConfiguration
public void setIgnoreDfgForFkSelect(boolean b)
JDBCFetchConfiguration
setIgnoreDfgForFkSelect
in interface JDBCFetchConfiguration
public int getEagerFetchMode()
JDBCFetchConfiguration
openjpa.jdbc.EagerFetchMode
setting.
getEagerFetchMode
in interface JDBCFetchConfiguration
public JDBCFetchConfiguration setEagerFetchMode(int mode)
JDBCFetchConfiguration
openjpa.jdbc.EagerFetchMode
setting.
setEagerFetchMode
in interface JDBCFetchConfiguration
public int getSubclassFetchMode()
JDBCFetchConfiguration
openjpa.jdbc.SubclassFetchMode
setting.
getSubclassFetchMode
in interface JDBCFetchConfiguration
public int getSubclassFetchMode(ClassMapping cls)
JDBCFetchConfiguration
getSubclassFetchMode
in interface JDBCFetchConfiguration
public JDBCFetchConfiguration setSubclassFetchMode(int mode)
JDBCFetchConfiguration
openjpa.jdbc.SubclassFetchMode
setting.
setSubclassFetchMode
in interface JDBCFetchConfiguration
public int getResultSetType()
JDBCFetchConfiguration
ResultSet
.
Defaults to the openjpa.jdbc.ResultSetType
setting.
getResultSetType
in interface JDBCFetchConfiguration
public JDBCFetchConfiguration setResultSetType(int type)
JDBCFetchConfiguration
ResultSet
.
Defaults to the openjpa.jdbc.ResultSetType
setting.
setResultSetType
in interface JDBCFetchConfiguration
public int getFetchDirection()
JDBCFetchConfiguration
ResultSet
.
Defaults to the openjpa.jdbc.FetchDirection
setting.
getFetchDirection
in interface JDBCFetchConfiguration
public JDBCFetchConfiguration setFetchDirection(int direction)
JDBCFetchConfiguration
ResultSet
.
Defaults to the openjpa.jdbc.FetchDirection
setting.
setFetchDirection
in interface JDBCFetchConfiguration
public int getLRSSize()
JDBCFetchConfiguration
openjpa.jdbc.LRSSize
setting.
getLRSSize
in interface JDBCFetchConfiguration
public JDBCFetchConfiguration setLRSSize(int size)
JDBCFetchConfiguration
openjpa.jdbc.LRSSize
setting.
setLRSSize
in interface JDBCFetchConfiguration
public int getJoinSyntax()
JDBCFetchConfiguration
getJoinSyntax
in interface JDBCFetchConfiguration
public JDBCFetchConfiguration setJoinSyntax(int syntax)
JDBCFetchConfiguration
setJoinSyntax
in interface JDBCFetchConfiguration
public ResultList<?> newResultList(ResultObjectProvider rop)
FetchConfiguration
newResultList
in interface FetchConfiguration
newResultList
in class FetchConfigurationImpl
public Set<String> getJoins()
JDBCFetchConfiguration
getJoins
in interface JDBCFetchConfiguration
public boolean hasJoin(String field)
JDBCFetchConfiguration
hasJoin
in interface JDBCFetchConfiguration
public JDBCFetchConfiguration addJoin(String join)
JDBCFetchConfiguration
field
to the set of fully-qualified field names to
eagerly join when loading objects. Each class can have at most
one to-many eagerly joined fields.
addJoin
in interface JDBCFetchConfiguration
public JDBCFetchConfiguration addJoins(Collection<String> joins)
JDBCFetchConfiguration
fields
to the set of fully-qualified field names to
eagerly join when loading objects. Each class can have at most
one to-many eagerly joined fields.
addJoins
in interface JDBCFetchConfiguration
public JDBCFetchConfiguration removeJoin(String field)
JDBCFetchConfiguration
field
to the set of fully-qualified field names to
eagerly join when loading objects.
removeJoin
in interface JDBCFetchConfiguration
public JDBCFetchConfiguration removeJoins(Collection<String> joins)
JDBCFetchConfiguration
fields
from the set of fully-qualified
field names to eagerly join when loading objects.
removeJoins
in interface JDBCFetchConfiguration
public JDBCFetchConfiguration clearJoins()
JDBCFetchConfiguration
clearJoins
in interface JDBCFetchConfiguration
public int getIsolation()
JDBCFetchConfiguration
The isolation level for queries issued to the database. This overrides
the persistence-unit-wide openjpa.jdbc.TransactionIsolation
value.
Must be one of Connection.TRANSACTION_NONE
,
Connection.TRANSACTION_READ_UNCOMMITTED
,
Connection.TRANSACTION_READ_COMMITTED
,
Connection.TRANSACTION_REPEATABLE_READ
,
Connection.TRANSACTION_SERIALIZABLE
,
or -1 for the default connection level specified by the context in
which this fetch configuration is being used.
getIsolation
in interface JDBCFetchConfiguration
public JDBCFetchConfiguration setIsolation(int level)
JDBCFetchConfiguration
The isolation level for queries issued to the database. This overrides
the persistence-unit-wide openjpa.jdbc.TransactionIsolation
value.
Must be one of Connection.TRANSACTION_NONE
,
Connection.TRANSACTION_READ_UNCOMMITTED
,
Connection.TRANSACTION_READ_COMMITTED
,
Connection.TRANSACTION_REPEATABLE_READ
,
Connection.TRANSACTION_SERIALIZABLE
,
or -1 for the default connection level specified by the context in
which this fetch configuration is being used.
setIsolation
in interface JDBCFetchConfiguration
public JDBCFetchConfiguration traverseJDBC(FieldMetaData fm)
JDBCFetchConfiguration
traverseJDBC
in interface JDBCFetchConfiguration
public Set<String> getFetchInnerJoins()
JDBCFetchConfiguration
getFetchInnerJoins
in interface JDBCFetchConfiguration
public boolean hasFetchInnerJoin(String field)
JDBCFetchConfiguration
hasFetchInnerJoin
in interface JDBCFetchConfiguration
public JDBCFetchConfiguration addFetchInnerJoin(String join)
JDBCFetchConfiguration
field
to the set of fully-qualified field names to
eagerly join when loading objects. Each class can have at most
one to-many eagerly joined fields.
addFetchInnerJoin
in interface JDBCFetchConfiguration
public JDBCFetchConfiguration addFetchInnerJoins(Collection<String> joins)
JDBCFetchConfiguration
fields
to the set of fully-qualified field names to
eagerly join when loading objects. Each class can have at most
one to-many eagerly joined fields.
addFetchInnerJoins
in interface JDBCFetchConfiguration
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |