li.strolch.agent.impl

Class TransactionalElementMap<T extends StrolchRootElement>

java.lang.Object

li.strolch.agent.impl.TransactionalElementMap<T>

Type Parameters:

T -

All Implemented Interfaces:

ElementMap<T>

Direct Known Subclasses:

TransactionalActivityMap, TransactionalOrderMap, TransactionalResourceMap

public abstract class TransactionalElementMap<T extends StrolchRootElement>
extends Object
implements ElementMap<T>

Author:

Robert von Burg

Constructor Summary

Constructors

Constructor and Description
TransactionalElementMap(StrolchRealm realm)

Method Summary

Modifier and Type	Method and Description
void	add(StrolchTransaction tx, T element) Adds the given element to the underlying persistence layer.
void	addAll(StrolchTransaction tx, List<T> elements) Adds the given elements to the underlying persistence layer.
protected abstract void	assertIsRefParam(Parameter<?> refP)
List<T>	getAllElements(StrolchTransaction tx) Returns all elements in the underlying persistence layer regardless of type
Set<String>	getAllKeys(StrolchTransaction tx) Returns all keys/IDs of all elements in the underlying persistence layer, regardless of type
List<T>	getBy(StrolchTransaction tx, StringListParameter refP, boolean assertExists) Returns all elements which are referenced by the given StringListParameter.
T	getBy(StrolchTransaction tx, StringParameter refP, boolean assertExists) Returns the element which is referenced by the given StringParameter.
T	getBy(StrolchTransaction tx, String type, String id) Retrieves the element with the given type and id, or null if it does not exist
T	getBy(StrolchTransaction tx, String type, String id, boolean assertExists) Retrieves the element with the given type and id, or null if it does not exist
T	getBy(StrolchTransaction tx, String type, String id, int version) Retrieves the specific version of the element with the given type and id, or null if it does not exist
T	getBy(StrolchTransaction tx, String type, String id, int version, boolean assertExists) Retrieves the specific version of the element with the given type and id, or null if it does not exist
protected abstract StrolchDao<T>	getDao(StrolchTransaction tx)
List<T>	getElementsBy(StrolchTransaction tx, String type) Returns all elements in the underlying persistence layer of the given type
Set<String>	getKeysBy(StrolchTransaction tx, String type) Returns all keys/IDs of all elements in the underlying persistence layer, of the given type
protected StrolchRealm	getRealm()
T	getTemplate(StrolchTransaction tx, String type) Returns a copy of the element with the type "Template" and the id = type
T	getTemplate(StrolchTransaction tx, String type, boolean assertExists) Returns a copy of the element with the type "Template" and the id = type
Set<String>	getTypes(StrolchTransaction tx) Returns all the types known in the underlying persistence layer
List<T>	getVersionsFor(StrolchTransaction tx, String type, String id) Queries and returns all the versions of the element with the given type and ID
boolean	hasElement(StrolchTransaction tx, String type, String id) Returns true if the underlying persistence layer has an element with the given type and ID
boolean	hasType(StrolchTransaction tx, String type) Returns true if the underlying persistence layer has elements with the given type
long	querySize(StrolchTransaction tx) Returns the number of elements regardless of type in the underlying persistence layer
long	querySize(StrolchTransaction tx, String type) Returns the number of elements of the given type in the underlying persistence layer
void	remove(StrolchTransaction tx, T element) Removes the given element
long	removeAll(StrolchTransaction tx) Removes all elements regardless of the type
void	removeAll(StrolchTransaction tx, List<T> elements) Removes the given elements
long	removeAllBy(StrolchTransaction tx, String type) Removes all elements of the given type
T	revertToVersion(StrolchTransaction tx, String type, String id, int version) Reverts to the given version of the specified element.
T	revertToVersion(StrolchTransaction tx, T element) Reverts to the given version of the specified element.
void	undoVersion(StrolchTransaction tx, T element) Undoes the given version by reverting to the previous version of the element given.
void	update(StrolchTransaction tx, T element) Updates the existing element
void	updateAll(StrolchTransaction tx, List<T> elements) Updates all the existing elements

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransactionalElementMap

