de.esoco.data.element

Class ListDataElement<E>

java.lang.Object

de.esoco.lib.property.AbstractStringProperties

de.esoco.lib.property.StringProperties

de.esoco.data.element.DataElement<java.util.List<E>>

de.esoco.data.element.ListDataElement<E>

All Implemented Interfaces:

de.esoco.lib.model.DataModel<E>, de.esoco.lib.property.HasProperties, de.esoco.lib.property.MutableProperties, java.io.Serializable, java.lang.Iterable<E>

Direct Known Subclasses:

DataElementList, DateListDataElement, QueryResultElement, StringListDataElement

public abstract class ListDataElement<E>
extends DataElement<java.util.List<E>>
implements de.esoco.lib.model.DataModel<E>

A base class for data elements that store a list of elements. The generic type E designates the type of the list elements. A subclass must implement the method getList() to return the list of values. The standard data element methods DataElement.updateValue(Object) and getValue() are overridden to throw a runtime exception. Access to the list data must be done through the corresponding methods like getElement(int).

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.esoco.data.element.DataElement

DataElement.CopyMode, DataElement.Flag

Field Summary

Fields inherited from class de.esoco.data.element.DataElement

ALLOWED_VALUES_CHANGED, ANONYMOUS_ELEMENT_PREFIX, DISPLAY_FLAGS, HIDDEN_URL, INPUT_FLAGS, INTERACTION_URL, ITEM_ALL_RESOURCE, ITEM_NEW_RESOURCE, ITEM_RESOURCE_PREFIX, PATH_SEPARATOR_CHAR, SERVER_PROPERTIES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ListDataElement() Default constructor for serialization.
	ListDataElement(java.lang.String sName, Validator<? super E> rElementValidator, java.util.Set<DataElement.Flag> rFlags)

Method Summary

Modifier and Type	Method and Description
void	addAll(java.util.Collection<E> rNewElements) Adds a collection of new elements to this instance.
void	addAllowedValues(java.util.Collection<E> rValues) Adds allowed values to the element validator.
void	addElement(E rElement) Adds a new element value to this instance.
void	addElement(int nIndex, E rElement) Adds a new element value at a certain position of this instance.
void	clear() Removes all element values from this instance.
boolean	containsElement(E rElement) Checks whether this instance contains a certain value.
protected void	copyValue(DataElement<java.util.List<E>> aCopy) Copies the value of this data element into another data element of the same type.
java.util.List<?>	getAllowedValues() Overridden to return the values from the element validator instead.
E	getElement(int nIndex) Returns an element value of this instance.
int	getElementCount() Returns the number of element values in this instance.
int	getElementIndex(E rElement) Returns the index of a certain data element of this instance.
java.util.List<E>	getElements() Returns a new list containing the elements of this instance.
Validator<? super E>	getElementValidator() Returns the validator for single elements of subclasses with composite values.
protected abstract java.util.List<E>	getList() Returns the list of values of this data element.
java.util.List<E>	getValue() //~ Methods ---------------------------------------------------------------- /*************************************** Returns the value of this element.
protected int	getValueHashCode() Returns the value hash code.
protected boolean	hasEqualValueAs(DataElement<?> rOther) Checks whether this element has a value that is equal to that of another element.
java.util.Iterator<E>	iterator()
void	removeElement(E rElement) Removes a certain element from this instance.
java.lang.String	toString() Returns a string representation of this element.

Methods inherited from class de.esoco.data.element.DataElement

checkImmutable, checkValidValue, copy, copyAttributes, createItemName, createItemResource, createResourceId, equals, getName, getParent, getPath, getResourceId, getRoot, getSimpleName, getValidator, hashCode, init, isImmutable, isModified, isOptional, isSelected, isValidValue, markAsChanged, newInstance, readFrom, removeProperty, setModified, setProperty, setSelected, setStringValue, setValidator, setValue, toDebugString, updateValue, valuesEqual, writeTo

Methods inherited from class de.esoco.lib.property.StringProperties

clearFlag, clearProperties, setFlag, setProperties, setProperty, setProperty

Methods inherited from class de.esoco.lib.property.AbstractStringProperties

convertCollection, convertMap, convertValue, ensurePropertyMapExists, findValue, getIntProperty, getProperty, getPropertyCount, getPropertyMap, getPropertyNames, hasEqualProperties, hasFlag, hasProperty, parseCollection, parseMap, parseValue, setPropertyMap

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface de.esoco.lib.property.HasProperties

getIntProperty, getProperty, getPropertyCount, getPropertyNames, hasFlag, hasProperty

