Datentyp Map

Wertebereich des Datentyps Map

Elemente der Vorlagenentwicklung können in:

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

gruppiert werden.

Für die Bearbeitung von Werten, die eine Menge von Schlüssel-Wert-Paaren repräsentieren, stellt FirstSpirit den Datentyps 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 Link kann auch in der Sun 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" })$

Die Angabe von { } erzeugt keine Map, sondern ein Set ! Um eine Map zu erzeugen, muss immer mindestens ein Wertepaar angegeben werden.

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":

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

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 Tabellen werden alle Methoden aufgelistet, die auf Objekten von Datentyp "Map" aufgerufen werden können:

clear

Übersicht

compareTo(Comparable)

Übersicht

containsKey(Object)

Übersicht

containsValue(Object)

Übersicht

entrySet

Übersicht

equals(Object)

Übersicht

get(Set)

Übersicht

get(Collection)

Übersicht

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

Übersicht

get(Object)

Ü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

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

keySet

Übersicht

print

Übersicht

put(Object, Object)

Übersicht

putAll(Map)

Übersicht

remove(Object)

Übersicht

set(String, Object)

Übersicht

set(Object, Object)

Übersicht

size

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

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

Übersicht

toJson

Übersicht

toString

Übersicht

type

Übersicht

values

Übersicht