public TransactionalElementMap(StrolchRealm realm)

Method Detail

getRealm

protected StrolchRealm getRealm()

getDao

protected abstract StrolchDao<T> getDao(StrolchTransaction tx)

hasType

public boolean hasType(StrolchTransaction tx,
                       String type)

Description copied from interface: ElementMap

Returns true if the underlying persistence layer has elements with the given type

Specified by:

hasType in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the open StrolchTransaction

type - the type of element to check for

Returns:

true if the underlying persistence layer has elements with the given type

hasElement

public boolean hasElement(StrolchTransaction tx,
                          String type,
                          String id)

Description copied from interface: ElementMap

Returns true if the underlying persistence layer has an element with the given type and ID

Specified by:

hasElement in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the open StrolchTransaction

type - the type of element to check for

id - the ID of the element to check for

Returns:

true if the underlying persistence layer has an element with the given type and ID

querySize

public long querySize(StrolchTransaction tx)

Description copied from interface: ElementMap

Returns the number of elements regardless of type in the underlying persistence layer

Specified by:

querySize in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the open StrolchTransaction

Returns:

the number of elements regardless of type in the underlying persistence layer

querySize

public long querySize(StrolchTransaction tx,
                      String type)

Description copied from interface: ElementMap

Returns the number of elements of the given type in the underlying persistence layer

Specified by:

querySize in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the open StrolchTransaction

type - the type of element for which the number of elements is to be queried

Returns:

the number of elements of the given type in the underlying persistence layer

getTemplate

public T getTemplate(StrolchTransaction tx,
                     String type)

Description copied from interface: ElementMap

Returns a copy of the element with the type "Template" and the id = type

Specified by:

getTemplate in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the open StrolchTransaction

type - The template id to return

Returns:

the template, or null if it does not exist

getTemplate

public T getTemplate(StrolchTransaction tx,
                     String type,
                     boolean assertExists)
              throws StrolchException

Description copied from interface: ElementMap

Returns a copy of the element with the type "Template" and the id = type

Specified by:

getTemplate in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the open StrolchTransaction

type - The template id to return

assertExists - if true, and element does not exist, then a StrolchException is thrown

Returns:

the template, or null if it does not exist

Throws:

StrolchException - if the template does not exist

getBy

public T getBy(StrolchTransaction tx,
               String type,
               String id)

Description copied from interface: ElementMap

Retrieves the element with the given type and id, or null if it does not exist

Specified by:

getBy in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the open transaction

type - the type of the element to retrieve

id - the id of the element to retrieve

Returns:

the element with the type and id, or null if it does not exist

getBy

public T getBy(StrolchTransaction tx,
               String type,
               String id,
               boolean assertExists)
        throws StrolchException

Description copied from interface: ElementMap

Retrieves the element with the given type and id, or null if it does not exist

Specified by:

getBy in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the open transaction

type - the type of the element to retrieve

id - the id of the element to retrieve

assertExists - if true, and element does not exist, then a StrolchException is thrown

Returns:

the element with the type and id, or null if it does not exist

Throws:

StrolchException - if the element does not exist

getBy

public T getBy(StrolchTransaction tx,
               String type,
               String id,
               int version)

Description copied from interface: ElementMap

Retrieves the specific version of the element with the given type and id, or null if it does not exist

Specified by:

getBy in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the open transaction

type - the type of the element to retrieve

id - the id of the element to retrieve

version - the version to get

Returns:

the element with the type and id, or null if it does not exist

getBy

public T getBy(StrolchTransaction tx,
               String type,
               String id,
               int version,
               boolean assertExists)
        throws StrolchException

Description copied from interface: ElementMap

Retrieves the specific version of the element with the given type and id, or null if it does not exist

Specified by:

getBy in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the open transaction

type - the type of the element to retrieve

id - the id of the element to retrieve

