org.apache.openjpa.jdbc.meta.strats

Class LobFieldStrategy

java.lang.Object

org.apache.openjpa.jdbc.meta.strats.AbstractStrategy

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

org.apache.openjpa.jdbc.meta.strats.LobFieldStrategy

All Implemented Interfaces:

Serializable, FieldStrategy, Strategy

public class LobFieldStrategy
extends AbstractFieldStrategy

Direct mapping from a stream value to a column.

Since:

1.1.0

Author:

Ignacio Andreu

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.openjpa.jdbc.meta.strats.AbstractFieldStrategy

field

Constructor Summary

Constructors

Constructor and Description
LobFieldStrategy()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	assertNotMappedBy() Throws an informative exception if the field declares a mapped-by value.
void	customInsert(OpenJPAStateManager sm, JDBCStore store) Override this method to customize flushing this mapping.
void	customUpdate(OpenJPAStateManager sm, JDBCStore store) Override this method to customize flushing this mapping.
void	delete(OpenJPAStateManager sm, JDBCStore store, RowManager rm) Set the where values appropriately to delete the proper instance, and set all relations on non-secondary tables as updates.
void	insert(OpenJPAStateManager sm, JDBCStore store, RowManager rm) Set values for the mapping into the proper rows.
Boolean	isCustomInsert(OpenJPAStateManager sm, JDBCStore store) Return Boolean.FALSE if this mapping does not customize the insert process, Boolean.TRUE if it does, or null if it does customize the insert, but also relies on the standard insert method being called.
Boolean	isCustomUpdate(OpenJPAStateManager sm, JDBCStore store) Return Boolean.FALSE if this mapping does not customize the update process, Boolean.TRUE if it does, or null if it does customize the update, but also relies on the standard update method being called.
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	map(boolean adapt) Map the owning mapping using this strategy.
int	select(Select sel, OpenJPAStateManager sm, JDBCStore store, JDBCFetchConfiguration fetch, int eagerMode) Select the virtual row columns of this mapping.
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.
void	update(OpenJPAStateManager sm, JDBCStore store, RowManager rm) Set values for the mapping into the proper rows.

Methods inherited from class org.apache.openjpa.jdbc.meta.strats.AbstractFieldStrategy

appendIndex, appendIsEmpty, appendIsNotEmpty, appendIsNotNull, appendIsNull, appendSize, appendType, isEagerSelectToMany, isVersionable, join, joinKey, joinKeyRelation, joinRelation, load, loadEagerJoin, loadEagerParallel, loadKeyProjection, loadProjection, selectEagerJoin, selectEagerParallel, toDataStoreValue, toKeyDataStoreValue, where

Methods inherited from class org.apache.openjpa.jdbc.meta.strats.AbstractStrategy

customDelete, getAlias, initialize, isCustomDelete

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, getAlias, initialize, isCustomDelete

Constructor Detail

LobFieldStrategy

public LobFieldStrategy()

Method Detail

map

public void map(boolean adapt)

Description copied from interface: Strategy

Map the owning mapping using this strategy.

Specified by:

map in interface Strategy

Overrides:

map in class AbstractStrategy

Parameters:

adapt - if true, use the owning mapping's raw mapping info to set its ORM data; if false, ORM data will already be set

isCustomInsert

public Boolean isCustomInsert(OpenJPAStateManager sm,
                     JDBCStore store)

Description copied from interface: Strategy

Return Boolean.FALSE if this mapping does not customize the insert process, Boolean.TRUE if it does, or null if it does customize the insert, but also relies on the standard insert method being called. Implement the Strategy.customInsert(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.kernel.JDBCStore) method to implement the custom insertion behavior.

Specified by:

isCustomInsert in interface Strategy

Overrides:

isCustomInsert in class AbstractStrategy

delete

public void delete(OpenJPAStateManager sm,
          JDBCStore store,
          RowManager rm)
            throws SQLException

Description copied from interface: Strategy

Set the where values appropriately to delete the proper instance, and set all relations on non-secondary tables as updates. This allows foreign key analysis.

Specified by:

delete in interface Strategy

Overrides:

delete in class AbstractStrategy

Throws:

SQLException

See Also:

Strategy.insert(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.jdbc.sql.RowManager)

