Datentyp CatalogAccessor

Wertebereich des Datentyps CatalogAccessor

Die Eingabekomponente FS_CATALOG ermöglicht die Erstellung und Pflege von Absatz- oder Verweislisten.
Beim Zugriff über die API liefert sie ein Catalog-Objekt zurück, in Vorlagensatz- und Schnipseldefinitionen von Vorlagen wird hingegen ein Objekt vom Typ CatalogAccessor zurückgeliefert.
Der Datentyp CatalogAccessor erbt die Methoden des Datentyps Catalog und stellt zusätzlich die Methode getSnippets zur Verfügung, mit der auf die Schnipsel der Einträge einer FS_CATALOG-Komponente zugegriffen werden kann.

Weitere Informationen zum Datentyp CatalogAccessor siehe API-Dokumentation:

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

Methoden auf CatalogAccessor-Objekten

In der unten angegebenen Tabelle werden alle Methoden aufgelistet, die auf Objekten vom Datentyp CatalogAccessor aufgerufen werden können:

add(Object)

Übersicht

addAll(Collection)

Übersicht

clear

Übersicht

contains(Object)

Übersicht

containsAll(Collection)

Übersicht

copy

Übersicht

create(Template, FormData)

Übersicht

distinct(Lambda)

Über diese Methode können Duplikate einer Liste entsprechend einer Bedingung eliminiert bzw. ignoriert werden. Sie kann z. B. für Glossare oder Übersichten verwendet werden, die dann beispielsweise verlinkt auch als Navigationselement dienen können.

Siehe Seite Abbildungs-Ausdrücke (Lambda).

Übersicht

equals(Object)

Übersicht

filter(String)

Übersicht

filter(Lambda)

Haben Listen mehrere Attribute pro Element (vergleichbar einem Datensatz mit mehreren Spalten), können die Elemente mit der Methode .filter(Lambda) nach den einzelnen Attributen gefiltert werden.

Siehe dazu Seite Abbildungs-Ausdrücke (Lambda).

Übersicht

find(UUID)

Diese Methode kann verwendet werden, um eine "Card" anhand ihrer UUID (java.util.UUID) zu ermitteln.

Die UUID eines FS_CATALOG-Eintrags kann mithilfe der Methode getId() ermittelt werden.

Übersicht

find(String)

Diese Methode kann verwendet werden, um eine "Card" zu ermitteln. Sie gibt java.util.Optional<Card> zurück, das (falls vorhanden) das "Card"-Objekt enthält.

Mit folgender beispielhaften Syntax kann der Text (Inhalt der Eingabekomponente st_text) eines bestimmten Eintrags (hier der FS_CATALOG-Eintrag mit der ID 7644cfe2-b117-4ec7-bc94-bb8f255d1f59) ausgegeben werden:

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

Die UUID eines FS_CATALOG-Eintrags kann mithilfe der Methode getId() ermittelt werden.

Übersicht

fold(Lambda, Map)

Siehe Seite Abbildungs-Ausdrücke (Lambda).

Übersicht

forEach(Consumer)

Übersicht

getClass

Die Methode .getClass() (in Bean-Syntax: .class) liefert die Klasse des aufrufendes Objektes zurück (vgl. java.lang.Class).

Aufruf:

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

Ausgabe:

java.lang.String

Übersicht

getItems

Mithilfe der Methode getItems (in Bean-Syntax: .items) kann direkt auf Card-Daten zugegriffen und mit diesen gearbeitet werden. Sie gibt eine Liste von FormData-Objekten zurück:

BEZEICHNER.items

Dabei ist BEZEICHNER der Variablenname der betreffenden FS_CATALOG-Eingabekomponente.

Um für eine Schnipseldefinition den Wert einer bestimmten Eingabekomponente ("FormField") dieser Liste ermitteln und ausgeben zu können, muss einerseits der Bezeichner der gewünschten Eingabekomponente angegeben werden, andererseits ihre Position in der Liste:

st_catalog.items[0].st_text

In diesem Beispiel wird der Wert von "st_text" des 1. Eintrags der FS_CATALOG-Komponente mit dem Bezeichner "st_catalog" ermittelt.

Übersicht

getSnippets

Mithilfe dieser Methode (in Bean-Syntax: .snippets) kann auf die Schnipsel der Einträge einer FS_CATALOG-Komponente zugegriffen werden, z. B.

FS_CATALOG.snippets

Die Methode liefert eine Liste zurück. Das gewünschte Element der Liste kann durch Angabe der Positionsnummer (in eckigen Klammern, die Zählung beginnt bei 0) zurückgeliefert werden.
Um die Werte der Schnipsel der verschiedenen Einträge einer FS_CATALOG-Komponente zu gelangen, kann folgende Syntax verwendet werden:

FS_CATALOG_VAR.snippets[0].thumbnail
FS_CATALOG_VAR.snippets[0].header
FS_CATALOG_VAR.snippets[0].extract

Dabei liefert

• thumbnail den Wert des Felds Miniaturansicht
• header den Wert des Felds Kennsatz
• extract den Wert des Feld Ausriss

