AbstractFieldStrategy (OpenJPA 1.0.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.openjpa.jdbc.meta.strats
Class AbstractFieldStrategy

java.lang.Object
  org.apache.openjpa.jdbc.meta.strats.AbstractStrategy
      org.apache.openjpa.jdbc.meta.strats.AbstractFieldStrategy

All Implemented Interfaces:: Serializable, FieldStrategy, Strategy

Direct Known Subclasses:: ContainerFieldStrategy, EmbedFieldStrategy, HandlerFieldStrategy, MaxEmbeddedBlobFieldStrategy, MaxEmbeddedByteArrayFieldStrategy, MaxEmbeddedCharArrayFieldStrategy, MaxEmbeddedClobFieldStrategy, NoneFieldStrategy, PrimitiveFieldStrategy, RelationFieldStrategy, StringFieldStrategy

public abstract class AbstractFieldStrategy
extends AbstractStrategy
implements FieldStrategy
extends AbstractStrategy
implements FieldStrategy

No-op strategy for easy extension.

Author:: Abe White
See Also:: Serialized Form

Field Summary
`protected FieldMapping`	`field` The owning field mapping.

Constructor Summary
`AbstractFieldStrategy()`

Method Summary
`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.
`protected void`	`assertNotMappedBy()` Throws an informative exception if the field declares a mapped-by value.
`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.

Methods inherited from class org.apache.openjpa.jdbc.meta.strats.AbstractStrategy
`customDelete, customInsert, customUpdate, delete, getAlias, initialize, insert, isCustomDelete, isCustomInsert, isCustomUpdate, map, update`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface org.apache.openjpa.jdbc.meta.Strategy
`customDelete, customInsert, customUpdate, delete, getAlias, initialize, insert, isCustomDelete, isCustomInsert, isCustomUpdate, map, update`

Field Detail

field

protected FieldMapping field

The owning field mapping.

Constructor Detail

AbstractFieldStrategy

public AbstractFieldStrategy()

Method Detail

assertNotMappedBy

protected void assertNotMappedBy()

Throws an informative exception if the field declares a mapped-by value.