Constructor Detail

ListDataElement

public ListDataElement(java.lang.String sName,
                       Validator<? super E> rElementValidator,
                       java.util.Set<DataElement.Flag> rFlags)

See Also:

DataElement.DataElement(String, Validator, Set)

ListDataElement

protected ListDataElement()

Default constructor for serialization.

Method Detail

addAll

public void addAll(java.util.Collection<E> rNewElements)

Adds a collection of new elements to this instance.

Parameters:

rNewElements - The element value to add

addAllowedValues

public void addAllowedValues(java.util.Collection<E> rValues)

Adds allowed values to the element validator.

Parameters:

rValues - The values to add

addElement

public final void addElement(E rElement)

Adds a new element value to this instance.

Parameters:

rElement - The element value to add

addElement

public void addElement(int nIndex,
                       E rElement)

Adds a new element value at a certain position of this instance.

Parameters:

nIndex - The position index

rElement - The element value to add

clear

public void clear()

Removes all element values from this instance.

containsElement

public boolean containsElement(E rElement)

Checks whether this instance contains a certain value.

Parameters:

rElement - The element value to check

Returns:

TRUE if this element contains the given element

getAllowedValues

public java.util.List<?> getAllowedValues()

Overridden to return the values from the element validator instead.

Overrides:

getAllowedValues in class DataElement<java.util.List<E>>

Returns:

The allowed values

See Also:

DataElement.getAllowedValues()

getElement

public E getElement(int nIndex)

Returns an element value of this instance.

Specified by:

getElement in interface de.esoco.lib.model.DataModel<E>

Parameters:

nIndex - The index

Returns:

The element

getElementCount

public int getElementCount()

Returns the number of element values in this instance.

Specified by:

getElementCount in interface de.esoco.lib.model.DataModel<E>

Returns:

The current element count

getElementIndex

public int getElementIndex(E rElement)

Returns the index of a certain data element of this instance.

Parameters:

rElement - The data element to return the index of

Returns:

The element index (starting at zero) or -1 if the element couldn't be found

getElements

public java.util.List<E> getElements()

Returns a new list containing the elements of this instance.

Returns:

A new list instance containing all elements

getElementValidator

public Validator<? super E> getElementValidator()

Returns the validator for single elements of subclasses with composite values. The default implementation returns the same as DataElement.getValidator().

Overrides:

getElementValidator in class DataElement<java.util.List<E>>

Returns:

The element validator

getValue

public final java.util.List<E> getValue()

//~ Methods ---------------------------------------------------------------- /*************************************** Returns the value of this element. Each subclass must implement this method separately because some environments (like GWT) require serializable objects to use specific types for serializable fields. Therefore it is not possible to store a generic Object value in the base class.

Specified by:

getValue in class DataElement<java.util.List<E>>

Returns:

The element value

iterator

public java.util.Iterator<E> iterator()

Specified by:

iterator in interface java.lang.Iterable<E>

removeElement

public void removeElement(E rElement)

Removes a certain element from this instance.

Parameters:

rElement - The element to remove

toString

public java.lang.String toString()

Returns a string representation of this element.

Overrides:

toString in class DataElement<java.util.List<E>>

See Also:

Object.toString()

getList

protected abstract java.util.List<E> getList()

Returns the list of values of this data element. Must be implemented by subclasses to return the type-specific value list.

Returns:

The list of values for this instance (must not be NULL)

copyValue

protected void copyValue(DataElement<java.util.List<E>> aCopy)

Copies the value of this data element into another data element of the same type. This is used by the DataElement.copy(CopyMode, PropertyName...) method and by default uses DataElement.updateValue(Object) to set the value in the target element. Subclasses that don't support updating the value (e.g. because they manage a collection) need to override this method and implement the copying as needed. They can assume that the target object is of exactly the same type as their own.

Overrides:

copyValue in class DataElement<java.util.List<E>>

Parameters:

aCopy - The copied data element to copy the value into

getValueHashCode

protected int getValueHashCode()

Returns the value hash code. Can be overridden by subclasses that have a non-standard internal structure.

Overrides:

getValueHashCode in class DataElement<java.util.List<E>>

Returns:

The value hash code

hasEqualValueAs

protected boolean hasEqualValueAs(DataElement<?> rOther)

Checks whether this element has a value that is equal to that of another element. Can be overridden by subclasses that have a non-standard internal structure.

Overrides:

hasEqualValueAs in class DataElement<java.util.List<E>>

Parameters:

rOther - The other data element which will always be of the same type as this instance

Returns:

TRUE if the value are equal