version - the version to get

assertExists - if true, and element does not exist, then a StrolchException is thrown

Returns:

the element with the type and id, or null if it does not exist

Throws:

StrolchException - if the element does not exist

getBy

public T getBy(StrolchTransaction tx,
               StringParameter refP,
               boolean assertExists)
        throws StrolchException

Description copied from interface: ElementMap

Returns the element which is referenced by the given StringParameter. A reference Parameter must have its interpretation set to the element type being referenced e.g. s StrolchConstants.INTERPRETATION_ORDER_REF and the UOM must be set to the element's type and the value is the id of the element

Specified by:

getBy in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the StrolchTransaction instance

refP - the StringParameter which references an element

assertExists - if true, and element does not exist, then a StrolchException is thrown

Returns:

the element found, or null if it does not exist

Throws:

StrolchException - if the StringParameter is not a properly configured as a reference parameter

getBy

public List<T> getBy(StrolchTransaction tx,
                     StringListParameter refP,
                     boolean assertExists)
              throws StrolchException

Description copied from interface: ElementMap

Returns all elements which are referenced by the given StringListParameter. A reference Parameter must have its interpretation set to the element type being referenced e.g. s StrolchConstants.INTERPRETATION_ORDER_REF and the UOM must be set to the element's type and the value is the id of the element

Specified by:

getBy in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the StrolchTransaction instance

refP - the StringListParameter which references an element

assertExists - if true, and element does not exist, then a StrolchException is thrown

Returns:

the list of elements found, or the empty list if they do not exist. Note: Any missing elements are not returned!

Throws:

StrolchException - if the StringParameter is not a properly configured as a reference parameter

getVersionsFor

public List<T> getVersionsFor(StrolchTransaction tx,
                              String type,
                              String id)

Description copied from interface: ElementMap

Queries and returns all the versions of the element with the given type and ID

Specified by:

getVersionsFor in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the StrolchTransaction instance

type - the type of the element to be queried

id - the id of the element to be queried

Returns:

all the versions of the element with the given type and ID

getAllElements

public List<T> getAllElements(StrolchTransaction tx)

Description copied from interface: ElementMap

Returns all elements in the underlying persistence layer regardless of type

Specified by:

getAllElements in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the StrolchTransaction instance

Returns:

all elements in the underlying persistence layer regardless of type

getElementsBy

public List<T> getElementsBy(StrolchTransaction tx,
                             String type)

Description copied from interface: ElementMap

Returns all elements in the underlying persistence layer of the given type

Specified by:

getElementsBy in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the StrolchTransaction instance

type - the type of the elements to retrieve

Returns:

all elements in the underlying persistence layer of the given type

getTypes

public Set<String> getTypes(StrolchTransaction tx)

Description copied from interface: ElementMap

Returns all the types known in the underlying persistence layer

Specified by:

getTypes in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the StrolchTransaction instance

Returns:

all the types known in the underlying persistence layer

getAllKeys

public Set<String> getAllKeys(StrolchTransaction tx)

Description copied from interface: ElementMap

Returns all keys/IDs of all elements in the underlying persistence layer, regardless of type

Specified by:

getAllKeys in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the StrolchTransaction instance

Returns:

all keys/IDs of all elements in the underlying persistence layer, regardless of type

getKeysBy

public Set<String> getKeysBy(StrolchTransaction tx,
                             String type)

Description copied from interface: ElementMap

Returns all keys/IDs of all elements in the underlying persistence layer, of the given type

Specified by:

getKeysBy in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the StrolchTransaction instance

type - the type of the element to retrieve the keys for

Returns:

all keys/IDs of all elements in the underlying persistence layer, of the given type

add

public void add(StrolchTransaction tx,
                T element)

Description copied from interface: ElementMap

Adds the given element to the underlying persistence layer. The element may not already exist

Specified by:

add in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the StrolchTransaction instance

element - the element to add

addAll

public void addAll(StrolchTransaction tx,
                   List<T> elements)

