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

java.lang.Object
  extended by org.apache.openjpa.jdbc.meta.strats.AbstractStrategy
      extended by org.apache.openjpa.jdbc.meta.strats.AbstractFieldStrategy
          extended by org.apache.openjpa.jdbc.meta.strats.ContainerFieldStrategy
              extended by org.apache.openjpa.jdbc.meta.strats.StoreCollectionFieldStrategy
                  extended by org.apache.openjpa.jdbc.meta.strats.RelationToManyTableFieldStrategy
                      extended by org.apache.openjpa.jdbc.meta.strats.RelationCollectionTableFieldStrategy
All Implemented Interfaces:
Serializable, FieldStrategy, Strategy, LRSCollectionFieldStrategy

public class RelationCollectionTableFieldStrategy
extends RelationToManyTableFieldStrategy
implements LRSCollectionFieldStrategy

Maps a collection of related objects through an association table.

Author:
Abe White
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.apache.openjpa.jdbc.meta.strats.AbstractFieldStrategy
field
 
Constructor Summary
RelationCollectionTableFieldStrategy()
           
 
Method Summary
 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.
 Column[] getElementColumns(ClassMapping elem)
          Return the columns holding the data for a collection element for the given element mapping from LRSCollectionFieldStrategy.getIndependentElementMappings(boolean) (or null).
 FieldMapping getFieldMapping()
          The owning field mapping.
 ClassMapping[] getIndependentElementMappings(boolean traverse)
          Return all independent mappings to which this strategy must join in order to access collection elements, or empty array if none.
 ForeignKey getJoinForeignKey(ClassMapping elem)
          Return the foreign key used to join to the owning field for the given element mapping from ContainerFieldStrategy.getIndependentElementMappings(boolean) (or null).
 void insert(OpenJPAStateManager sm, JDBCStore store, RowManager rm)
          Set values for the mapping into the proper rows.
 Joins join(Joins joins, ClassMapping elem)
          Join to the owning field table for the given element mapping from ContainerFieldStrategy.getIndependentElementMappings(boolean) (or null).
 Joins joinElementRelation(Joins joins, ClassMapping elem)
          Join this value's table to the table for the given element mapping from ContainerFieldStrategy.getIndependentElementMappings(boolean) (or null).
 Object loadElement(OpenJPAStateManager sm, JDBCStore store, JDBCFetchConfiguration fetch, Result res, Joins joins)
          Load an element of the collection.
 void map(boolean adapt)
          Map the owning mapping using this strategy.
protected  Proxy newLRSProxy()
          Return a large result set proxy for this field.
 void selectElement(Select sel, ClassMapping elem, JDBCStore store, JDBCFetchConfiguration fetch, int eagerMode, Joins joins)
          Implement this method to select the elements of this field for the given element mapping from ContainerFieldStrategy.getIndependentElementMappings(boolean) (or null).
 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.RelationToManyTableFieldStrategy
join, joinRelation, toDataStoreValue
 
Methods inherited from class org.apache.openjpa.jdbc.meta.strats.StoreCollectionFieldStrategy
add, getJoinForeignKey, isEagerSelectToMany, load, loadEagerJoin, loadEagerParallel, loadProjection, requiresOrderBy, selectAll, selectEagerJoin, selectEagerParallel, supportsSelect, toCollection
 
Methods inherited from class org.apache.openjpa.jdbc.meta.strats.ContainerFieldStrategy
appendIndex, appendIsEmpty, appendIsNotEmpty, appendIsNotNull, appendIsNull, appendJoinCount, appendSize, appendUnaliasedJoin
 
Methods inherited from class org.apache.openjpa.jdbc.meta.strats.AbstractFieldStrategy
appendType, assertNotMappedBy, isVersionable, joinKey, joinKeyRelation, load, loadKeyProjection, select, setFieldMapping, toKeyDataStoreValue, where
 
Methods inherited from class org.apache.openjpa.jdbc.meta.strats.AbstractStrategy
customDelete, customInsert, customUpdate, getAlias, initialize, isCustomDelete, isCustomInsert, isCustomUpdate
 
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.FieldStrategy
appendIndex, appendIsEmpty, appendIsNotEmpty, appendIsNotNull, appendIsNull, appendSize, appendType, isEagerSelectToMany, isVersionable, join, joinKey, joinKeyRelation, joinRelation, load, load, loadEagerJoin, loadEagerParallel, loadKeyProjection, loadProjection, select, selectEagerJoin, selectEagerParallel, setFieldMapping, supportsSelect, toDataStoreValue, toKeyDataStoreValue, where
 
