Startseite / Vorlagenentwicklung / Vorlagensyntax / Datentypen / Map

Datentyp MapVerfügbar ab FirstSpirit-Version 4.0

Wertebereich des Datentyps Map

Elemente der Vorlagenentwicklung können in:

gruppiert werden.

Für die Bearbeitung von Werten, die eine Menge von Schlüssel-Wert-Paaren repräsentieren, stellt FirstSpirit den Datentyp Map zur Verfügung. Dieser Datentyp ermöglicht eine Gruppierung von Elementen, die durch eine Menge von eindeutigen Schlüsselwerten („keys“) repräsentiert werden, denen bestimmte Inhalte („values“) zugeordnet werden. Innerhalb eines Map-Objektes können beliebig viele Schlüssel-Wert-Paare angelegt werden. Der Zugriff auf die Werte, erfolgt immer über den Schlüssel („key“).

Der Datentyp Map kann auch in der Oracle API-Dokumentation nachgeschlagen werden:

java.util.Map

Definition

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

MAP := '{' AUSDRUCK ':' AUSDRUCK [',' AUSDRUCK ':' AUSDRUCK ]* ] '}'

Das folgende Codebeispiel erzeugt eine Map mit einem Eintrag und weist diese der Variablen map zu:

$CMS_SET(map, { "key" : "value" })$

Eine leere Map kann folgendermaßen erzeugt werden:

$CMS_SET(map,{:})$

Die Angabe { } erzeugt keine Map, sondern ein Set.

Soll eine gefüllte Map erzeugt werden, also eine Map, die bereits Schlüssel-Wert-Paare enthält, werden diese als kommaseparierte Liste innerhalb der geschweiften Klammern übergeben. Schlüssel und Wert werden dabei durch einen : getrennt. Das folgende Codebeispiel erzeugt eine neue gefüllte Map map mit dem Schlüssel name und dem Wert Mustermann sowie einem Schlüssel vorname und dem zugehörigen Wert Heinz:

$CMS_SET(map, {"name":"Mustermann", "vorname":"Heinz"})$

Einer bestehenden Map (in diesem Fall mit dem Bezeichner map) können Schlüssel-Wert-Paare über folgende Syntax hinzugefügt werden:

$CMS_SET( map["key"], "value")$

bzw.

$CMS_SET(void,map.put("key","value"))$

Zugriff auf Werte der Map

Der Zugriff auf die Werte der Map erfolgt ausschließlich über die zugeordneten Schlüsselwerte, wobei jeder der folgenden drei Ausdrücke, gültig ist, und die angegebene Ausgabe zurückliefert:

$CMS_VALUE(map.get("name"))$
$CMS_VALUE(map.name)$
$CMS_VALUE(map["name"])$
Ausgabe:
Mustermann

Das folgende Codebeispiel iteriert über alle Elemente der Map und gibt alle vorhandenen Schlüssel-Wert-Paare aus:

$CMS_FOR(mapWrapper,map)$
$CMS_VALUE(mapWrapper)$
$CMS_END_FOR$
Ausgabe:
mapWrapper:name=Mustermann
mapWrapper:vorname=Heinz

Methoden auf Map-Objekten

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

Objekt wird von folgenden Formular-Objekten erzeugt:
FS_BUTTON
Methodenname Rückgabetyp Kurzbeschreibung Verfügbar seit
clear void
compute(Object, BiFunction) Object
computeIfAbsent(Object, Function) Object
computeIfPresent(Object, BiFunction) Object
containsKey(Object) boolean
containsValue(Object) boolean
copyOf(Map) Map
entry(Object, Object) Map$Entry
entrySet Set
equals(Object) boolean
forEach(BiConsumer) void
get(Set) Set
get(Collection) List
get(String) Object Wert zu einem Schlüssel
get(Object) Object
getClass Class Klasse des aufrufenden Objektes
getOrDefault(Object, Object) Object
isCase(Object) boolean
isEmpty boolean Prüft, ob ein Ausdruck leer ist
isNull boolean Prüft, ob ein Ausdruck Null ist
keySet Set
merge(Object, Object, BiFunction) Object
of Map
of(Object, Object) Map
of(Object, Object, Object, Object) Map
of(Object, Object, Object, Object, Object, Object) Map
of(Object, Object, Object, Object, Object, Object, Object, Object) Map
of(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object) Map
of(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object) Map
of(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object) Map
of(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object) Map
of(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object) Map
of(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object) Map
ofEntries(Map$Entry[]) Map
print void
put(Object, Object) Object
putAll(Map) void
putIfAbsent(Object, Object) Object
remove(Object) Object
remove(Object, Object) boolean
replace(Object, Object) Object
replace(Object, Object, Object) boolean
replaceAll(BiFunction) void
set(String, Object) Object
set(Object, Object) Map
size int Anzahl der Schlüssel-/Wert-Paare
toJSON String Convert to a JSON-compatible string representation including necessary quotes and escaping for immediate use. Handles Maps, Collections, Arrays, Numbers, Strings, Boolean, Date, and JsonElement. A date instance will be converted to an ISO-8601 formatted date string. Any object other than above will be converted using its 'toString()' value. 5.2.11
toString String
type String
values Collection

clear

Methodenname Rückgabetyp Verfügbar seit
clear void

compute(Object, BiFunction)

Methodenname Rückgabetyp Verfügbar seit
compute(Object, BiFunction) Object

computeIfAbsent(Object, Function)

Methodenname Rückgabetyp Verfügbar seit
computeIfAbsent(Object, Function) Object

computeIfPresent(Object, BiFunction)

Methodenname Rückgabetyp Verfügbar seit
computeIfPresent(Object, BiFunction) Object

containsKey(Object)

Methodenname Rückgabetyp Verfügbar seit
containsKey(Object) boolean

