org.jpox.store.rdbms.scostore
Class MapValueSetStore

java.lang.Object
  org.jpox.store.rdbms.scostore.ElementContainerStore
      org.jpox.store.rdbms.scostore.AbstractCollectionStore
          org.jpox.store.rdbms.scostore.MapValueSetStore

All Implemented Interfaces:

org.jpox.store.mapped.scostore.CollectionStoreQueryable, org.jpox.store.scostore.CollectionStore, org.jpox.store.scostore.SetStore, org.jpox.store.scostore.Store

public class MapValueSetStore
extends AbstractCollectionStore

Representation of the backing store for a MapValue Set. This is used where the user calls Map.values() and then wants to perform some operation on the resulting Collection. TODO Cater for embedded values.

Version:

$Revision: 1.69 $

Nested Class Summary

Nested classes/interfaces inherited from class org.jpox.store.rdbms.scostore.ElementContainerStore

ElementContainerStore.ElementInfo

Field Summary

protected boolean	allowsNull Whether the container allows null elements/values.
protected org.jpox.store.mapped.DatastoreAdapter	dba Datastore adapter in use by this store.
protected static org.jpox.util.Localiser	LOCALISER Localiser for messages.
protected org.jpox.store.mapped.mapping.JavaTypeMapping	ownerMapping Mapping to the owner of the container.
protected org.jpox.metadata.AbstractMemberMetaData	ownerMemberMetaData MetaData for the field/property in the owner with this container.
protected java.lang.String	setName
protected RDBMSManager	storeMgr Manager for the store.

Fields inherited from class org.jpox.store.rdbms.scostore.AbstractCollectionStore

containsStmt

Fields inherited from class org.jpox.store.rdbms.scostore.ElementContainerStore

addStmt, clearStmt, clr, containerTable, elementInfo, elementIsPersistentInterface, elementMapping, elementsAreEmbedded, elementsAreSerialised, elementType, elmIdentifier, emd, iterateUsingDiscriminator, orderMapping, relationDiscriminatorMapping, relationDiscriminatorValue, removeStmt, usingDiscriminatorInSizeStmt

Constructor Summary

MapValueSetStore(org.jpox.store.mapped.DatastoreClass valueTable, org.jpox.store.mapped.mapping.JavaTypeMapping ownerMapping, org.jpox.store.mapped.mapping.JavaTypeMapping valueMapping, org.jpox.store.scostore.MapStore mapStore, org.jpox.ClassLoaderResolver clr, org.jpox.metadata.AbstractMemberMetaData fmd)
Constructor where either the key is stored in the value table or the value is stored in the key table.

MapValueSetStore(MapTable mapTable, org.jpox.store.scostore.MapStore mapStore, org.jpox.ClassLoaderResolver clr)
Constructor where a join table is used to store the map relation.

Method Summary

boolean	add(org.jpox.StateManager sm, java.lang.Object element, int size) Method to add a value to the Map.
boolean	addAll(org.jpox.StateManager sm, java.util.Collection elements, int size) Method to add entries to the Map.
protected boolean	allowsBatching() Convenience method to return if the RDBMS supports batching and the user wants batching.
void	clear(org.jpox.StateManager sm) Method to clear the map.
protected org.jpox.store.mapped.expression.QueryExpression	getIteratorStatement(org.jpox.StateManager ownerSM) Accessor for the statement for the iterator.
org.jpox.store.mapped.mapping.JavaTypeMapping	getOwnerMapping() Accessor for the owner mapping.
protected org.jpox.StateManager	getStateManagerForEmbeddedPCObject(org.jpox.StateManager sm, java.lang.Object obj, JoinTable table) Method to return the StateManager for an embedded PC object (element, key, value).
org.jpox.store.StoreManager	getStoreManager() Accessor for the RDBMSManager.
protected int[]	internalAdd(org.jpox.StateManager ownerSM, org.jpox.ManagedConnection conn, boolean batched, java.lang.Object element, boolean processNow) Method to process an "add" statement.
protected int[]	internalRemove(org.jpox.StateManager ownerSM, org.jpox.ManagedConnection conn, boolean batched, java.lang.Object element, boolean executeNow) Method to process a "remove" statement.
protected boolean	isEmbeddedMapping(org.jpox.store.mapped.mapping.JavaTypeMapping mapping) Check if the mapping correspond to a non pc object or embedded field
java.util.Iterator	iterator(org.jpox.StateManager ownerSM) Accessor for an iterator for the set.
org.jpox.store.mapped.expression.ScalarExpression	joinElementsTo(org.jpox.store.mapped.expression.QueryExpression stmt, org.jpox.store.mapped.expression.QueryExpression qs, org.jpox.store.mapped.mapping.JavaTypeMapping ownerMapping, org.jpox.store.mapped.expression.LogicSetExpression te, org.jpox.store.mapped.DatastoreIdentifier setRangeVar, java.lang.Class filteredElementType, org.jpox.store.mapped.expression.ScalarExpression elmExpr, org.jpox.store.mapped.DatastoreIdentifier elementRangeVar, boolean existsQuery)
org.jpox.store.mapped.expression.QueryExpression	newQueryStatement(org.jpox.StateManager sm, java.lang.String candidateClass, org.jpox.store.mapped.DatastoreIdentifier candidateAlias)
protected int	populateOwnerInStatement(org.jpox.StateManager sm, org.jpox.ObjectManager om, java.sql.PreparedStatement ps, int jdbcPosition) Convenience method to populate the passed PreparedStatement with the value from the owner.
boolean	remove(org.jpox.StateManager sm, java.lang.Object element, int size, boolean allowDependentField) Method to remove a value from the Map.
boolean	removeAll(org.jpox.StateManager sm, java.util.Collection elements, int size) Method to remove elements from the map via the value collection.
protected void	setOwnerMemberMetaData(org.jpox.metadata.AbstractMemberMetaData mmd) Method to set the owner field/property MetaData and sets whether null elements/values are allowed.

