org.datanucleus.store.rdbms.scostore

Class JoinMapStore

java.lang.Object

org.datanucleus.store.rdbms.scostore.BaseContainerStore

org.datanucleus.store.rdbms.scostore.AbstractMapStore

org.datanucleus.store.rdbms.scostore.JoinMapStore

All Implemented Interfaces:

org.datanucleus.store.scostore.MapStore, org.datanucleus.store.scostore.Store

public class JoinMapStore
extends AbstractMapStore

RDBMS-specific implementation of an MapStore using join table.

Field Summary

Fields

Modifier and Type	Field and Description
protected JavaTypeMapping	adapterMapping when the element mappings columns can't be part of the primary key by datastore limitations like BLOB types.

Fields inherited from class org.datanucleus.store.rdbms.scostore.AbstractMapStore

iterateUsingDiscriminator, keyMapping, keysAreEmbedded, keysAreSerialised, keyType, kmd, mapTable, valueMapping, valuesAreEmbedded, valuesAreSerialised, valueTable, valueType, vmd

Fields inherited from class org.datanucleus.store.rdbms.scostore.BaseContainerStore

allowNulls, clr, dba, LOCALISER, ownerMapping, ownerMemberMetaData, relationType, storeMgr

Constructor Summary

Constructors

Constructor and Description
JoinMapStore(MapTable mapTable, org.datanucleus.ClassLoaderResolver clr) Constructor for the backing store of a join map for RDBMS.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear(org.datanucleus.state.ObjectProvider ownerOP) Method to clear the map of all values.
protected void	clearInternal(org.datanucleus.state.ObjectProvider ownerOP)
org.datanucleus.store.scostore.SetStore	entrySetStore() Accessor for the map entries in the Map.
JavaTypeMapping	getAdapterMapping()
protected SQLStatement	getSQLStatementForGet(org.datanucleus.state.ObjectProvider ownerOP) Method to return an SQLStatement for retrieving the value for a key.
protected Object	getValue(org.datanucleus.state.ObjectProvider ownerOP, Object key) Method to retrieve a value from the Map given the key.
protected int[]	internalPut(org.datanucleus.state.ObjectProvider ownerOP, org.datanucleus.store.connection.ManagedConnection conn, boolean batched, Object key, Object value, boolean executeNow) Method to process a "put" statement (where the key has no value in the join table).
protected void	internalUpdate(org.datanucleus.state.ObjectProvider ownerOP, org.datanucleus.store.connection.ManagedConnection conn, boolean batched, Object key, Object value, boolean executeNow) Method to process an "update" statement (where the key already has a value in the join table).
org.datanucleus.store.scostore.SetStore	keySetStore() Accessor for the keys in the Map.
protected org.datanucleus.store.scostore.SetStore	newMapEntrySetStore()
protected org.datanucleus.store.scostore.SetStore	newMapKeySetStore()
protected org.datanucleus.store.scostore.CollectionStore	newMapValueCollectionStore()
Object	put(org.datanucleus.state.ObjectProvider op, Object key, Object value) Method to put an item in the Map.
void	putAll(org.datanucleus.state.ObjectProvider op, Map m) Method to put all elements from a Map into our Map.
Object	remove(org.datanucleus.state.ObjectProvider op, Object key) Method to remove an entry from the map.
Object	remove(org.datanucleus.state.ObjectProvider op, Object key, Object oldValue) Method to remove an item from the map.
protected void	removeInternal(org.datanucleus.state.ObjectProvider op, Object key)
org.datanucleus.store.scostore.CollectionStore	valueCollectionStore() Accessor for the values in the Map.

Methods inherited from class org.datanucleus.store.rdbms.scostore.AbstractMapStore

containsKey, containsValue, get, getKeyMapping, getKmd, getMapTable, getUpdateEmbeddedKeyStmt, getUpdateEmbeddedValueStmt, getValueMapping, getVmd, initialise, isValuesAreEmbedded, isValuesAreSerialised, keysAreEmbedded, keysAreSerialised, updatedEmbeddedKey, updateEmbeddedKey, updateEmbeddedValue, updateEmbeddedValue, validateKeyForReading, validateKeyForWriting, validateKeyType, validateValueForReading, validateValueForWriting, validateValueType, valuesAreEmbedded, valuesAreSerialised

Methods inherited from class org.datanucleus.store.rdbms.scostore.BaseContainerStore

allowsBatching, getDatastoreAdapter, getObjectProviderForEmbeddedPCObject, getOwnerMapping, getOwnerMemberMetaData, getRelationType, getStoreManager, isEmbeddedMapping, setOwner

Methods inherited from class java.lang.Object

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

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

getOwnerMemberMetaData, getStoreManager

Field Detail

adapterMapping

