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

Class InstanceTotalOrderPredicateImpl

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

All Implemented Interfaces:

InstanceEnumerationPredicate, InstancePredicate, InstanceTotalOrderPredicate, InstanceValueOrderPredicate

public class InstanceTotalOrderPredicateImpl
extends InstanceValueOrderPredicateImpl
implements InstanceTotalOrderPredicate

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

LOG_SUPER_PREDICATE_MUST_BE_DEFINED_IN_INHERITED_PREDICATE

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

Constructor Summary

Constructors

Constructor	Description
InstanceTotalOrderPredicateImpl(StringClassImpl parentClass)	Constructor for InstanceTotalOrderPredicateImpl.

Method Summary

Modifier and Type	Method	Description
void	add(AtomicObject value)	Adds the value at the end of the total order
boolean	contains(AtomicObject value)	Returns true if the order contains the specified value.
AtomicObject	elementAt(int index)	Returns the element at the specified position in this list.
AtomicObject[]	getOrderValues()	getOrderValues.
int	indexOf(AtomicObject value)	Returns the index in this order of the specified value.
void	insertAt(int index, AtomicObject value)	Insert value at at specified index position.
boolean	isAfter(AtomicObject first, AtomicObject last)	isAfter.
boolean	isBefore(AtomicObject first, AtomicObject last)	isBefore.
boolean	isTotalOrderPredicate()	isTotalOrderPredicate.
void	remove(AtomicObject value)	Removes a value from the value order.
int	size()	The number of values in this order.
void	update(AtomicObject oldValue, AtomicObject newValue)	To update a value in the order the oldValue and the newValue must be specified.

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

isTaxonomyOrderPredicate

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

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

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

finishEditing, getAtomicClass, isIntervalPredicate, isOntologyOrderPredicate

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, isInherited, removeValue, setInheritance, updateValue

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

getAtomicClass, holdsFor, isEnumerationPredicate, isIntervalPredicate, isOntologyOrderPredicate, isTaxonomyOrderPredicate

Constructor Details

InstanceTotalOrderPredicateImpl

public InstanceTotalOrderPredicateImpl(StringClassImpl parentClass)

Constructor for InstanceTotalOrderPredicateImpl.

Parameters:

parentClass - a StringClassImpl object

Method Details

add

public void add(AtomicObject value)
         throws ObjectAlreadyExistsException

Adds the value at the end of the total order

Specified by:

add in interface InstanceTotalOrderPredicate

Parameters:

value - a AtomicObject object

Throws:

ObjectAlreadyExistsException - is thrown when the value is already in 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.

elementAt

public AtomicObject elementAt(int index)

Returns the element at the specified position in this list.

Specified by:

elementAt in interface InstanceTotalOrderPredicate

Parameters:

index - index of element to return.

Returns:

the element at the specified position in this list.

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.

indexOf

public int indexOf(AtomicObject value)
            throws ObjectNotFoundException

Returns the index in this order of the specified value. If the order does not contain this value an exception will be thrown.

Specified by:

indexOf in interface InstanceTotalOrderPredicate

Parameters:

value - element to search for.

Returns:

the index in this order of the specified value

Throws:

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

insertAt

public void insertAt(int index,
 AtomicObject value)
              throws ObjectAlreadyExistsException

Insert value at at specified index position. All values up from this are moved one index further.

Specified by:

insertAt in interface InstanceTotalOrderPredicate

Parameters:

index - a int

value - a AtomicObject object

Throws:

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

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.

isTotalOrderPredicate

public boolean isTotalOrderPredicate()

isTotalOrderPredicate.

Specified by:

isTotalOrderPredicate in interface InstancePredicate

Overrides:

isTotalOrderPredicate in class InstanceValueOrderPredicateImpl

Returns:

true if the predicate is an InstanceTotalOrderPredicate

remove

public void remove(AtomicObject value)
            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:

value - a AtomicObject object

Throws:

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

size

public int size()

The number of values in this order.

Specified by:

size in interface InstanceTotalOrderPredicate

Returns:

The number of values in this 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.