Methods inherited from interface org.apache.openjpa.jdbc.meta.Strategy
customDelete, customInsert, customUpdate, getAlias, initialize, isCustomDelete, isCustomInsert, isCustomUpdate
 

Constructor Detail

RelationCollectionTableFieldStrategy

public RelationCollectionTableFieldStrategy()
Method Detail

getFieldMapping

public FieldMapping getFieldMapping()
Description copied from interface: LRSCollectionFieldStrategy
The owning field mapping.

Specified by:
getFieldMapping in interface LRSCollectionFieldStrategy

getIndependentElementMappings

public ClassMapping[] getIndependentElementMappings(boolean traverse)
Description copied from class: ContainerFieldStrategy
Return all independent mappings to which this strategy must join in order to access collection elements, or empty array if none.

Specified by:
getIndependentElementMappings in interface LRSCollectionFieldStrategy
Overrides:
getIndependentElementMappings in class RelationToManyTableFieldStrategy
Parameters:
traverse - whether we're traversing through to the related type
See Also:
ValueMapping.getIndependentTypeMappings(), ClassMapping.EMPTY_MAPPINGS

getElementColumns

public Column[] getElementColumns(ClassMapping elem)
Description copied from interface: LRSCollectionFieldStrategy
Return the columns holding the data for a collection element for the given element mapping from LRSCollectionFieldStrategy.getIndependentElementMappings(boolean) (or null).

Specified by:
getElementColumns in interface LRSCollectionFieldStrategy

getJoinForeignKey

public ForeignKey getJoinForeignKey(ClassMapping elem)
Description copied from class: StoreCollectionFieldStrategy
Return the foreign key used to join to the owning field for the given element mapping from ContainerFieldStrategy.getIndependentElementMappings(boolean) (or null).

Specified by:
getJoinForeignKey in interface LRSCollectionFieldStrategy
Overrides:
getJoinForeignKey in class RelationToManyTableFieldStrategy

selectElement

public void selectElement(Select sel,
                          ClassMapping elem,
                          JDBCStore store,
                          JDBCFetchConfiguration fetch,
                          int eagerMode,
                          Joins joins)
Description copied from class: StoreCollectionFieldStrategy
Implement this method to select the elements of this field for the given element mapping from ContainerFieldStrategy.getIndependentElementMappings(boolean) (or null). Elements of the result will be loaded with StoreCollectionFieldStrategy.loadElement(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration, org.apache.openjpa.jdbc.sql.Result, org.apache.openjpa.jdbc.sql.Joins).

Specified by:
selectElement in interface LRSCollectionFieldStrategy
Overrides:
selectElement in class RelationToManyTableFieldStrategy

loadElement

public Object loadElement(OpenJPAStateManager sm,
                          JDBCStore store,
                          JDBCFetchConfiguration fetch,
                          Result res,
                          Joins joins)
                   throws SQLException
Description copied from class: StoreCollectionFieldStrategy
Load an element of the collection. The given state manager might be null if the load is for a projection or for processing eager parallel results.

Specified by:
loadElement in interface LRSCollectionFieldStrategy
Overrides:
loadElement in class RelationToManyTableFieldStrategy
Throws:
SQLException

join

public Joins join(Joins joins,
                  ClassMapping elem)
Description copied from class: StoreCollectionFieldStrategy
Join to the owning field table for the given element mapping from ContainerFieldStrategy.getIndependentElementMappings(boolean) (or null).

Overrides:
join in class RelationToManyTableFieldStrategy

joinElementRelation

public Joins joinElementRelation(Joins joins,
                                 ClassMapping elem)
Description copied from class: StoreCollectionFieldStrategy
Join this value's table to the table for the given element mapping from ContainerFieldStrategy.getIndependentElementMappings(boolean) (or null).

Specified by:
joinElementRelation in interface LRSCollectionFieldStrategy
Overrides:
joinElementRelation in class RelationToManyTableFieldStrategy
See Also:
FieldMapping.joinRelation(org.apache.openjpa.jdbc.sql.Joins, boolean, boolean)

newLRSProxy

protected Proxy newLRSProxy()
Description copied from class: StoreCollectionFieldStrategy
Return a large result set proxy for this field.

Specified by:
newLRSProxy in class StoreCollectionFieldStrategy

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 RelationToManyTableFieldStrategy
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

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 RelationToManyTableFieldStrategy
Throws:
SQLException

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 RelationToManyTableFieldStrategy
Throws:
SQLException
See Also:
Strategy.insert(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.jdbc.sql.RowManager)

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 RelationToManyTableFieldStrategy
Throws:
SQLException
See Also:
Strategy.insert(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.jdbc.sql.RowManager)


Copyright © 2006-2010 Apache Software Foundation. All Rights Reserved.