Methods inherited from class org.jpox.store.rdbms.scostore.AbstractCollectionStore

contains, getContainsStmt, getExistsSubquery, getRemoveStmt, getSizeSubquery, getUpdateEmbeddedElementStmt, updateEmbeddedElement

Methods inherited from class org.jpox.store.rdbms.scostore.ElementContainerStore

getAddStmt, getClearStmt, getElementInformationForClass, getElementType, getSizeStmt, hasOrderMapping, newResultObjectFactory, populateElementDiscriminatorInStatement, populateElementInStatement, populateEmbeddedElementFieldsInStatement, populateOrderInStatement, populateRelationDiscriminatorInStatement, size, validateElementForReading, validateElementForWriting, validateElementType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jpox.store.scostore.CollectionStore

contains, getElementType, hasOrderMapping, size, updateEmbeddedElement

Methods inherited from interface org.jpox.store.scostore.Store

getStoreManager

Methods inherited from interface org.jpox.store.mapped.scostore.CollectionStoreQueryable

newResultObjectFactory

Field Detail

setName

protected java.lang.String setName

LOCALISER

protected static final org.jpox.util.Localiser LOCALISER

Localiser for messages.

storeMgr

protected RDBMSManager storeMgr

Manager for the store.

dba

protected org.jpox.store.mapped.DatastoreAdapter dba

Datastore adapter in use by this store.

ownerMapping

protected org.jpox.store.mapped.mapping.JavaTypeMapping ownerMapping

Mapping to the owner of the container.

ownerMemberMetaData

protected org.jpox.metadata.AbstractMemberMetaData ownerMemberMetaData

MetaData for the field/property in the owner with this container.

allowsNull

protected boolean allowsNull

Whether the container allows null elements/values.

Constructor Detail

MapValueSetStore

public MapValueSetStore(MapTable mapTable,
                        org.jpox.store.scostore.MapStore mapStore,
                        org.jpox.ClassLoaderResolver clr)

Constructor where a join table is used to store the map relation.

Parameters:

mapTable - Table used by the map

mapStore - Store used by the map

clr - The ClassLoaderResolver

MapValueSetStore

public MapValueSetStore(org.jpox.store.mapped.DatastoreClass valueTable,
                        org.jpox.store.mapped.mapping.JavaTypeMapping ownerMapping,
                        org.jpox.store.mapped.mapping.JavaTypeMapping valueMapping,
                        org.jpox.store.scostore.MapStore mapStore,
                        org.jpox.ClassLoaderResolver clr,
                        org.jpox.metadata.AbstractMemberMetaData fmd)

Constructor where either the key is stored in the value table or the value is stored in the key table.

Parameters:

valueTable - Table for the values

ownerMapping - Mapping to the owner

valueMapping - The mapping for this table to the value table/column

mapStore - Store used by the map.

clr - The ClassLoaderResolver

fmd - FieldMetaData for the owning "map" field

Method Detail

getIteratorStatement

protected org.jpox.store.mapped.expression.QueryExpression getIteratorStatement(org.jpox.StateManager ownerSM)

Accessor for the statement for the iterator.

Parameters:

ownerSM - the owner StateManager

Returns:

The iterator Query Statement.

add

public boolean add(org.jpox.StateManager sm,
                   java.lang.Object element,
                   int size)

Method to add a value to the Map. Not supported.

Specified by:

add in interface org.jpox.store.scostore.CollectionStore

Parameters:

sm - State Manager for the owner

element - The value to add

Returns:

Whether it was added correctly.

addAll

public boolean addAll(org.jpox.StateManager sm,
                      java.util.Collection elements,
                      int size)

Method to add entries to the Map. Not supported.

Specified by:

addAll in interface org.jpox.store.scostore.CollectionStore

Parameters:

sm - State Manager for the owner

elements - The values to add

size - Current size of set (if known). Not used by sets

Returns:

Whether it was added correctly.

remove

public boolean remove(org.jpox.StateManager sm,
                      java.lang.Object element,
                      int size,
                      boolean allowDependentField)

Method to remove a value from the Map.

Specified by:

remove in interface org.jpox.store.scostore.CollectionStore

Parameters:

sm - State Manager for the owner

element - The value to remove

size - Current size

allowDependentField - Whether to allow any cascade deletes caused by this removal

Returns:

