org.datanucleus.store.rdbms.scostore

Class FKListStore<E>

java.lang.Object

org.datanucleus.store.rdbms.scostore.BaseContainerStore

org.datanucleus.store.rdbms.scostore.ElementContainerStore

org.datanucleus.store.rdbms.scostore.AbstractCollectionStore<E>

org.datanucleus.store.rdbms.scostore.AbstractListStore<E>

org.datanucleus.store.rdbms.scostore.FKListStore<E>

All Implemented Interfaces:

org.datanucleus.store.scostore.CollectionStore<E>, org.datanucleus.store.scostore.ListStore<E>, org.datanucleus.store.scostore.Store

public class FKListStore<E>
extends AbstractListStore<E>

RDBMS-specific implementation of an ListStore using foreign keys.

Nested Class Summary

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

ElementContainerStore.ElementInfo

Field Summary

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

indexedList, indexOfStmt, lastIndexOfStmt, removeAtStmt, shiftStmt

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

containsStmt

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

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

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

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

Constructor Summary

Constructors

Constructor and Description
FKListStore(org.datanucleus.metadata.AbstractMemberMetaData mmd, RDBMSStoreManager storeMgr, org.datanucleus.ClassLoaderResolver clr)

Method Summary

Modifier and Type	Method and Description
void	clear(org.datanucleus.state.ObjectProvider op) Method to clear the List.
IteratorStatement	getIteratorStatement(org.datanucleus.ClassLoaderResolver clr, org.datanucleus.FetchPlan fp, boolean addRestrictionOnOwner, int startIdx, int endIdx) Method to return the SQLStatement and mapping for an iterator for this backing store.
protected boolean	internalAdd(org.datanucleus.state.ObjectProvider op, int startAt, boolean atEnd, Collection<E> c, int size) Internal method for adding an item to the List.
protected boolean	internalRemove(org.datanucleus.state.ObjectProvider op, Object element, int size) Convenience method to remove the specified element from the List.
protected void	internalRemoveAt(org.datanucleus.state.ObjectProvider op, int index, int size) Internal method to remove an object at a location in the List.
protected ListIterator<E>	listIterator(org.datanucleus.state.ObjectProvider op, int startIdx, int endIdx) Accessor for an iterator through the list elements.
protected void	manageRemovalOfElement(org.datanucleus.state.ObjectProvider ownerOP, Object element) Convenience method to manage the removal of an element from the collection, performing any necessary "managed relationship" updates when the field is bidirectional.
boolean	removeAll(org.datanucleus.state.ObjectProvider op, Collection elements, int size) Remove all elements from a collection from the association owner vs elements.
E	set(org.datanucleus.state.ObjectProvider op, int index, Object element, boolean allowDependentField) Method to set an object in the List at a position.
void	update(org.datanucleus.state.ObjectProvider op, Collection coll) Method to update the collection to be the supplied collection of elements.
protected boolean	validateElementForWriting(org.datanucleus.state.ObjectProvider op, Object element, int index) Method to validate that an element is valid for writing to the datastore.

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

add, add, addAll, addAll, get, getIndexOfStmt, getIndicesOf, getIndicesOfStmt, getLastIndexOfStmt, getRemoveAtStmt, getShiftStmt, indexOf, internalIndexOf, internalRemoveAt, internalShift, iterator, lastIndexOf, listIterator, remove, remove, subList

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

contains, getRemoveStmt, getUpdateEmbeddedElementStmt, updateEmbeddedElement, updateEmbeddedElement

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

getAddStmtForJoinTable, getClearStmt, getContainerTable, getElementInfoForElement, getElementInformationForClass, getElementMapping, getEmd, getRelationDiscriminatorMapping, getRelationDiscriminatorValue, getSize, getSizeStmt, hasOrderMapping, invalidateAddStmt, isElementsAreEmbedded, isElementsAreSerialised, size, usingJoinTable, validateElementForReading, validateElementForWriting, validateElementType

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

contains, hasOrderMapping, size, updateEmbeddedElement

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

getOwnerMemberMetaData, getStoreManager

Constructor Detail

FKListStore

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

Parameters:

mmd - Metadata for owning field/property

storeMgr - Manager for the datastore

clr - ClassLoader resolver

Method Detail

set

public E set(org.datanucleus.state.ObjectProvider op,
             int index,
             Object element,
             boolean allowDependentField)

Method to set an object in the List at a position.

Parameters:

op - ObjectProvider for the owner

index - The item index

element - What to set it to.