der Schnipseldefinition des in diesem Fall ersten Eintrags der FS_CATALOG-Komponente.
Siehe dazu auch Interface DataSnippet (Package de.espirit.firstspirit.agency).

Die Ausgabe des Bildes (Feld Miniaturansicht) erfolgt über folgende Beispielsyntax:

<img src="$CMS_REF(FS_CATALOG_VAR.snippets[0].thumbnail.source)$"/>

Über die Verwendung von $CMS_SWITCH(...)$ kann eine Ausgabe abhängig vom Typ des Image-Objekts erfolgen, z. B.

$CMS_SWITCH(FS_CATALOG_VAR.snippets[0].thumbnail.source)$ 
           $CMS_CASE(class("de.espirit.firstspirit.access.store.mediastore.Media"))$ 
             thumbnail: <img src="$CMS_REF(FS_CATALOG_VAR.snippets[0].thumbnail.source)$"/> 
          
           $CMS_CASE(class("java.lang.String"))$ 
             thumbnail: $CMS_VALUE(FS_CATALOG_VAR.snippets[0].thumbnail.source)$
$CMS_END_SWITCH$

In diesem Beispiel erfolgt die Ausgabe abhängig davon, ob ein Media- (Klasse de.espirit.firstspirit.access.store.mediastore.Media) oder ein String-Objekt (Klasse java.lang.String) vorliegt.

Übersicht

isCase(Object)

Übersicht

isEmpty

Die Methode .isEmpty() (in Bean-Syntax: .isEmpty) prüft, ob ein Ausdruck bzw. Objekt leer ist, z. B. storeElement.isEmpty(). Das Ergebnis der semantischen Prüfung hängt vom Ausdruck bzw. Objekt ab, z. B. eine Zeichenkette ist dann leer, wenn sie kein Zeichen enthält. Bei Objekten mit komplexen Werten oder Objekten entscheidet das Objekt, wann es leer ist. Der Datentyp DomElement enthält beispielsweise immer ein leeres Dokument, ist also nie null. Die Prüfung einer leeren DOM-Editor-Eingabekomponente mit der Methode .isNull() liefert daher den Wert false, während die Prüfung der Komponente auf .isEmpty() den Wert true liefern würde.

Die Methode .isEmpty() gibt einen booleschen Wert als Ergebnis der Prüfung zurück. true (=wahr) ist die Prüfung, wenn der Ausdruck bzw. das Objekt leer ist und false (=unwahr) wenn nicht.

Übersicht

isNull

Die Methode .isNull() (in Bean-Syntax: .isNull) prüft, ob ein Ausdruck bzw. Objekt Null ist, z. B. storeElement.isNull(). Bei Objekten mit komplexen Werten oder Objekten entscheidet das Objekt, wann es null ist. Der Datentyp DomElement enthält beispielsweise immer ein leeres Dokument, ist also nie null. Die Prüfung einer leeren DOM-Editor-Eingabekomponente mit der Methode .isNull() liefert daher den Wert false, während die Prüfung der Komponente auf .isEmpty() den Wert true liefern würde.

Die Methode .isNull() gibt einen booleschen Wert als Ergebnis der Prüfung zurück. true (=wahr) ist die Prüfung, wenn der Ausdruck bzw. das Objekt Null ist und false (=unwahr) wenn nicht.

Übersicht

iterator

Übersicht

length

Übersicht

map(String)

Übersicht

map(Lambda)

Siehe Seite Abbildungs-Ausdrücke (Lambda).

Übersicht

max

Übersicht

max(Comparator)

Übersicht

max(Lambda)

Siehe Seite Abbildungs-Ausdrücke (Lambda).

Übersicht

min

Übersicht

min(Comparator)

Übersicht

min(Lambda)

Siehe Seite Abbildungs-Ausdrücke (Lambda).

Übersicht

plus(Collection)

Übersicht

print

Übersicht

print(Object)

Übersicht

remove(Object)

Übersicht

removeAll(Collection)

Übersicht

removeIf(Predicate)

Übersicht

retainAll(Collection)

Übersicht

set(String, Object)

Übersicht

size

Übersicht

spliterator

Übersicht

toArray

Übersicht

toArray(Object[])

Übersicht

toArray(IntFunction)

Übersicht

toJSON

Übersicht

toList

Übersicht

toString

Übersicht

toString(String)

Unter der Angabe eines individuell wählbaren Trennzeichens können die einzelnen Elemente, z.B. einer Liste, zu einem String zusammengeführt werden, wobei das Trennzeichen zur Abtrennung der einzelnen Elemente verwendet wird.

Beispiel:

$CMS_SET(myList, ["Haus","Schlüssel","Fenster"])$
$CMS_VALUE(myList.toString("; "))$

Die Elemente der Liste myList werden mit Semikolon und Leerzeichen voneinander getrennt ausgegeben:

Haus; Schlüssel; Fenster

Übersicht

toString(String, String)

Übersicht

type

Übersicht