FormDataList data type

Value range of the FormDataList data type

Using the input component FS_LIST lists can be entered and maintained. It returns a FormDataList object. This contains IdProvidingFormData objects.

Lists which are created by means of FS_LIST, DATASOURCE type INLINE, can be output via a $CMS_VALUE(...)$ instruction, e.g.

$CMS_VALUE(INDENTIFIER)$

Different methods can be applied to the resulting data type (FormDataList).

The data type FormDataList can also be looked up in the API documentation:

de.espirit.firstspirit.forms.FormDataList

Definition using the standard input components

The following standard input component returns an object of data type FormDataList:

• FS_LIST

Then, with the help of a $CMS_VALUE(...)$ instruction, methods can then be applied to this object:

$CMS_VALUE(IDENTIFIER.METHOD)$

Methods on FormDataList objects

The table below lists all methods which can be invoked on objects of data type FormDataList:

add(List)

Overview

add(Object)

Overview

add(int, Object)

Overview

addAll(Collection)

Overview

addAll(int, Collection)

Overview

clear

Overview

compareTo(Comparable)

Overview

contains(Object)

Overview

containsAll(Collection)

Overview

copy

Overview

distinct(Lambda)

This method filters a collection and returns only the first occurrence relating to a lambda expression.

It can be used to eliminate or ignore duplicates of a list according to a given condition. For this reason, it can be used for glossaries or summaries, which can then serve linked, for example, as navigational element.

See page Mapping expressions (lambda).

Overview

equals(Object)

Overview

filter(String)

Overview

filter(Lambda)

If lists have several attributes per element (comparable with a dataset with several columns), the elements can be filtered by the individual attributes using the method .filter(Lambda).

See page Mapping expressions (lambda).

Overview

first

Overview

fold(Lambda, Map)

This method folds the collection with the given lambda expression and start value.

See page Mapping expressions (lambda).

Overview

get(Range)

Overview

get(int)

Overview

getClass

The .getClass() (in Bean syntax: .class) method returns the class of the invoking object (cf. java.lang.Class).

Invocation:

$CMS_VALUE(myString.class)$
$CMS_VALUE(myString.getClass())$

Output:

java.lang.String

Overview

getProducer

Overview

hashCode

Overview

indexOf(Object)

Overview

isCase(Object)

Overview

isEmpty

The .isEmpty() (in Bean syntax: .isEmpty) method checks whether an expression or object is empty, e.g. storeElement.isEmpty(). The result of the semantic check depends on the expression or object, e.g. a character string is empty if it does not contain any characters. In the case of objects with complex values or objects, the object decides when it is empty. The data type DomElement for example always contains an empty document, thus it is never null. For this reason, checking an empty DOM editor input component by using the method .isNull()returns the value false, whereas checking the component with .isEmpty() would return the value true.

The method .isEmpty() returns a Boolean value as the check result. true is the check result if the expression or object is empty and false if not.

Overview

isNull

The .isNull() (in Bean syntax: .isNull) method checks whether an expression or object is null , e.g. storeElement.isNull(). In the case of objects with complex values or objects, the object decides when it is null. The data type DomElement for example always contains an empty document, thus it is never null. For this reason, checking an empty DOM editor input component by using the method .isNull() returns the value false, whereas checking the component with .isEmpty() would return the value true.

The method .isNull() returns a Boolean value as the check result. true is the check result if the expression or object is null and false if not.

Overview

iterator

Overview

last

Overview

lastIndexOf(Object)

Overview

length

Overview

listIterator

Overview

listIterator(int)

Overview

map(String)

Overview

map(Lambda)

See page Mapping expressions (lambda).

Overview

max

Overview

max(Comparator)

Overview

max(Lambda)

This method delivers the maximum element concerning to the given comparator.

See page Mapping expressions (lambda).

Overview

min

Overview

min(Comparator)

Overview

min(Lambda)

This method delivers the minimum element concerning to the given comparator.

See page Mapping expressions (lambda).

Overview

plus(Collection)

Overview

plus(Object)

Overview

print

Overview

print(Object)

Overview

remove(int)

Overview

remove(Object)

Overview

removeAll(Collection)

Overview

retainAll(Collection)

Overview

reverse

Overview

set(int, Object)

Overview

set(String, Object)

Overview

size

Overview

sort

Overview

sort(String)

Overview

sort(Comparator)

Overview

sort(Lambda)

If lists have several attributes per element (comparable with a dataset with several columns), the elements can be sorted by the individual attributes using the method .sort(Lambda).

See page Mapping expressions (lambda).

Overview

subList(int)

Overview

subList(int, int)

Overview

sublist(int)

Overview

sublist(int, int)

Overview

toArray

Overview

toArray(Object[])

Overview

toJson

Overview

toString

Overview

toString(String)

The individual elements, e.g. of a list, can be output as string, separated by a delimiter which can be chosen freely.

Example:

$CMS_SET(myList, ["House","Key","Window"])$
$CMS_VALUE(myList.toString("; "))$

The elements of the list myList are output, separated each by semicolon and a space character:

House; Key; Window

Overview

toString(String, String)

Overview

type

Overview