protected final JavaTypeMapping adapterMapping

when the element mappings columns can't be part of the primary key by datastore limitations like BLOB types. An adapter mapping is used to be a kind of "index"

Constructor Detail

JoinMapStore

public JoinMapStore(MapTable mapTable,
            org.datanucleus.ClassLoaderResolver clr)

Constructor for the backing store of a join map for RDBMS.

Parameters:

mapTable - Join table for the Map

clr - The ClassLoaderResolver

Method Detail

putAll

public void putAll(org.datanucleus.state.ObjectProvider op,
          Map m)

Method to put all elements from a Map into our Map.

Specified by:

putAll in interface org.datanucleus.store.scostore.MapStore

Overrides:

putAll in class AbstractMapStore

Parameters:

op - ObjectProvider for the Map

m - The Map to add

put

public Object put(org.datanucleus.state.ObjectProvider op,
         Object key,
         Object value)

Method to put an item in the Map.

Parameters:

op - ObjectProvider for the map.

key - The key to store the value against

value - The value to store.

Returns:

The value stored.

remove

public Object remove(org.datanucleus.state.ObjectProvider op,
            Object key)

Method to remove an entry from the map.

Parameters:

op - ObjectProvider for the map.

key - Key of the entry to remove.

Returns:

The value that was removed.

remove

public Object remove(org.datanucleus.state.ObjectProvider op,
            Object key,
            Object oldValue)

Method to remove an item from the map.

Parameters:

op - ObjectProvider for the map.

key - Key of the item to remove.

Returns:

The value that was removed.

clear

public void clear(org.datanucleus.state.ObjectProvider ownerOP)

Method to clear the map of all values.

Parameters:

ownerOP - ObjectProvider for the map.

keySetStore

public org.datanucleus.store.scostore.SetStore keySetStore()

Accessor for the keys in the Map.

Returns:

The keys

valueCollectionStore

public org.datanucleus.store.scostore.CollectionStore valueCollectionStore()

Accessor for the values in the Map.

Returns:

The values.

entrySetStore

public org.datanucleus.store.scostore.SetStore entrySetStore()

Accessor for the map entries in the Map.

Returns:

The map entries.

getAdapterMapping

public JavaTypeMapping getAdapterMapping()

getValue

protected Object getValue(org.datanucleus.state.ObjectProvider ownerOP,
              Object key)
                   throws NoSuchElementException

Method to retrieve a value from the Map given the key.

Specified by:

getValue in class AbstractMapStore

Parameters:

ownerOP - ObjectProvider for the owner of the map.

key - The key to retrieve the value for.

Returns:

The value for this key

Throws:

NoSuchElementException - if the value for the key was not found

getSQLStatementForGet

protected SQLStatement getSQLStatementForGet(org.datanucleus.state.ObjectProvider ownerOP)

Method to return an SQLStatement for retrieving the value for a key. Selects the join table and optionally joins to the value table if it has its own table.

Parameters:

ownerOP - ObjectProvider for the owning object

Returns:

The SQLStatement

clearInternal

protected void clearInternal(org.datanucleus.state.ObjectProvider ownerOP)

removeInternal

protected void removeInternal(org.datanucleus.state.ObjectProvider op,
                  Object key)

newMapKeySetStore

protected org.datanucleus.store.scostore.SetStore newMapKeySetStore()

newMapValueCollectionStore

protected org.datanucleus.store.scostore.CollectionStore newMapValueCollectionStore()

newMapEntrySetStore

protected org.datanucleus.store.scostore.SetStore newMapEntrySetStore()

internalUpdate

protected void internalUpdate(org.datanucleus.state.ObjectProvider ownerOP,
                  org.datanucleus.store.connection.ManagedConnection conn,
                  boolean batched,
                  Object key,
                  Object value,
                  boolean executeNow)
                       throws MappedDatastoreException

Method to process an "update" statement (where the key already has a value in the join table).

Parameters:

ownerOP - ObjectProvider for the owner

conn - The Connection

batched - Whether we are batching it

key - The key

value - The new value

executeNow - Whether to execute the statement now or wait til any batch

Throws:

MappedDatastoreException - Thrown if an error occurs

internalPut

protected int[] internalPut(org.datanucleus.state.ObjectProvider ownerOP,
                org.datanucleus.store.connection.ManagedConnection conn,
                boolean batched,
                Object key,
                Object value,
                boolean executeNow)
                     throws MappedDatastoreException

Method to process a "put" statement (where the key has no value in the join table).

Parameters:

ownerOP - ObjectProvider for the owner

conn - The Connection

batched - Whether we are batching it

key - The key

value - The value

executeNow - Whether to execute the statement now or wait til batching

Returns:

The return codes from any executed statement

Throws:

MappedDatastoreException - Thrown if an error occurs