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

Interface ListObject

All Superinterfaces:

CollectionObject, DataObject, PropertyHandler

All Known Implementing Classes:

ListObjectImpl

public interface ListObject
extends CollectionObject

A ListObject represents a list of DataObjects.

A detailed description can be found in the ListClass.

Author:

Rainer Maximini

See Also:

ListClass

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMPONENT	Component: "cake.data.objects" (LogComponentIdentifier.COMPONENT)
static String	COMPONENT_KEY	Component-Key: "23" (LogComponentIdentifier.COMPONENT_KEY_LISTOBJECT)
static String	LOG_INDEX_OUT_OF_BOUNDS	The requested index is out of bounds.

Fields inherited from interface de.uni_trier.wi2.procake.data.object.base.CollectionObject

LOG_WRONG_ELEMENT_TYPE

Method Summary

Modifier and Type	Method	Description
DataObject	elementAt(int index)
ListClass	getListClass()
List<DataObject>	getValues()	Returns a list of DataObjects contained in this ListObject.
int	indexOf(DataObject object)	Searches for the first occurence of the given data object, testing for equality using the equals method.
int	indexOf(DataObject object, int index)	Searches for the first occurence of the given object, beginning the search at index , and testing for equality using the equals method.
void	insertAt(DataObject value, int index)	Inserts the specified data object in this list at the specified index.
void	removeAt(int index)	Deletes the object at the specified index.
void	setValues(List<DataObject> values)	Sets the DataObjects of this ListObject.

Methods inherited from interface de.uni_trier.wi2.procake.data.object.base.CollectionObject

addAll, addValue, contains, getCollection, getCollectionClass, getValue, iterator, removeValue, size

Methods inherited from interface de.uni_trier.wi2.procake.data.object.DataObject

assertSameValueAsIn, copy, getDataClass, getId, getModel, hasClassName, hasSameValueAsIn, hasSystemClassName, isAggregate, isAtomic, isBoolean, isByteArray, isChronologic, isCollection, isDataflowWrapper, isDataReference, isDate, isDouble, isInteger, isInterval, isKindOf, isList, isMemberOf, isNESTConstraintEdge, isNESTControlflowEdge, isNESTControlflowNode, isNESTDataflowEdge, isNESTDataNode, isNESTEdge, isNESTGraph, isNESTNode, isNESTPartOfEdge, isNESTSequenceNode, isNESTSequentialWorkflow, isNESTSubWorkflowNode, isNESTTaskNode, isNESTWorkflow, isNESTWorkflowNode, isNode, isNumeric, isSequence, isSet, isString, isSubWorkflow, isTask, isTime, isTimestamp, isUnion, isURI, isVoid, isWorkflow, removeId, setDataClass, setId, toDetailedString, toXML

Methods inherited from interface de.uni_trier.wi2.procake.data.PropertyHandler

addProperty, addProperty, getAllProperties, getAllPropertyNodes, getProperty, getPropertyNames, getPropertyNode, getPropertyRootNode, hasProperties, removeProperty

Field Detail

COMPONENT

static final String COMPONENT

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

See Also:

Constant Field Values

COMPONENT_KEY

static final String COMPONENT_KEY

Component-Key: "23" (LogComponentIdentifier.COMPONENT_KEY_LISTOBJECT)

See Also:

Constant Field Values

LOG_INDEX_OUT_OF_BOUNDS

static final String LOG_INDEX_OUT_OF_BOUNDS

The requested index is out of bounds.

0. Component: COMPONENT
1. Key: "2300"
2. this
3. Number of elements in list
4. Requested index

See Also:

Constant Field Values

Method Detail

elementAt

DataObject elementAt(int index)
              throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

getValues

List<DataObject> getValues()

Returns a list of DataObjects contained in this ListObject.

Returns:

A list of DataObjects contained in this ListObject

setValues

void setValues(List<DataObject> values)

Sets the DataObjects of this ListObject. If a type of an element is incompatible with the elementClass a InvalidTypeException is thrown.

Parameters:

values -

getListClass

ListClass getListClass()

indexOf

int indexOf(DataObject object)

Searches for the first occurence of the given data object, testing for equality using the equals method.

Parameters:

object - the data object that should be searched

Returns:

the index of the first occurrence of the argument in this list; returns -1 if the object is not found.

See Also:

Object.equals(Object)

indexOf

int indexOf(DataObject object,
            int index)
     throws IndexOutOfBoundsException

Searches for the first occurence of the given object, beginning the search at index , and testing for equality using the equals method.

Parameters:

object - the data object that should be searched

index - the non-negative index to start searching from.

Returns:

the index of the first occurrence of the object argument in this list at position index or later in the vector; returns -1 if the object is not found. (Returns -1 if index >= the current size of this list.)

Throws:

IndexOutOfBoundsException - if the index was invalid.

See Also:

Object.equals(Object)

insertAt

void insertAt(DataObject value,
              int index)
       throws IndexOutOfBoundsException,
              InvalidTypeException

Inserts the specified data object in this list at the specified index. Each object in this list with an index greater or equal to the specified index is shifted upward to have an index one greater than the value it had previously.

The index must be a value greater than or equal to 0 and less than or equal to the current size of the list. (If the index is equal to the current size of the list, the new object is appended to the list.)

Parameters:

value - the data object to insert.

index - where to insert the new object.

Throws:

IndexOutOfBoundsException - if the index was invalid.

InvalidTypeException - if the value type is incompatible to the element type.

removeAt

void removeAt(int index)
       throws IndexOutOfBoundsException

Deletes the object at the specified index. Each object in this list with an index greater or equal to the specified index is shifted downward to have an index one smaller than the value it had previously. The size of this list is decreased by 1.

The index must be a value greater than or equal to 0 and less than the current size of the list.

Parameters:

index - the index of the object to remove.

Throws:

IndexOutOfBoundsException - if the index was invalid.