Whether it was removed correctly.

removeAll

public boolean removeAll(org.jpox.StateManager sm,
                         java.util.Collection elements,
                         int size)

Method to remove elements from the map via the value collection.

Specified by:

removeAll in interface org.jpox.store.scostore.CollectionStore

Parameters:

sm - StateManager for the owner

elements - Collection of elements to remove

Returns:

Whether the database was updated

clear

public void clear(org.jpox.StateManager sm)

Method to clear the map.

Specified by:

clear in interface org.jpox.store.scostore.CollectionStore

Overrides:

clear in class ElementContainerStore

Parameters:

sm - StateManager for the owner

newQueryStatement

public org.jpox.store.mapped.expression.QueryExpression newQueryStatement(org.jpox.StateManager sm,
                                                                          java.lang.String candidateClass,
                                                                          org.jpox.store.mapped.DatastoreIdentifier candidateAlias)

joinElementsTo

public org.jpox.store.mapped.expression.ScalarExpression joinElementsTo(org.jpox.store.mapped.expression.QueryExpression stmt,
                                                                        org.jpox.store.mapped.expression.QueryExpression qs,
                                                                        org.jpox.store.mapped.mapping.JavaTypeMapping ownerMapping,
                                                                        org.jpox.store.mapped.expression.LogicSetExpression te,
                                                                        org.jpox.store.mapped.DatastoreIdentifier setRangeVar,
                                                                        java.lang.Class filteredElementType,
                                                                        org.jpox.store.mapped.expression.ScalarExpression elmExpr,
                                                                        org.jpox.store.mapped.DatastoreIdentifier elementRangeVar,
                                                                        boolean existsQuery)

iterator

public java.util.Iterator iterator(org.jpox.StateManager ownerSM)

Accessor for an iterator for the set.

Specified by:

iterator in interface org.jpox.store.scostore.CollectionStore

Specified by:

iterator in class ElementContainerStore

Parameters:

ownerSM - State Manager for the set.

Returns:

Iterator for the set.

internalAdd

protected int[] internalAdd(org.jpox.StateManager ownerSM,
                            org.jpox.ManagedConnection conn,
                            boolean batched,
                            java.lang.Object element,
                            boolean processNow)
                     throws java.sql.SQLException

Method to process an "add" statement.

Parameters:

ownerSM - StateManager for the owner

conn - The connection

batched - Whether we are batching it

element - The element

Returns:

Number of datastore records changed (always 0 if batch since nothing yet changed)

Throws:

java.sql.SQLException - Thrown if an error occurs

internalRemove

protected int[] internalRemove(org.jpox.StateManager ownerSM,
                               org.jpox.ManagedConnection conn,
                               boolean batched,
                               java.lang.Object element,
                               boolean executeNow)
                        throws java.sql.SQLException

Method to process a "remove" statement.

Overrides:

internalRemove in class AbstractCollectionStore

Parameters:

ownerSM - StateManager for the owner

conn - The connection

batched - Whether we are batching it

element - The element

executeNow - Whether to execute the statement rather than allow batching til later

Returns:

Number of records changed (0 if batch since nothing yet changed)

Throws:

java.sql.SQLException - Thrown if an error occurs

setOwnerMemberMetaData

protected void setOwnerMemberMetaData(org.jpox.metadata.AbstractMemberMetaData mmd)

Method to set the owner field/property MetaData and sets whether null elements/values are allowed.

Parameters:

mmd - MetaData for the field/property owning this backing store.

getStoreManager

public org.jpox.store.StoreManager getStoreManager()

Accessor for the RDBMSManager.

Returns:

The RDBMSManager.

getOwnerMapping

public org.jpox.store.mapped.mapping.JavaTypeMapping getOwnerMapping()

Accessor for the owner mapping.

Returns:

Owner mapping.

isEmbeddedMapping

protected boolean isEmbeddedMapping(org.jpox.store.mapped.mapping.JavaTypeMapping mapping)

Check if the mapping correspond to a non pc object or embedded field

Parameters:

mapping - the mapping

Returns:

true if the field is embedded into one column

populateOwnerInStatement

protected int populateOwnerInStatement(org.jpox.StateManager sm,
                                       org.jpox.ObjectManager om,
                                       java.sql.PreparedStatement ps,
                                       int jdbcPosition)

Convenience method to populate the passed PreparedStatement with the value from the owner.

Parameters:

sm - State Manager

om - Object Manager

ps - The PreparedStatement

jdbcPosition - Position in JDBC statement to populate

Returns:

The next position in the JDBC statement

getStateManagerForEmbeddedPCObject

protected org.jpox.StateManager getStateManagerForEmbeddedPCObject(org.jpox.StateManager sm,
                                                                   java.lang.Object obj,
                                                                   JoinTable table)

Method to return the StateManager for an embedded PC object (element, key, value). It creates one if the element is not currently managed.

Parameters:

sm - State Manager of the owner

obj - The embedded PC object

table - Join table where the objects are stored

Returns:

The state manager

allowsBatching

protected boolean allowsBatching()

Convenience method to return if the RDBMS supports batching and the user wants batching.

Returns:

If batching of statements is permissible