containsValue(Object)

Methodenname Rückgabetyp Verfügbar seit
containsValue(Object) boolean

copyOf(Map)

Methodenname Rückgabetyp Verfügbar seit
copyOf(Map) Map

entry(Object, Object)

Methodenname Rückgabetyp Verfügbar seit
entry(Object, Object) Map$Entry

entrySet

Methodenname Rückgabetyp Verfügbar seit
entrySet Set

equals(Object)

Methodenname Rückgabetyp Verfügbar seit
equals(Object) boolean

forEach(BiConsumer)

Methodenname Rückgabetyp Verfügbar seit
forEach(BiConsumer) void

get(Set)

Methodenname Rückgabetyp Verfügbar seit
get(Set) Set

get(Collection)

Methodenname Rückgabetyp Verfügbar seit
get(Collection) List

get(String)

In einer Map sind Schlüssel-/Wert-Paare enthalten. Mit der Methode .get(String) kann der Wert zu dem übergebenen Schlüssel ermittelt werden.

Wenn in einer Map folgende Schlüssel-/Wert-Paare enthalten sind:

1. Paar: Schlüssel="Max", Wert="Mustermann"
2. Paar: Schlüssel="Franz", Wert="Meier"
3. Paar: Schlüssel="Peter", Wert="Müller"

führt der Aufruf

MAP.get("Franz")

zur Rückgabe einer Zeichenkette (vgl. java.lang.String ) mit dem Inhalt

Meier
Methodenname Rückgabetyp Verfügbar seit
get(String) Object

get(Object)

Methodenname Rückgabetyp Verfügbar seit
get(Object) Object

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
Methodenname Rückgabetyp Verfügbar seit
getClass Class

getOrDefault(Object, Object)

Methodenname Rückgabetyp Verfügbar seit
getOrDefault(Object, Object) Object

isCase(Object)

Methodenname Rückgabetyp Verfügbar seit
isCase(Object) boolean

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.

Methodenname Rückgabetyp Verfügbar seit
isEmpty boolean

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.

Methodenname Rückgabetyp Verfügbar seit
isNull boolean

keySet

Methodenname Rückgabetyp Verfügbar seit
keySet Set

merge(Object, Object, BiFunction)

Methodenname Rückgabetyp Verfügbar seit
merge(Object, Object, BiFunction) Object

of

Methodenname Rückgabetyp Verfügbar seit
of Map

of(Object, Object)

Methodenname Rückgabetyp Verfügbar seit
of(Object, Object) Map

of(Object, Object, Object, Object)

Methodenname Rückgabetyp Verfügbar seit
of(Object, Object, Object, Object) Map

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

Methodenname Rückgabetyp Verfügbar seit
of(Object, Object, Object, Object, Object, Object) Map

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

Methodenname Rückgabetyp Verfügbar seit
of(Object, Object, Object, Object, Object, Object, Object, Object) Map

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

Methodenname Rückgabetyp Verfügbar seit
of(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object) Map

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

Methodenname Rückgabetyp Verfügbar seit
of(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object) Map

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

Methodenname Rückgabetyp Verfügbar seit
of(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object) Map

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

Methodenname Rückgabetyp Verfügbar seit
of(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object) Map

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

Methodenname Rückgabetyp Verfügbar seit
of(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object) Map

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

Methodenname Rückgabetyp Verfügbar seit
of(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object) Map

ofEntries(Map$Entry[])

Methodenname Rückgabetyp Verfügbar seit
ofEntries(Map$Entry[]) Map

print

Methodenname Rückgabetyp Verfügbar seit
print void

put(Object, Object)

Methodenname Rückgabetyp Verfügbar seit
put(Object, Object) Object

putAll(Map)

Methodenname Rückgabetyp Verfügbar seit
putAll(Map) void

putIfAbsent(Object, Object)

Methodenname Rückgabetyp Verfügbar seit
putIfAbsent(Object, Object) Object

remove(Object)

Methodenname Rückgabetyp Verfügbar seit
remove(Object) Object

remove(Object, Object)

Methodenname Rückgabetyp Verfügbar seit
remove(Object, Object) boolean

replace(Object, Object)

Methodenname Rückgabetyp Verfügbar seit
replace(Object, Object) Object

replace(Object, Object, Object)

Methodenname Rückgabetyp Verfügbar seit
replace(Object, Object, Object) boolean

replaceAll(BiFunction)

Methodenname Rückgabetyp Verfügbar seit
replaceAll(BiFunction) void

set(String, Object)

Methodenname Rückgabetyp Verfügbar seit
set(String, Object) Object

set(Object, Object)

Methodenname Rückgabetyp Verfügbar seit
set(Object, Object) Map

size

Die Methode .size() (in Bean-Syntax: .size) liefert die Anzahl der Schlüssel-/Wert-Paare in einer Map zurück.

Das Rückgabeobjekt ist eine Ganzzahl (siehe java.lang.Integer).

Methodenname Rückgabetyp Verfügbar seit
size int

toJSON

Convert to a JSON-compatible string representation including necessary quotes and escaping for immediate use. Handles Maps, Collections, Arrays, Numbers, Strings, Boolean, Date, and JsonElement. A date instance will be converted to an ISO-8601 formatted date string. Any object other than above will be converted using its 'toString()' value.
Methodenname Rückgabetyp Verfügbar seit
toJSON String 5.2.11

toString

Methodenname Rückgabetyp Verfügbar seit
toString String

type

Methodenname Rückgabetyp Verfügbar seit
type String

values

Methodenname Rückgabetyp Verfügbar seit
values Collection

© 2005 - 2022 Crownpeak Technology GmbH | Alle Rechte vorbehalten. | FirstSpirit 2023.1 | Datenschutz