org.datanucleus.store.rdbms.scostore

Class FKMapStore

java.lang.Object

org.datanucleus.store.rdbms.scostore.BaseContainerStore

org.datanucleus.store.rdbms.scostore.AbstractMapStore

org.datanucleus.store.rdbms.scostore.FKMapStore

All Implemented Interfaces:

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

public class FKMapStore
extends AbstractMapStore

RDBMS-specific implementation of an MapStore where either the value has a FK to the owner (and the key stored in the value), or whether the key has a FK to the owner (and the value stored in the key).

Field Summary

Fields

Modifier and Type	Field and Description
protected int	keyFieldNumber Field number of key in value class (when Key=Non-PC, Value=PC).

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
FKMapStore(org.datanucleus.metadata.AbstractMemberMetaData mmd, RDBMSStoreManager storeMgr, org.datanucleus.ClassLoaderResolver clr) Constructor for the backing store for an FK Map for RDBMS.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear(org.datanucleus.state.ObjectProvider op) Method to clear the map of all values.
void	clearKeyOfValue(org.datanucleus.state.ObjectProvider op, Object key, Object oldValue) Utility to clear the key of a value from the Map.
org.datanucleus.store.scostore.SetStore	entrySetStore() Accessor for the map entries in the Map.
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 void	initialise() Method to initialise the statements being used.
org.datanucleus.store.scostore.SetStore	keySetStore() Accessor for the keys in the Map.
Object	put(org.datanucleus.state.ObjectProvider op, Object newKey, Object newValue) Method to put an item in the 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 entry from the map.
protected boolean	updateKeyFkInternal(org.datanucleus.state.ObjectProvider op, Object key, Object owner)
protected boolean	updateValueFkInternal(org.datanucleus.state.ObjectProvider op, Object value, Object owner)
protected void	validateValueType(org.datanucleus.ClassLoaderResolver clr, Object value) Utility to validate the type of a value for storing in the Map.
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, isValuesAreEmbedded, isValuesAreSerialised, keysAreEmbedded, keysAreSerialised, putAll, updatedEmbeddedKey, updateEmbeddedKey, updateEmbeddedValue, updateEmbeddedValue, validateKeyForReading, validateKeyForWriting, validateKeyType, validateValueForReading, validateValueForWriting, 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

keyFieldNumber

protected int keyFieldNumber

Field number of key in value class (when Key=Non-PC, Value=PC).

Constructor Detail

FKMapStore

public FKMapStore(org.datanucleus.metadata.AbstractMemberMetaData mmd,
          RDBMSStoreManager storeMgr,
          org.datanucleus.ClassLoaderResolver clr)

Constructor for the backing store for an FK Map for RDBMS.

Parameters:

mmd - Field Meta-Data for the Map field.

storeMgr - The Store Manager we are using.

clr - The ClassLoaderResolver

Method Detail

initialise

protected void initialise()

Description copied from class: AbstractMapStore

Method to initialise the statements being used. Subclasses should override the getXXXStmt() if they want to use an alternative statement.

Overrides:

initialise in class AbstractMapStore

validateValueType

protected void validateValueType(org.datanucleus.ClassLoaderResolver clr,
                     Object value)

Utility to validate the type of a value for storing in the Map.

Overrides:

validateValueType in class AbstractMapStore

Parameters:

value - The value to check.

clr - The ClassLoaderResolver

put

public Object put(org.datanucleus.state.ObjectProvider op,
         Object newKey,
         Object newValue)

Method to put an item in the Map.

Parameters:

op - ObjectProvider for the map.

newKey - The key to store the value against

newValue - 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 entry from the map.

Parameters:

op - ObjectProvider for the map.

key - Key of the entry to remove.

Returns:

The value that was removed.

clear

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

Method to clear the map of all values.

Parameters:

op - ObjectProvider for the map.

clearKeyOfValue

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

Utility to clear the key of a value from the Map. If the key is non nullable, delete the value.

Parameters:

op - ObjectProvider for the map.

key - Key of the object

oldValue - Value to remove

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.

updateValueFkInternal

protected boolean updateValueFkInternal(org.datanucleus.state.ObjectProvider op,
                            Object value,
                            Object owner)

updateKeyFkInternal

protected boolean updateKeyFkInternal(org.datanucleus.state.ObjectProvider op,
                          Object key,
                          Object owner)

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