Package de.uni_trier.wi2.procake.data.model.base

Interface InstanceTaxonomyOrderPredicate

All Superinterfaces:

InstanceEnumerationPredicate, InstancePredicate, InstanceValueOrderPredicate

All Known Implementing Classes:

InstanceTaxonomyOrderPredicateImpl

public interface InstanceTaxonomyOrderPredicate
extends InstanceValueOrderPredicate

A TaxonomyOrder orderes the values of a InstanceEnumerationPredicate in a taxonomy.

Each Taxonomy contains a root node that must be defined first with the method addRelation(AtomicObject, AtomicObject) whereby the first parameter must be null. Any further node can be added with this method.

The values must be defined in the InstanceEnumerationPredicate and are checked during the finishing process of the corresponding AtomicClass.

Author:

Rainer Maximini

See Also:

AtomicClass, InstanceEnumerationPredicate, InstancePredicate

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMPONENT	Component: "cake.data.model" (LogComponentIdentifier.COMPONENT)
static String	COMPONENT_KEY	Component-Key (ValueOrder): "03" (LogComponentIdentifier.COMPONENT_KEY_VALUEORDER)
static String	LOG_CHILD_ALREADY_EXISTS	The specified value is already the child of an other value.
static String	LOG_CHILD_NOT_FOUND	The specified child could not be found.
static String	LOG_ROOT_ALREADY_DEFINED	The order already has a root-node.

Fields inherited from interface de.uni_trier.wi2.procake.data.model.base.InstanceValueOrderPredicate

LOG_VALUE_ALREADY_DEFINED, LOG_VALUE_NOT_FOUND, LOG_VALUE_UPDATE_FAILED

Method Summary

Modifier and Type	Method	Description
void	addRelation(AtomicObject father, AtomicObject son)	To add a relation to the taxonomy the father and the son must be specified.
AtomicObject[]	getAllSons(AtomicObject father)	Returns all sons of the given father.
AtomicObject	getCommonFather(AtomicObject[] sons)	Determines the common father of all given sons.
AtomicObject	getCommonFather(AtomicObject firstSon, AtomicObject secondSon)	Determines the common father of firstSon and secondSon.
AtomicObject	getFather(AtomicObject son)	getFather.
AtomicObject	getRoot()	getRoot.
AtomicObject[]	getSons(AtomicObject father)	Returns all direct sons of the given father.
boolean	isChild(AtomicObject child, AtomicObject father)	true if child is a sub node of father.
void	updateRelation(AtomicObject oldFather, AtomicObject newFather, AtomicObject son)	To move a son node with all sub nodes to another father this method can be used.

Methods inherited from interface de.uni_trier.wi2.procake.data.model.base.InstanceEnumerationPredicate

addValue, getValues, hasValueOrder, removeValue, updateValue

Methods inherited from interface de.uni_trier.wi2.procake.data.model.base.InstancePredicate

getAtomicClass, holdsFor, isEnumerationPredicate, isIntervalPredicate, isTaxonomyOrderPredicate, isTotalOrderPredicate

Methods inherited from interface de.uni_trier.wi2.procake.data.model.base.InstanceValueOrderPredicate

contains, getOrderValues, isAfter, isBefore, remove, update

Field Detail

COMPONENT

static final String COMPONENT

Component: "cake.data.model" (LogComponentIdentifier.COMPONENT)

See Also:

Constant Field Values

COMPONENT_KEY

static final String COMPONENT_KEY

Component-Key (ValueOrder): "03" (LogComponentIdentifier.COMPONENT_KEY_VALUEORDER)

See Also:

Constant Field Values

LOG_CHILD_ALREADY_EXISTS

static final String LOG_CHILD_ALREADY_EXISTS

The specified value is already the child of an other value.

0. Component: COMPONENT
1. Key: "0321"
2. this
3. Present Father AtomicObject
4. Value AtomicObject

See Also:

Constant Field Values

LOG_CHILD_NOT_FOUND

static final String LOG_CHILD_NOT_FOUND

The specified child could not be found.

0. Component: COMPONENT
1. Key: "0320"
2. this
3. Childname

