org.datanucleus.store.mapped.scostore
Class FKMapStore

java.lang.Object
  org.datanucleus.store.mapped.scostore.BaseContainerStore
      org.datanucleus.store.mapped.scostore.AbstractMapStore
          org.datanucleus.store.mapped.scostore.FKMapStore

All Implemented Interfaces:

MapStore, Store

public abstract class FKMapStore
extends AbstractMapStore

Representation of a FK backing for a Map. This class is used where you have a 1-N and the tables are not joined via a link table, instead using a FK. There are 2 possible uses here

• bidirectional - where the owner has a Map of (key,value), and the key/value has an owner. In this case the key/value class will have an owner field which can be updated directly
• unidirectional - where the owner has a Map of (key,value), but the key/value knows nothing about the owner. In this case the key/value class has no owner field. In this case the column in the key/value table has to be updated directly.

In both cases the value class will have a field that represents the key, and so the user must specify a 'key mapped-by="..."' attribute to denote which field is the key, or a 'value mapped-by="..."' to denote which field is the value.

Field Summary

protected ClassLoaderResolver	clr
protected int	keyFieldNumber Field number of key in value class (when Key=Non-PC, Value=PC).

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

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

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

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

Constructor Summary

FKMapStore(AbstractMemberMetaData fmd, MappedStoreManager storeMgr, ClassLoaderResolver clr, AbstractMapStoreSpecialization specialization)
Constructor for an Inverse Map.

Method Summary

void	clear(ObjectProvider sm) Method to clear the map of all values.
void	clearKeyOfValue(ObjectProvider sm, java.lang.Object key, java.lang.Object oldValue) Utility to clear the key of a value from the Map.
SetStore	entrySetStore() Accessor for the map entries in the Map.
protected abstract void	initialise()
SetStore	keySetStore() Accessor for the keys in the Map.
protected abstract MapEntrySetStore	newMapEntrySetStore()
protected abstract MapKeySetStore	newMapKeySetStore()
protected abstract MapValueSetStore	newMapValueSetStore()
java.lang.Object	put(ObjectProvider sm, java.lang.Object newKey, java.lang.Object newValue) Method to put an item in the Map.
java.lang.Object	remove(ObjectProvider sm, java.lang.Object key) Method to remove an item from the map.
protected abstract boolean	updateKeyFkInternal(ObjectProvider sm, java.lang.Object key, java.lang.Object owner)
protected abstract boolean	updateValueFkInternal(ObjectProvider sm, java.lang.Object value, java.lang.Object owner)
protected void	validateValueType(ClassLoaderResolver clr, java.lang.Object value) Utility to validate the type of a value for storing in the Map.
SetStore	valueSetStore() Accessor for the values in the Map.

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

containsKey, containsValue, get, getKeyMapping, getKeyType, getKmd, getMapTable, getValue, getValueMapping, getValueType, getVmd, isValuesAreEmbedded, isValuesAreSerialised, keysAreEmbedded, keysAreSerialised, putAll, updateEmbeddedKey, updateEmbeddedValue, validateKeyForReading, validateKeyForWriting, validateKeyType, validateValueForReading, validateValueForWriting, valuesAreEmbedded, valuesAreSerialised

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

allowsBatching, getDatastoreAdapter, getOwnerMapping, getOwnerMemberMetaData, getRelationType, getStateManagerForEmbeddedPCObject, 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

getStoreManager

Field Detail

clr

protected final ClassLoaderResolver clr

keyFieldNumber

protected int keyFieldNumber

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

Constructor Detail

FKMapStore

public FKMapStore(AbstractMemberMetaData fmd,
                  MappedStoreManager storeMgr,
                  ClassLoaderResolver clr,
                  AbstractMapStoreSpecialization specialization)

Constructor for an Inverse Map.

Parameters:

fmd - Field Meta-Data for the Map field.

storeMgr - The Store Manager we are using.

clr - The ClassLoaderResolver

specialization - The datastore-specific specialization

Method Detail

initialise

protected abstract void initialise()

updateKeyFkInternal

protected abstract boolean updateKeyFkInternal(ObjectProvider sm,
                                               java.lang.Object key,
                                               java.lang.Object owner)

updateValueFkInternal

protected abstract boolean updateValueFkInternal(ObjectProvider sm,
                                                 java.lang.Object value,
                                                 java.lang.Object owner)

newMapKeySetStore

protected abstract MapKeySetStore newMapKeySetStore()

newMapValueSetStore

protected abstract MapValueSetStore newMapValueSetStore()

newMapEntrySetStore

protected abstract MapEntrySetStore newMapEntrySetStore()

validateValueType

protected void validateValueType(ClassLoaderResolver clr,
                                 java.lang.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 java.lang.Object put(ObjectProvider sm,
                            java.lang.Object newKey,
                            java.lang.Object newValue)

Method to put an item in the Map.

Parameters:

sm - State Manager for the map.

newKey - The key to store the value against

newValue - The value to store.

Returns:

The value stored.

remove

public java.lang.Object remove(ObjectProvider sm,
                               java.lang.Object key)

Method to remove an item from the map.

Parameters:

sm - State Manager for the map.

key - Key of the item to remove.

Returns:

The value that was removed.

clear

public void clear(ObjectProvider sm)

Method to clear the map of all values.

Parameters:

sm - State Manager for the map.

clearKeyOfValue

public void clearKeyOfValue(ObjectProvider sm,
                            java.lang.Object key,
                            java.lang.Object oldValue)

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

Parameters:

sm - State Manager for the map.

key - Key of the object

oldValue - Value to remove

keySetStore

public SetStore keySetStore()

Accessor for the keys in the Map.

Returns:

The keys

valueSetStore

public SetStore valueSetStore()

Accessor for the values in the Map.

Returns:

The values.

entrySetStore

public SetStore entrySetStore()

Accessor for the map entries in the Map.

Returns:

The map entries.