org.datanucleus.store.rdbms.scostore

Class JoinListStore<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.JoinListStore<E>

All Implemented Interfaces:

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

public class JoinListStore<E>
extends AbstractListStore<E>

RDBMS-specific implementation of a ListStore using join table.

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
JoinListStore(org.datanucleus.metadata.AbstractMemberMetaData mmd, CollectionTable joinTable, org.datanucleus.ClassLoaderResolver clr) Constructor for a join list store for RDBMS.

Method Summary

Modifier and Type	Method and Description
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 String	getRemoveAllStmt(Collection elements) Generate statement for removing a collection of items from the List.
protected String	getSetStmt() Generates the statement for setting an item.
protected boolean	internalAdd(org.datanucleus.state.ObjectProvider op, int start, boolean atEnd, Collection<E> c, int size) Internal method to add element(s) to the List.
protected boolean	internalRemove(org.datanucleus.state.ObjectProvider ownerOP, 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) Method to remove an element from the specified position
protected ListIterator<E>	listIterator(org.datanucleus.state.ObjectProvider op, int startIdx, int endIdx) Accessor for an iterator through the list elements.
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.
void	update(org.datanucleus.state.ObjectProvider op, Collection coll) Method to update the collection to be the supplied collection of elements.

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

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

clear, contains, hasOrderMapping, size, updateEmbeddedElement

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

getOwnerMemberMetaData, getStoreManager

Constructor Detail

JoinListStore

public JoinListStore(org.datanucleus.metadata.AbstractMemberMetaData mmd,
                     CollectionTable joinTable,
                     org.datanucleus.ClassLoaderResolver clr)

Constructor for a join list store for RDBMS.

Parameters:

mmd - Metadata for the member that has the list with join table

joinTable - The Join table

clr - ClassLoader resolver

Method Detail

internalAdd

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

Internal method to add element(s) to the List. Performs the add in 2 steps.

1. Shift all existing elements into their new positions so we can insert.
2. Insert all new elements directly at their desired positions

Both steps can be batched (separately).

Specified by:

internalAdd in class AbstractListStore<E>

Parameters:

op - The ObjectProvider

start - The start location (if required)

atEnd - Whether to add the element at the end

c - The collection of objects to add.

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

Returns:

Whether it was successful

set

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

Method to set an object in the List.

Parameters:

op - ObjectProvider for the owner

index - The item index

element - What to set it to.

allowDependentField - Whether to allow dependent field deletes

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 of the object

coll - The collection to use

internalRemove

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

Convenience method to remove the specified element from the List.

Specified by:

internalRemove in class AbstractListStore<E>

Parameters:

element - The element

ownerOP - ObjectProvider of the owner

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

Returns:

Whether the List was modified

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. Performs the removal in 3 steps. The first gets the indices that will be removed (and the highest index present). The second step removes these elements from the list. The third step updates the indices of the remaining indices to fill the holes created.

Parameters:

op - ObjectProvider

elements - Collection of elements to remove

Returns:

Whether the database was updated

internalRemoveAt

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

Method to remove an element from the specified position

Specified by:

internalRemoveAt in class AbstractListStore<E>

Parameters:

op - The ObjectProvider for the list

index - The index of the element

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

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 owner

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

endIdx - End index in the list (only for indexed lists).

Returns:

The List Iterator

getSetStmt

protected String getSetStmt()

Generates the statement for setting an item.

 UPDATE LISTTABLE SET [ELEMENTCOL = ?]
 [EMBEDDEDFIELD1=?, EMBEDDEDFIELD2=?, ...]
 WHERE OWNERCOL = ?
 AND INDEXCOL = ?
 [AND DISTINGUISHER=?]
 

Returns:

The Statement for setting an item

getRemoveAllStmt

protected String getRemoveAllStmt(Collection elements)

Generate statement for removing a collection of items from the List.

 DELETE FROM LISTTABLE
 WHERE (OWNERCOL=? AND ELEMENTCOL=?) OR
 (OWNERCOL=? AND ELEMENTCOL=?) OR
 (OWNERCOL=? AND ELEMENTCOL=?)
 

Parameters:

elements - Collection of elements to remove

Returns:

Statement for deleting items from the List.

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