allowDependentField - Whether to enable dependent-field deletes during the set

Returns:

The value before setting.

update

public void update(org.datanucleus.state.ObjectProvider op,
                   Collection coll)

Method to update the collection to be the supplied collection of elements.

Specified by:

update in interface org.datanucleus.store.scostore.CollectionStore<E>

Overrides:

update in class AbstractCollectionStore<E>

Parameters:

op - ObjectProvider for the owner

coll - The collection to use

internalAdd

protected boolean internalAdd(org.datanucleus.state.ObjectProvider op,
                              int startAt,
                              boolean atEnd,
                              Collection<E> c,
                              int size)

Internal method for adding an item to the List.

Specified by:

internalAdd in class AbstractListStore<E>

Parameters:

op - ObjectProvider for the owner

startAt - The start position

atEnd - Whether to add at the end

c - The Collection of elements to add.

size - Current size of list (if known). -1 if not known

Returns:

Whether it was successful

removeAll

public boolean removeAll(org.datanucleus.state.ObjectProvider op,
                         Collection elements,
                         int size)

Remove all elements from a collection from the association owner vs elements. TODO : Change the query to do all in one go for efficiency. Currently removes an element and shuffles the indexes, then removes an element and shuffles the indexes, then removes an element and shuffles the indexes etc ... a bit inefficient !!!

Parameters:

op - ObjectProvider for the owner

elements - Collection of elements to remove

Returns:

Whether the database was updated

internalRemove

protected boolean internalRemove(org.datanucleus.state.ObjectProvider op,
                                 Object element,
                                 int size)

Convenience method to remove the specified element from the List.

Specified by:

internalRemove in class AbstractListStore<E>

Parameters:

op - ObjectProvider for the owner

element - The element

size - Current size of list if known. -1 if not known

Returns:

Whether the List was modified

manageRemovalOfElement

protected void manageRemovalOfElement(org.datanucleus.state.ObjectProvider ownerOP,
                                      Object element)

Convenience method to manage the removal of an element from the collection, performing any necessary "managed relationship" updates when the field is bidirectional.

Parameters:

ownerOP - ObjectProvider for the collection owner

element - The element

internalRemoveAt

protected void internalRemoveAt(org.datanucleus.state.ObjectProvider op,
                                int index,
                                int size)

Internal method to remove an object at a location in the List. Differs from the JoinTable List in that it nulls out the owner FK.

Specified by:

internalRemoveAt in class AbstractListStore<E>

Parameters:

op - ObjectProvider for the owner

index - The location

size - Current size of list (if known). -1 if not known

clear

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

Method to clear the List. This is called by the List.clear() method, or when the container object is being deleted and the elements are to be removed (maybe for dependent field), or also when updating a Collection and removing all existing prior to adding all new.

Specified by:

clear in interface org.datanucleus.store.scostore.CollectionStore<E>

Overrides:

clear in class ElementContainerStore

Parameters:

op - ObjectProvider for the owner

validateElementForWriting

protected boolean validateElementForWriting(org.datanucleus.state.ObjectProvider op,
                                            Object element,
                                            int index)

Method to validate that an element is valid for writing to the datastore. TODO Minimise differences to super.validateElementForWriting()

Parameters:

op - ObjectProvider for the List

element - The element to validate

index - The position that the element is being stored at in the list

Returns:

Whether the element was inserted

listIterator

protected ListIterator<E> listIterator(org.datanucleus.state.ObjectProvider op,
                                       int startIdx,
                                       int endIdx)

Accessor for an iterator through the list elements.

Specified by:

listIterator in class AbstractListStore<E>

Parameters:

op - ObjectProvider for the container.

startIdx - The start index in the list (only for indexed lists)

endIdx - The end index in the list (only for indexed lists)

Returns:

The List Iterator

getIteratorStatement

public IteratorStatement getIteratorStatement(org.datanucleus.ClassLoaderResolver clr,
                                              org.datanucleus.FetchPlan fp,
                                              boolean addRestrictionOnOwner,
                                              int startIdx,
                                              int endIdx)

Method to return the SQLStatement and mapping for an iterator for this backing store.

Parameters:

clr - ClassLoader resolver

fp - FetchPlan to use in determing which fields of element to select

addRestrictionOnOwner - Whether to restrict to a particular owner (otherwise functions as bulk fetch for many owners).

startIdx - Start index for the iterator (or -1)

endIdx - End index for the iterator (or -1)

Returns:

The SQLStatement and its associated StatementClassMapping