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

Class InstanceTaxonomyOrderPredicateImpl

java.lang.Object

de.uni_trier.wi2.procake.data.model.base.impl.InstancePredicateImpl

de.uni_trier.wi2.procake.data.model.base.impl.InstanceEnumerationPredicateImpl

de.uni_trier.wi2.procake.data.model.base.impl.InstanceValueOrderPredicateImpl

de.uni_trier.wi2.procake.data.model.base.impl.InstanceTaxonomyOrderPredicateImpl

All Implemented Interfaces:

InstanceEnumerationPredicate, InstancePredicate, InstanceTaxonomyOrderPredicate, InstanceValueOrderPredicate

public class InstanceTaxonomyOrderPredicateImpl
extends InstanceValueOrderPredicateImpl
implements InstanceTaxonomyOrderPredicate

Description is missing

Author:

Rainer Maximini

Field Summary

Fields inherited from class de.uni_trier.wi2.procake.data.model.base.impl.InstancePredicateImpl

atomicClass

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

COMPONENT, COMPONENT_KEY, LOG_CHILD_ALREADY_EXISTS, LOG_CHILD_NOT_FOUND, LOG_ROOT_ALREADY_DEFINED

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

COMPONENT, COMPONENT_KEY, LOG_VALUE_ALREADY_DEFINED, LOG_VALUE_NOT_FOUND, LOG_VALUE_UPDATE_FAILED

Constructor Summary

Constructors

Constructor	Description
InstanceTaxonomyOrderPredicateImpl(StringClassImpl parentClass)	Constructor for InstanceTaxonomyOrderPredicateImpl.

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.
boolean	contains(AtomicObject value)	Returns true if the order contains the specified value.
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[]	getOrderValues()	getOrderValues.
AtomicObject	getRoot()	getRoot.
AtomicObject[]	getSons(AtomicObject father)	Returns all direct sons of the given father.
boolean	isAfter(AtomicObject first, AtomicObject last)	isAfter.
boolean	isBefore(AtomicObject first, AtomicObject last)	isBefore.
boolean	isChild(AtomicObject child, AtomicObject father)	true if child is a sub node of father.
boolean	isTaxonomyOrderPredicate()	isTaxonomyOrderPredicate.
void	remove(AtomicObject son)	Removes a value from the value order.
void	update(AtomicObject oldValue, AtomicObject newValue)	To update a value in the order the oldValue and the newValue must be specified.
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 class de.uni_trier.wi2.procake.data.model.base.impl.InstanceValueOrderPredicateImpl

isTotalOrderPredicate

Methods inherited from class de.uni_trier.wi2.procake.data.model.base.impl.InstanceEnumerationPredicateImpl

addValue, checkFinishEditing, getValues, hasValueOrder, holdsFor, isEnumerationPredicate, removeValue, updateValue

Methods inherited from class de.uni_trier.wi2.procake.data.model.base.impl.InstancePredicateImpl

finishEditing, getAtomicClass, isIntervalPredicate

Methods inherited from class java.lang.Object

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

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

Constructor Detail

InstanceTaxonomyOrderPredicateImpl

public InstanceTaxonomyOrderPredicateImpl(StringClassImpl parentClass)

Constructor for InstanceTaxonomyOrderPredicateImpl.

Parameters:

parentClass - a StringClassImpl object

Method Detail

addRelation

public 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 InstanceTaxonomyOrderPredicate.updateRelation(AtomicObject, AtomicObject, AtomicObject) method should be used.

Specified by:

addRelation in interface InstanceTaxonomyOrderPredicate

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.

contains

public boolean contains(AtomicObject value)

Returns true if the order contains the specified value.

Specified by:

contains in interface InstanceValueOrderPredicate

Parameters:

value - value whose presence in this order is to be tested.

Returns:

true if this order contains the specified element.

getCommonFather

public AtomicObject getCommonFather(AtomicObject firstSon,
                                    AtomicObject secondSon)
                             throws ObjectNotFoundException

Determines the common father of firstSon and secondSon.

Specified by:

getCommonFather in interface InstanceTaxonomyOrderPredicate

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

public AtomicObject getCommonFather(AtomicObject[] sons)
                             throws ObjectNotFoundException

Determines the common father of all given sons.

Specified by:

getCommonFather in interface InstanceTaxonomyOrderPredicate

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

public AtomicObject getFather(AtomicObject son)
                       throws ObjectNotFoundException

getFather.

Specified by:

getFather in interface InstanceTaxonomyOrderPredicate

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 ( InstanceTaxonomyOrderPredicate.getRoot()) and no father exists.

Throws:

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

getRoot

public AtomicObject getRoot()

getRoot.

Specified by:

getRoot in interface InstanceTaxonomyOrderPredicate

Returns:

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

getSons

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

Specified by:

getSons in interface InstanceTaxonomyOrderPredicate

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.

getOrderValues

public AtomicObject[] getOrderValues()

getOrderValues.

Specified by:

getOrderValues in interface InstanceValueOrderPredicate

Returns:

an array of all values in the order, the array is never be null.

isAfter

public boolean isAfter(AtomicObject first,
                       AtomicObject last)
                throws ObjectNotFoundException

isAfter.

Specified by:

isAfter in interface InstanceValueOrderPredicate

Parameters:

first - a AtomicObject object

last - a AtomicObject object

Returns:

true if first is after last, otherwise false

Throws:

ObjectNotFoundException - Is thrown when the first or last value is not an element of the order.

isBefore

public boolean isBefore(AtomicObject first,
                        AtomicObject last)
                 throws ObjectNotFoundException

isBefore.

Specified by:

isBefore in interface InstanceValueOrderPredicate

Parameters:

first - a AtomicObject object

last - a AtomicObject object

Returns:

true if first is before last, otherwise false

Throws:

ObjectNotFoundException - Is thrown when the first or last value is not an element of the order.

isChild

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

Specified by:

isChild in interface InstanceTaxonomyOrderPredicate

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.

isTaxonomyOrderPredicate

public boolean isTaxonomyOrderPredicate()

isTaxonomyOrderPredicate.

Specified by:

isTaxonomyOrderPredicate in interface InstancePredicate

Overrides:

isTaxonomyOrderPredicate in class InstanceValueOrderPredicateImpl

Returns:

true if the order is a taxonomy

See Also:

InstanceTaxonomyOrderPredicate

remove

public void remove(AtomicObject son)
            throws ObjectNotFoundException

Removes a value from the value order. If value == null nothing happens. If the value order does not cotain the value a ObjectNotFoundException will be thrown.

Specified by:

remove in interface InstanceValueOrderPredicate

Parameters:

son - a AtomicObject object

Throws:

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

update

public void update(AtomicObject oldValue,
                   AtomicObject newValue)
            throws ObjectNotFoundException,
                   ObjectAlreadyExistsException

To update a value in the order the oldValue and the newValue must be specified. The newValue is only be applied if and only if the order contains the oldValue and the order not contains the newValue.

Specified by:

update in interface InstanceValueOrderPredicate

Parameters:

oldValue - a AtomicObject object

newValue - a AtomicObject object

Throws:

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

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

updateRelation

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

Specified by:

updateRelation in interface InstanceTaxonomyOrderPredicate

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.

getAllSons

public AtomicObject[] getAllSons(AtomicObject father)

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

Specified by:

getAllSons in interface InstanceTaxonomyOrderPredicate

Parameters:

father - The father whose sons should be returned.

Returns:

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