org.jpox.store.rdbms.scostore
Class JoinArrayStore

java.lang.Object
  org.jpox.store.rdbms.scostore.ElementContainerStore
      org.jpox.store.rdbms.scostore.AbstractArrayStore
          org.jpox.store.rdbms.scostore.JoinArrayStore

All Implemented Interfaces:

org.jpox.store.mapped.scostore.ArrayStoreQueryable, org.jpox.store.scostore.ArrayStore, org.jpox.store.scostore.Store

public class JoinArrayStore
extends AbstractArrayStore

Backing store for an array stored using a join table. Can be used for all types of arrays :- PersistenceCapable arrays, non-PersistenceCapable arrays, reference arrays.

Version:

$Revision: 1.18 $

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 RDBMSManager	storeMgr Manager for the store.

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

JoinArrayStore(ArrayTable joinTable, org.jpox.ClassLoaderResolver clr)
Constructor.

Method Summary

protected boolean	allowsBatching() Convenience method to return if the RDBMS supports batching and the user wants batching.
protected org.jpox.store.mapped.expression.QueryExpression	getIteratorStatement(org.jpox.StateManager ownerSM) Accessor for the iterator statement to retrieve the element(s) for the array.
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 boolean	isEmbeddedMapping(org.jpox.store.mapped.mapping.JavaTypeMapping mapping) Check if the mapping correspond to a non pc object or embedded field
org.jpox.store.mapped.expression.ScalarExpression	joinElementsTo(org.jpox.store.mapped.expression.QueryExpression stmt, org.jpox.store.mapped.expression.QueryExpression parentStmt, org.jpox.store.mapped.mapping.JavaTypeMapping ownerMapping, org.jpox.store.mapped.expression.LogicSetExpression ownerTe, org.jpox.store.mapped.DatastoreIdentifier listTableAlias, java.lang.Class filteredElementType, org.jpox.store.mapped.expression.ScalarExpression elmExpr, org.jpox.store.mapped.DatastoreIdentifier elementTableAlias) Method used in queries when contains() has been invoked.
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.
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.AbstractArrayStore

add, clear, getArray, getExistsSubquery, getSizeSubquery, internalAdd, iterator, set

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.ArrayStore

getElementType, size

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

getStoreManager

Field Detail

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

JoinArrayStore

public JoinArrayStore(ArrayTable joinTable,
                      org.jpox.ClassLoaderResolver clr)

Constructor.

Parameters:

joinTable - Join table storing the relationship between owner and element

clr - ClassLoader resolver

Method Detail

getIteratorStatement

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

Accessor for the iterator statement to retrieve the element(s) for the array.

Specified by:

getIteratorStatement in class AbstractArrayStore

Parameters:

ownerSM - The StateManager

Returns:

The Query Statement.

joinElementsTo

public org.jpox.store.mapped.expression.ScalarExpression joinElementsTo(org.jpox.store.mapped.expression.QueryExpression stmt,
                                                                        org.jpox.store.mapped.expression.QueryExpression parentStmt,
                                                                        org.jpox.store.mapped.mapping.JavaTypeMapping ownerMapping,
                                                                        org.jpox.store.mapped.expression.LogicSetExpression ownerTe,
                                                                        org.jpox.store.mapped.DatastoreIdentifier listTableAlias,
                                                                        java.lang.Class filteredElementType,
                                                                        org.jpox.store.mapped.expression.ScalarExpression elmExpr,
                                                                        org.jpox.store.mapped.DatastoreIdentifier elementTableAlias)

Method used in queries when contains() has been invoked.

Parameters:

stmt - The Query Statement

parentStmt - the parent Query Statement. If there is no parent, parentStmt must be equals to stmt

ownerMapping - the mapping for the owner.

ownerTe - Table Expression for the owner

listTableAlias - Alias for the "List" table.

filteredElementType - The Class Type for the filtered element

elmExpr - The Expression for the element

elementTableAlias - The SQL alias to assign to the expression or to the element table.

Returns:

expression to the join

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