Data type Catalog

Value range of the Catalog data type

Using the input component FS_CATALOG lists can be maintained. It returns a Catalog object. This contains Card objects.

The input component FS_CATALOG returns

• a Catalog object when accessed via the API,
• in template set and snippet definitions of templates, by contrast, a CatalogAccessor type object

In addition to the methods, which can be applied to the Catalog data type, the CatalogAccessor data type offers the getSnippets method. This method can be used to access the snippets of the entries of a FS_CATALOG component.

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

$CMS_VALUE(IDENTIFIER)$

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

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

de.espirit.firstspirit.client.access.editor.lists.Catalog

Definition using the standard input components

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

• FS_CATALOG

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

$CMS_VALUE(IDENTIFIER.METHOD)$

Methods on Catalog objects

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

add(Object)

Overview

addAll(Collection)

Overview

clear

Overview

contains(Object)

Overview

containsAll(Collection)

Overview

copy

Overview

create(Template, FormData)

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

find(UUID)

This method can be used to identify a "Card" by means of its UUID (java.util.UUID).

The UUID of an FS_CATALOG entry can be determined using the getId() method.

Overview

find(String)

This method can be used to identify a "Card". It returns java.util.Optional<Card>, which contains the "Card" object (if available).

The text (content of the st_text input component) of a particular entry (in this case the FS_CATALOG entry with the ID 7644cfe2-b117-4ec7-bc94-bb8f255d1f59) can be output with the following example syntax:

$CMS_VALUE(st_catalog.find("7644cfe2-b117-4ec7-bc94-bb8f255d1f59").get().item.st_text)$

The UUID of an FS_CATALOG entry can be determined using the getId() method.

Overview

fold(Lambda, Map)

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

See page Mapping expressions (lambda).

Overview

forEach(Consumer)

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

getItems

The getItems method (in Bean syntax: .items) can be used to access Card data directly and work with this data. It returns a list of FormData objects:

IDENTIFIER.items

Here, IDENTIFIER is the variable name for the respective FS_CATALOG input component.

In order to be able to identify and output the value of a certain input component ("FormField") in this list for a snippet definition both the identifier of the required input component and its position in the list must be specified:

st_catalog.items[0].st_text

In this example, the value of "st_text" of the first entry in the FS_CATALOG component is identified with the "st_catalog" identifier.

Overview

hashCode

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

length

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(Object)

Overview

removeAll(Collection)

Overview

removeIf(Predicate)

Overview

retainAll(Collection)

Overview

set(String, Object)

Overview

size

Overview

spliterator

Overview

toArray

Overview

toArray(Object[])

Overview

toArray(IntFunction)

Overview

toJSON

Overview

toList

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