Description copied from interface: ElementMap

Adds the given elements to the underlying persistence layer. None of the elements may already exist

Specified by:

addAll in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the StrolchTransaction instance

elements - the elements to add

update

public void update(StrolchTransaction tx,
                   T element)

Description copied from interface: ElementMap

Updates the existing element

Specified by:

update in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the StrolchTransaction instance

element - the element to update

updateAll

public void updateAll(StrolchTransaction tx,
                      List<T> elements)

Description copied from interface: ElementMap

Updates all the existing elements

Specified by:

updateAll in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the StrolchTransaction instance

elements - the elements to update

remove

public void remove(StrolchTransaction tx,
                   T element)

Description copied from interface: ElementMap

Removes the given element

Specified by:

remove in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the StrolchTransaction instance

element - the element to be removed

removeAll

public void removeAll(StrolchTransaction tx,
                      List<T> elements)

Description copied from interface: ElementMap

Removes the given elements

Specified by:

removeAll in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the StrolchTransaction instance

elements - the elements to be removed

removeAll

public long removeAll(StrolchTransaction tx)

Description copied from interface: ElementMap

Removes all elements regardless of the type

Note: This method ignores versioning. Do NOT call this method unless you want to clear the model!

Specified by:

removeAll in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the StrolchTransaction instance

Returns:

the number of elements removed

removeAllBy

public long removeAllBy(StrolchTransaction tx,
                        String type)

Description copied from interface: ElementMap

Removes all elements of the given type

Note: This method ignores versioning. Do NOT call this method unless you want to clear the model!

Specified by:

removeAllBy in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the StrolchTransaction instance

type - the type of elements to remove

Returns:

the number of elements removed

revertToVersion

public T revertToVersion(StrolchTransaction tx,
                         T element)
                  throws StrolchException

Description copied from interface: ElementMap

Reverts to the given version of the specified element. This method will retrieve the given version of the specified element, then set a new version on that element which is an increment of the current latest version and store this new version. The new element is then returned for convenience.

Note: This is the method which should be called when a change should be reverted. This method gurantees that the history is not changed and that a new version is saved but with the version of the element specified.

Specified by:

revertToVersion in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the StrolchTransaction instance

element - the version of the element to revert to

Returns:

the new version of the element

Throws:

StrolchException - if the version does not exist

revertToVersion

public T revertToVersion(StrolchTransaction tx,
                         String type,
                         String id,
                         int version)
                  throws StrolchException

Description copied from interface: ElementMap

Reverts to the given version of the specified element. This method will retrieve the given version of the specified element, then set a new version on that element which is an increment of the current latest version and store this new version. The new element is then returned for convenience.

Note: This is the method which should be called when a change should be reverted. This method gurantees that the history is not changed and that a new version is saved but with the version of the element specified.

Specified by:

revertToVersion in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the StrolchTransaction instance

type - the type of the element to revert to

id - the id of the element to revert to

version - the version of the specified element to revert to

Returns:

the new version of the element

Throws:

StrolchException - if the version does not exist

undoVersion

public void undoVersion(StrolchTransaction tx,
                        T element)
                 throws StrolchException

Description copied from interface: ElementMap

Undoes the given version by reverting to the previous version of the element given. If the element given is the first version, then the element is removed. If the previous version exists, then it is reverted to it. If the given element does not exist, nor it's previous version, then a StrolchPersistenceException is thrown

Note: This method should only be used in the same transaction where the element was created to undo a change in the same transaction. If there is a requirement to revert to a previous version, then the ElementMap.revertToVersion(StrolchTransaction, StrolchRootElement) method.

Specified by:

undoVersion in interface ElementMap<T extends StrolchRootElement>

Parameters:

tx - the StrolchTransaction instance

element - the element which is to be reverted to a previous version

Throws:

StrolchException - if the version does not exist, if this version is not the latest version, if the previous version is missing or other problems arise

assertIsRefParam

protected abstract void assertIsRefParam(Parameter<?> refP)