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

Interface InstanceValueOrderPredicate

All Superinterfaces:

InstanceEnumerationPredicate, InstancePredicate

All Known Subinterfaces:

InstanceTaxonomyOrderPredicate, InstanceTotalOrderPredicate

All Known Implementing Classes:

InstanceTaxonomyOrderPredicateImpl, InstanceTotalOrderPredicateImpl, InstanceValueOrderPredicateImpl

public interface InstanceValueOrderPredicate
extends InstanceEnumerationPredicate

A value order is used in an InstanceEnumerationPredicate to define an order for the values of the predicate.

This interface is extended by and InstanceTaxonomyOrderPredicate and InstanceTotalOrderPredicate.

Version:

$Revision: 1.1 $

Author:

Rainer Maximini

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMPONENT	Component: "cake.data.model" (LogComponentIdentifier.COMPONENT
static String	COMPONENT_KEY	Component-Key: "03" (LogComponentIdentifier.COMPONENT_KEY_VALUEORDER)
static String	LOG_VALUE_ALREADY_DEFINED	The specified value is already defined.
static String	LOG_VALUE_NOT_FOUND	The value could not be found.
static String	LOG_VALUE_UPDATE_FAILED	Could not update value - value is already defined.

Method Summary

Modifier and Type	Method	Description
boolean	contains(AtomicObject value)	Returns true if the order contains the specified value.
AtomicObject[]	getOrderValues()	getOrderValues.
boolean	isAfter(AtomicObject first, AtomicObject last)	isAfter.
boolean	isBefore(AtomicObject first, AtomicObject last)	isBefore.
void	remove(AtomicObject value)	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.

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

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: "03" (LogComponentIdentifier.COMPONENT_KEY_VALUEORDER)

See Also:

Constant Field Values

LOG_VALUE_ALREADY_DEFINED

static final String LOG_VALUE_ALREADY_DEFINED

The specified value is already defined.

0. Component: COMPONENT
1. Key: "0303"
2. this

See Also:

Constant Field Values

LOG_VALUE_NOT_FOUND

static final String LOG_VALUE_NOT_FOUND

The value could not be found.

0. Component: COMPONENT
1. Key: "0301"
2. this
3. Value: AtomicObject

See Also:

Constant Field Values

LOG_VALUE_UPDATE_FAILED

static final String LOG_VALUE_UPDATE_FAILED

Could not update value - value is already defined.

0. Component: COMPONENT
1. Key: "0302"
2. this
3. New value: AtomicObject

See Also:

Constant Field Values

Method Detail

contains

boolean contains(AtomicObject value)

Returns true if the order contains the specified value.

Parameters:

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

Returns:

true if this order contains the specified element.

getOrderValues

AtomicObject[] getOrderValues()

getOrderValues.

Returns:

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

isAfter

boolean isAfter(AtomicObject first,
                AtomicObject last)
         throws ObjectNotFoundException

isAfter.

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

boolean isBefore(AtomicObject first,
                 AtomicObject last)
          throws ObjectNotFoundException

isBefore.

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.

remove

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.

Parameters:

value - a AtomicObject object

Throws:

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

update

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.

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.