Datentyp Set (Menge)

Wertebereich des Datentyps Set

Elemente der Vorlagenentwicklung können in:

• Listen (List)
• Mengen (Set)
• Maps

gruppiert werden.

Für die Bearbeitung von Werten, die eine geordnete Menge von eindeutigen Elementen repräsentieren, stellt FirstSpirit den Datentyp Set zur Verfügung. Dieser Datentyp ermöglicht eine Gruppierung von Elementen. Set-Objekte sind sehr flexibel und beliebig erweiterbar.

Im Gegensatz zu den Datentypen List und Map kann auf ein Element innerhalb einer Menge nicht über einen Indexwert oder einen Schlüsselwert zugegriffen werden. Es ist lediglich möglich, das erste, das letzte, alle Elemente oder ein bestimmtes Element einer Menge auszugeben. Soll ein bestimmtes Element der Menge ausgegeben werden, so muss dieses Element bekannt sein. Im Unterschied zur Liste kann beispielsweise nicht einfach auf das zweite Element der Menge zugegriffen werden. Stattdessen muss geprüft werden, ob ein bestimmtes Element in der Menge enthalten ist, erst dann kann auf dieses Element zugegriffen werden. Aus diesem Grund dürfen Elemente innerhalb einer Menge nur genau einmal vorhanden sein, dass heißt, ein Ausdruck der Form mapElement_1.equals(mapElement_2) kann niemals true zurückliefern.

Der Datentyp Set kann auch in der Sun API-Dokumentation nachgeschlagen werden:

java.util.Set

Definition

Analog zu Maps lassen sich auch Mengen über { } (geschweifte Klammern) erzeugen. Dabei muss folgende Syntax erfüllt sein:

MENGE := '{} | '{' [ AUSDRUCK [',' AUSDRUCK ]*] '}'

Das folgende Codebeispiel erzeugt eine leere Menge und weist diese der Variablen empty_set zu:

$CMS_SET(empty_set, {})$

Soll eine Menge erzeugt werden, die bereits Elemente enthält, können die Elemente einfach als kommaseparierte Liste innerhalb der geschweiften Klammern übergeben werden. Das Codebeispiel erzeugt eine neue, gefüllte Menge mySet:

$CMS_SET(mySet, {"eins","zwei","drei"})$

Im folgenden Codebeispiel wird ein Element zur Menge hinzugefügt.
Damit keine Ausgabe erfolgt, bietet sich die Verwendung einer Dummy-Variable (z. B. void) an:

$CMS_SET(void,mySet.add("vier"))$

Die Ausgabe erfolgt über

$CMS_VALUE(mySet)$

Definition über die Standard-Eingabekomponenten

Im Formularbereich von Vorlagen können Eingabekomponenten definiert werden, mit deren Hilfe die Redakteure später die eigentlichen redaktionellen Inhalte in die Seite einfügen können. Die von FirstSpirit unterstützten Standard-Eingabekomponenten liefern unterschiedliche Datentypen zurück.

Die folgenden Standard-Eingabekomponenten liefern ein Objekt vom Datentyp Set zurück:

• CMS_INPUT_CHECKBOX
• CMS_INPUT_LIST

Auf diesem Objekt lassen sich dann mithilfe einer $CMS_VALUE(...)$-Anweisung Methoden anwenden:

$CMS_VALUE(BEZEICHNER.METHODE)$

Mit BEZEICHNER ist der Bezeichner gemeint, der im Parameter resultname der Eingabekomponente definiert wurde.

Zugriff auf Elemente der Menge

Der Zugriff auf die Elemente der Menge erfolgt beispielsweise über eine Iteration:

$CMS_FOR(setWrapper,mySet)$
  $CMS_VALUE(setWrapper)$
$CMS_END_FOR$

Ausgabe:
setWrapper:drei
setWrapper:eins
setWrapper:vier
setWrapper:zwei

oder über Funktionen:

 $CMS_VALUE(mySet.first())$

 $CMS_VALUE(mySet.last())$

Das Codebeispiel gibt den ersten oder den letzten Wert der Menge zurück.

Daneben ist auch folgender Ausdruck möglich:

$CMS_VALUE(mySet.contains("eins"))$

Die contains-Methode prüft, ob ein bestimmtes Element ein Bestandteil der Menge ist und liefert für das oben angegebene Codebeispiel true zurück.

Methoden auf Set-Objekten

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

add(Object)

Übersicht

addAll(Collection)

Übersicht

clear

Übersicht

contains(Object)

Übersicht

containsAll(Collection)

Übersicht

copy

Übersicht

copyOf(Collection)

Ü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

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

hashCode

Übersicht

isCase(Object)

Übersicht

isEmpty

Ü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

of

Übersicht

of(Object[])

Übersicht

of(Object)

Übersicht

of(Object, Object)

Übersicht

of(Object, Object, Object)

Übersicht

of(Object, Object, Object, Object)

Übersicht

of(Object, Object, Object, Object, Object)

Übersicht

of(Object, Object, Object, Object, Object, Object)

Übersicht

of(Object, Object, Object, Object, Object, Object, Object)

Übersicht

of(Object, Object, Object, Object, Object, Object, Object, Object)

Übersicht

of(Object, Object, Object, Object, Object, Object, Object, Object, Object)

Übersicht

of(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object)

Übersicht

plus(Collection)

Übersicht

plus(Object)

Ü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

Um ein Objekt der Menge zu erhalten, ist ein Eintrag mit get() direkt anzusprechen oder das gesamte Set-Objekt mit der $CMS_FOR(...)$- oder $CMS_RENDER(...)$-Funktionalität zu durchlaufen.

Beispiel:

$CMS_SET(meineVariable,"TEXT")$

$CMS_SET(meineVariable,1234)$