org.datanucleus.store.rdbms.scostore

Class FKSetStore

java.lang.Object

org.datanucleus.store.rdbms.scostore.BaseContainerStore

org.datanucleus.store.rdbms.scostore.ElementContainerStore

org.datanucleus.store.rdbms.scostore.AbstractCollectionStore

org.datanucleus.store.rdbms.scostore.AbstractSetStore

org.datanucleus.store.rdbms.scostore.FKSetStore

All Implemented Interfaces:

org.datanucleus.store.scostore.CollectionStore, org.datanucleus.store.scostore.SetStore, org.datanucleus.store.scostore.Store

public class FKSetStore
extends AbstractSetStore

RDBMS-specific implementation of an SetStore 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.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, usingDiscriminatorInSizeStmt

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

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

Constructor Summary

Constructors

Constructor and Description
FKSetStore(org.datanucleus.metadata.AbstractMemberMetaData mmd, RDBMSStoreManager storeMgr, org.datanucleus.ClassLoaderResolver clr) Constructor for the backing store of a FK set for RDBMS.

Method Summary

Modifier and Type	Method and Description
boolean	add(org.datanucleus.state.ObjectProvider op, Object element, int size) Method to add an object to the relationship at the collection end.
boolean	addAll(org.datanucleus.state.ObjectProvider op, Collection elements, int size) Method to add a collection of object to the relationship at the collection end.
protected boolean	checkRemovalOfElementShouldDelete(org.datanucleus.state.ObjectProvider op) Convenience method to return if the removal of an element should delete the element.
void	clear(org.datanucleus.state.ObjectProvider op) Method to allow the Set relationship to be cleared out.
protected String	getClearNullifyStmt() Generates the statement for clearing items by nulling the owner link out.
protected int	getFieldNumberInElementForBidirectional(org.datanucleus.state.ObjectProvider op) This seems to return the field number in the element of the relation when it is a bidirectional relation.
IteratorStatement	getIteratorStatement(org.datanucleus.ClassLoaderResolver clr, org.datanucleus.FetchPlan fp, boolean addRestrictionOnOwner) Method to return the SQLStatement and mapping for an iterator for this backing store.
Iterator	iterator(org.datanucleus.state.ObjectProvider op) Accessor for an iterator for the set.
protected void	manageRemovalOfElement(org.datanucleus.state.ObjectProvider op, 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	remove(org.datanucleus.state.ObjectProvider op, Object element, int size, boolean allowDependentField) Method to remove the link to the collection object specified.
boolean	removeAll(org.datanucleus.state.ObjectProvider op, Collection elements, int size) Method to remove the links to a collection of elements specified.
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.AbstractCollectionStore

contains, containsInternal, getRemoveStmt, getUpdateEmbeddedElementStmt, updateEmbeddedElement, updateEmbeddedElement

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

executeClear, getAddStmtForJoinTable, getClearStmt, getContainerTable, getElementInfo, getElementInformationForClass, getElementMapping, getEmd, getOrderMapping, getRelationDiscriminatorMapping, getRelationDiscriminatorValue, getSize, getSizeStmt, hasOrderMapping, invalidateAddStmt, isElementsAreEmbedded, isElementsAreSerialised, size, 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

FKSetStore

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

Constructor for the backing store of a FK set for RDBMS.

Parameters:

mmd - The MetaData for the field that this represents

storeMgr - The StoreManager managing the associated datastore.

clr - The ClassLoaderResolver

Method Detail

getFieldNumberInElementForBidirectional

protected int getFieldNumberInElementForBidirectional(org.datanucleus.state.ObjectProvider op)

This seems to return the field number in the element of the relation when it is a bidirectional relation.

Parameters:

op - ObjectProvider for the owner.

Returns:

The field number in the element for this relation

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

Overrides:

update in class AbstractCollectionStore

Parameters:

op - ObjectProvider for the owner.

coll - The collection to use

add

public boolean add(org.datanucleus.state.ObjectProvider op,
                   Object element,
                   int size)

Method to add an object to the relationship at the collection end.

Parameters:

op - ObjectProvider for the owner.

element - Element to be added

Returns:

Success indicator

addAll

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

Method to add a collection of object to the relationship at the collection end.

Parameters:

op - ObjectProvider for the owner.

elements - Elements to be added

Returns:

Success indicator

remove

public boolean remove(org.datanucleus.state.ObjectProvider op,
                      Object element,
                      int size,
                      boolean allowDependentField)

Method to remove the link to the collection object specified. Depending on the column characteristics in the collection table, the id of the owner field may be NULLed, or the record may be deleted completely (as per cascade-delete in EJB).

Specified by:

remove in interface org.datanucleus.store.scostore.CollectionStore

Overrides:

remove in class AbstractSetStore

Parameters:

op - ObjectProvider for the owner.

element - The element of the collection to be deleted.

allowDependentField - Whether to allow any cascade deletes caused by this removal

size - Current size

Returns:

A success indicator.

removeAll

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

Method to remove the links to a collection of elements specified. Depending on the column characteristics in the collection table, the id of the owner fields may be NULLed, or the records may be deleted completely.

Specified by:

removeAll in interface org.datanucleus.store.scostore.CollectionStore

Overrides:

removeAll in class AbstractSetStore

Parameters:

op - ObjectProvider for the owner.

elements - The elements of the collection to be deleted.

Returns:

A success indicator.

checkRemovalOfElementShouldDelete

protected boolean checkRemovalOfElementShouldDelete(org.datanucleus.state.ObjectProvider op)

Convenience method to return if the removal of an element should delete the element.

Parameters:

op - ObjectProvider for the owner.

Returns:

Whether we should delete the element on removing from the collection

manageRemovalOfElement

protected void manageRemovalOfElement(org.datanucleus.state.ObjectProvider op,
                                      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:

op - ObjectProvider for the owner.

element - The element

clear

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

Method to allow the Set relationship to be cleared out. 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

Overrides:

clear in class ElementContainerStore

Parameters:

op - ObjectProvider for the owner.

getClearNullifyStmt

protected String getClearNullifyStmt()

Generates the statement for clearing items by nulling the owner link out. The statement will be

 UPDATE LISTTABLE SET OWNERCOL=NULL [,DISTINGUISHER=NULL]
 WHERE OWNERCOL=?
 

when there is only one element table, and will be

 UPDATE <TABLE NAME> SET OWNERCOL=NULL [,DISTINGUISHER=NULL]
 WHERE OWNERCOL=?
 

when there is more than 1 element table.

Returns:

The Statement for clearing items for the owner.

iterator

public Iterator iterator(org.datanucleus.state.ObjectProvider op)

Accessor for an iterator for the set.

Specified by:

iterator in interface org.datanucleus.store.scostore.CollectionStore

Specified by:

iterator in class AbstractSetStore

Parameters:

op - ObjectProvider for the owner.

Returns:

Iterator for the set.

getIteratorStatement

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

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

Returns:

The SQLStatement and its associated StatementClassMapping