insert

public void insert(OpenJPAStateManager sm,
          JDBCStore store,
          RowManager rm)
            throws SQLException

Description copied from interface: Strategy

Set values for the mapping into the proper rows. For class mappings, this method will be called only after the corresponding method has been called for all fields of this mapping.

Specified by:

insert in interface Strategy

Overrides:

insert in class AbstractStrategy

Throws:

SQLException

customInsert

public void customInsert(OpenJPAStateManager sm,
                JDBCStore store)
                  throws SQLException

Description copied from interface: Strategy

Override this method to customize flushing this mapping. For classes, this method must also flush all fields. For fields, this method is called after the owning object is inserted, so if this field is in a row with other fields, that row will already exist.

Specified by:

customInsert in interface Strategy

Overrides:

customInsert in class AbstractStrategy

Throws:

SQLException

isCustomUpdate

public Boolean isCustomUpdate(OpenJPAStateManager sm,
                     JDBCStore store)

Description copied from interface: Strategy

Return Boolean.FALSE if this mapping does not customize the update process, Boolean.TRUE if it does, or null if it does customize the update, but also relies on the standard update method being called. Implement the Strategy.customUpdate(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.kernel.JDBCStore) method to override the default update behavior.

Specified by:

isCustomUpdate in interface Strategy

Overrides:

isCustomUpdate in class AbstractStrategy

update

public void update(OpenJPAStateManager sm,
          JDBCStore store,
          RowManager rm)
            throws SQLException

Description copied from interface: Strategy

Set values for the mapping into the proper rows.

Specified by:

update in interface Strategy

Overrides:

update in class AbstractStrategy

Throws:

SQLException

See Also:

Strategy.insert(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.jdbc.sql.RowManager)

customUpdate

public void customUpdate(OpenJPAStateManager sm,
                JDBCStore store)
                  throws SQLException

Description copied from interface: Strategy

Override this method to customize flushing this mapping. For classes, this method must also flush all fields.

Specified by:

customUpdate in interface Strategy

Overrides:

customUpdate in class AbstractStrategy

Throws:

SQLException

supportsSelect

public int supportsSelect(Select sel,
                 int type,
                 OpenJPAStateManager sm,
                 JDBCStore store,
                 JDBCFetchConfiguration fetch)

Description copied from interface: FieldStrategy

Return whether this mapping can perform the given select type. Return 0 if the given type is not supported. If the given type is an eager parallel type, return the number of UNIONed selects necessary to fetch the data. Otherwise, return any positive number if the type is supported. The given state manager may be null if selecting multiple instances.

Specified by:

supportsSelect in interface FieldStrategy

Overrides:

supportsSelect in class AbstractFieldStrategy

See Also:

Select

select

public int select(Select sel,
         OpenJPAStateManager sm,
         JDBCStore store,
         JDBCFetchConfiguration fetch,
         int eagerMode)

Description copied from interface: FieldStrategy

Select the virtual row columns of this mapping.

Specified by:

select in interface FieldStrategy

Overrides:

select in class AbstractFieldStrategy

Parameters:

sel - the select to add to

sm - the instance being loaded, or null if not initialized yet or selecting for multiple instances

store - the current store manager

fetch - fetch configuration

eagerMode - the eager fetch mode to use; this may be more restrictive than the mode of the fetch configuration

Returns:

> 0 if this mapping requires the selected data (if any), 0 if it selected data but does not require it, or < 0 if no data was selected

load

public void load(OpenJPAStateManager sm,
        JDBCStore store,
        JDBCFetchConfiguration fetch,
        Result res)
          throws SQLException

Description copied from interface: FieldStrategy

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.

Specified by:

load in interface FieldStrategy

Overrides:

load in class AbstractFieldStrategy

Throws:

SQLException

assertNotMappedBy

protected void assertNotMappedBy()

Description copied from class: AbstractFieldStrategy

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

Overrides:

assertNotMappedBy in class AbstractFieldStrategy

setFieldMapping

public void setFieldMapping(FieldMapping owner)

Description copied from interface: FieldStrategy

Set the class mapping using this strategy. This will be called before use.

Specified by:

setFieldMapping in interface FieldStrategy

Overrides:

setFieldMapping in class AbstractFieldStrategy