See Also:

Constant Field Values

LOG_ROOT_ALREADY_DEFINED

static final String LOG_ROOT_ALREADY_DEFINED

The order already has a root-node.

0. Component: COMPONENT
1. Key: "0322"
2. this
3. Current root-node AtomicObject

See Also:

Constant Field Values

Method Detail

addRelation

void addRelation(AtomicObject father,
                 AtomicObject son)
          throws IllegalEditException,
                 ObjectAlreadyExistsException,
                 ObjectNotFoundException

To add a relation to the taxonomy the father and the son must be specified. If father=null root node of the taxonomy is defined with son as root. Only one root can be defined why this method throws an IllegalEditException if a root is already defined. To update the root node the old root must be removed remove(getRoot()) first.

The relation is only be added if the father is already included in the taxonomy and the son is not included. To change a relation, the updateRelation(AtomicObject, AtomicObject, AtomicObject) method should be used.

Parameters:

father - the value of the father node

son - the value of the son node

Throws:

IllegalEditException

ObjectAlreadyExistsException - Is thrown when the son is already in the order.

ObjectNotFoundException - Is thrown when the father is not an element of the order.

getCommonFather

AtomicObject getCommonFather(AtomicObject firstSon,
                             AtomicObject secondSon)
                      throws ObjectNotFoundException

Determines the common father of firstSon and secondSon.

Parameters:

firstSon - a AtomicObject object

secondSon - a AtomicObject object

Returns:

Returns the common father of son firstSon and secondSon.

Throws:

ObjectNotFoundException - Is thrown when the firstSon or the secondSon are not an element of the order.

getCommonFather

AtomicObject getCommonFather(AtomicObject[] sons)
                      throws ObjectNotFoundException

Determines the common father of all given sons.

Parameters:

sons - The sons whose common father should be returned.

Returns:

The common father of all sons.

Throws:

ObjectNotFoundException - Is thrown when one of the sons are not an element of the order.

getFather

AtomicObject getFather(AtomicObject son)
                throws ObjectNotFoundException

getFather.

Parameters:

son - The son whose father should be returned.

Returns:

Returns the father value of the son or null if the son is root node ( getRoot()) and no father exists.

Throws:

ObjectNotFoundException - Is thrown when the son is not an element of the order.

getRoot

AtomicObject getRoot()

getRoot.

Returns:

The root value of the taxonomy or null if no root is defined.

getSons

AtomicObject[] getSons(AtomicObject father)
                throws ObjectNotFoundException

Returns all direct sons of the given father. If the taxonomy does not contains father or father == null a ObjectNotFoundException will be thrown.

Parameters:

father - The father whose sons should be returned.

Returns:

All child values of the given father. The result is never be null.

Throws:

ObjectNotFoundException - Is thrown when the father is not an element of the order.

getAllSons

AtomicObject[] getAllSons(AtomicObject father)
                   throws ObjectNotFoundException

Returns all sons of the given father. If the taxonomy does not contains father or father == null a ObjectNotFoundException will be thrown.

Parameters:

father - The father whose sons should be returned.

Returns:

All child values of the given father. The result is never be null.

Throws:

ObjectNotFoundException - Is thrown when the father is not an element of the order.

isChild

boolean isChild(AtomicObject child,
                AtomicObject father)
         throws ObjectNotFoundException

true if child is a sub node of father. If the child or father is null or not defined the exception ObjectNotFoundException is thrown.

Parameters:

child - a AtomicObject object

father - a AtomicObject object

Returns:

true if the child is a sub node of the father.

Throws:

ObjectNotFoundException - Is thrown when the child or the father are not an element of the order.

updateRelation

void updateRelation(AtomicObject oldFather,
                    AtomicObject newFather,
                    AtomicObject son)
             throws ObjectNotFoundException

To move a son node with all sub nodes to another father this method can be used.

Parameters:

oldFather - The value of the old father that must exist.

newFather - The value of the new father that must exist.

son - The value of the son that must exist as son of the old father.

Throws:

ObjectNotFoundException - Is thrown when the oldFather, the newFather, ot son are not an element of the order.