public interface FieldStrategy extends Strategy
Modifier and Type | Method and Description |
---|---|
void |
appendIndex(SQLBuffer sql,
Select sel,
Joins joins)
Append the ordered column alias to the given statement.
|
void |
appendIsEmpty(SQLBuffer sql,
Select sel,
Joins joins)
Append a where clause to the given statement checking if this value
is empty.
|
void |
appendIsNotEmpty(SQLBuffer sql,
Select sel,
Joins joins)
Append a where clause to the given statement checking if this value
is not empty.
|
void |
appendIsNotNull(SQLBuffer sql,
Select sel,
Joins joins)
Append a where clause to the given statement checking if this value
is not null.
|
void |
appendIsNull(SQLBuffer sql,
Select sel,
Joins joins)
Append a where clause to the given statement checking if this value
is null.
|
void |
appendSize(SQLBuffer sql,
Select sel,
Joins joins)
Append a where clause to the given statement checking the size
of the value.
|
void |
appendType(SQLBuffer sql,
Select sel,
Joins joins)
Append the entity discriminator value to the given statement.
|
boolean |
isEagerSelectToMany()
Whether the eager joins or selects used by this field are to-many.
|
boolean |
isVersionable()
Return true if this field can be used as part of a state image for
optimistic locking.
|
Joins |
join(Joins joins,
boolean forceOuter)
Join this value to the class table.
|
Joins |
joinKey(Joins joins,
boolean forceOuter)
Join the key value to the class table.
|
Joins |
joinKeyRelation(Joins joins,
boolean forceOuter,
boolean traverse)
Join this value's table to the table for the related first class object
key type, if any.
|
Joins |
joinRelation(Joins joins,
boolean forceOuter,
boolean traverse)
Join this value's table to the table for the related first class object
type, if any.
|
void |
load(OpenJPAStateManager sm,
JDBCStore store,
JDBCFetchConfiguration fetch)
Load secondary data using a connection from the store manager.
|
void |
load(OpenJPAStateManager sm,
JDBCStore store,
JDBCFetchConfiguration fetch,
Result res)
Load virtual row data; the given result is not guaranteed to contain
data for this field, so the field mapping should make sure the
result contains its needed column data before loading.
|
void |
loadEagerJoin(OpenJPAStateManager sm,
JDBCStore store,
JDBCFetchConfiguration fetch,
Result res)
Load the joined eager result.
|
Object |
loadEagerParallel(OpenJPAStateManager sm,
JDBCStore store,
JDBCFetchConfiguration fetch,
Object res)
Load the batched eager result.
|
Object |
loadKeyProjection(JDBCStore store,
JDBCFetchConfiguration fetch,
Result res,
Joins joins)
Load this field's key value using the given result.
|
Object |
loadProjection(JDBCStore store,
JDBCFetchConfiguration fetch,
Result res,
Joins joins)
Load this field value using the given result.
|
int |
select(Select sel,
OpenJPAStateManager sm,
JDBCStore store,
JDBCFetchConfiguration fetch,
int eagerMode)
Select the virtual row columns of this mapping.
|
void |
selectEagerJoin(Select sel,
OpenJPAStateManager sm,
JDBCStore store,
JDBCFetchConfiguration fetch,
int eagerMode)
Fill in joined select to related objects.
|
void |
selectEagerParallel(SelectExecutor sel,
OpenJPAStateManager sm,
JDBCStore store,
JDBCFetchConfiguration fetch,
int eagerMode)
Fill in parallel eager select for related objects.
|
void |
setFieldMapping(FieldMapping owner)
Set the class mapping using this strategy.
|
int |
supportsSelect(Select sel,
int type,
OpenJPAStateManager sm,
JDBCStore store,
JDBCFetchConfiguration fetch)
Return whether this mapping can perform the given select type.
|
Object |
toDataStoreValue(Object val,
JDBCStore store)
Translate the given external field value to its datastore equivalent.
|
Object |
toKeyDataStoreValue(Object val,
JDBCStore store)
Translate the given key value to its datastore equivalent.
|
void |
where(OpenJPAStateManager sm,
JDBCStore store,
RowManager rm,
Object prevValue)
Add a WHERE condition to the row for this field such that the field's
current DB value must equal the given previous value.
|
customDelete, customInsert, customUpdate, delete, getAlias, initialize, insert, isCustomDelete, isCustomInsert, isCustomUpdate, map, update
void setFieldMapping(FieldMapping owner)
int supportsSelect(Select sel, int type, OpenJPAStateManager sm, JDBCStore store, JDBCFetchConfiguration fetch)
Select
void selectEagerParallel(SelectExecutor sel, OpenJPAStateManager sm, JDBCStore store, JDBCFetchConfiguration fetch, int eagerMode)
void selectEagerJoin(Select sel, OpenJPAStateManager sm, JDBCStore store, JDBCFetchConfiguration fetch, int eagerMode)
boolean isEagerSelectToMany()
int select(Select sel, OpenJPAStateManager sm, JDBCStore store, JDBCFetchConfiguration fetch, int eagerMode)
sel
- the select to add tosm
- the instance being loaded, or null if not
initialized yet or selecting for multiple instancesstore
- the current store managerfetch
- fetch configurationeagerMode
- the eager fetch mode to use; this may be more
restrictive than the mode of the fetch configurationObject loadEagerParallel(OpenJPAStateManager sm, JDBCStore store, JDBCFetchConfiguration fetch, Object res) throws SQLException
res
- originally the Result
to load from, but this
method may return a processed result form that will be
passed to subsequent callsSQLException
void loadEagerJoin(OpenJPAStateManager sm, JDBCStore store, JDBCFetchConfiguration fetch, Result res) throws SQLException
SQLException
void load(OpenJPAStateManager sm, JDBCStore store, JDBCFetchConfiguration fetch, Result res) throws SQLException
SQLException
void load(OpenJPAStateManager sm, JDBCStore store, JDBCFetchConfiguration fetch) throws SQLException
SQLException
Object toDataStoreValue(Object val, JDBCStore store)
Object toKeyDataStoreValue(Object val, JDBCStore store)
void appendIsEmpty(SQLBuffer sql, Select sel, Joins joins)
void appendIsNotEmpty(SQLBuffer sql, Select sel, Joins joins)
void appendIsNull(SQLBuffer sql, Select sel, Joins joins)
void appendIsNotNull(SQLBuffer sql, Select sel, Joins joins)
void appendSize(SQLBuffer sql, Select sel, Joins joins)
void appendIndex(SQLBuffer sql, Select sel, Joins joins)
void appendType(SQLBuffer sql, Select sel, Joins joins)
Joins join(Joins joins, boolean forceOuter)
Joins joinKey(Joins joins, boolean forceOuter)
Joins joinRelation(Joins joins, boolean forceOuter, boolean traverse)
traverse
- if true, throw proper exception if it is not
possible for this mapping to traverse into the related typeJoins joinKeyRelation(Joins joins, boolean forceOuter, boolean traverse)
traverse
- if true, throw proper exception if it is not
possible for this mapping to traverse into the related typeObject loadProjection(JDBCStore store, JDBCFetchConfiguration fetch, Result res, Joins joins) throws SQLException
ValueMapping.getColumns()
.SQLException
Object loadKeyProjection(JDBCStore store, JDBCFetchConfiguration fetch, Result res, Joins joins) throws SQLException
ValueMapping.getColumns()
.SQLException
boolean isVersionable()
void where(OpenJPAStateManager sm, JDBCStore store, RowManager rm, Object prevValue) throws SQLException
SQLException
Copyright © 2006–2022 Apache Software Foundation. All rights reserved.