Map data type

Value range of the Map data type

Elements of the template development can be grouped in:

• Lists (List )
• Sets (Set )
• Maps

FirstSpirit provides the Map data type for the processing/editing of values which represent a set of key value pairs. This data type enables grouping of elements represented by a set of unique key values (“keys”) to which specific contents (“values”) are assigned. Any number of key value pairs can be created within a map object. The values are always accessed via the key.

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

java.util.Map

Definition

Maps can be generated via { } (curly brackets). The following syntax must be fulfilled:

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

The following code example generates a map with one entry and assigns the variable map to it:

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

You can create an empty map as follows:

$CMS_SET(map,{:})$

The statement { } does not create a map, but a Set.

If a filled map is to be generated, i.e. a map which already contains key value pairs, these are passed as a comma-separated list within the curly brackets. The key and value are separated by a :. The following code example generates a new, filled map map with the key name and the value Mustermann and a key firstname and the related value Heinz:

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

Use the following syntax to add a key value pair to an existing map (in this case with the identifier map):

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

or

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

Access to map values

The map values are accessed solely via assigned key values whereby each of the following expressions is valid and returns the given output:

$CMS_VALUE(map.get("name"))$

$CMS_VALUE(map.name)$

$CMS_VALUE(map["name"])$

Output:
Mustermann

The following code example iterates across all elements of the map and outputs all available key value pairs:

$CMS_FOR(mapWrapper,map)$
     $CMS_VALUE(mapWrapper)$
$CMS_END_FOR$ 

Output:
mapWrapper:name=Mustermann
mapWrapper:firstname=Heinz

Methods on map objects

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

clear

Overview

compute(Object, BiFunction)

Overview

computeIfAbsent(Object, Function)

Overview

computeIfPresent(Object, BiFunction)

Overview

containsKey(Object)

Overview

containsValue(Object)

Overview

copyOf(Map)

Overview

entry(Object, Object)

Overview

entrySet

Overview

equals(Object)

Overview

forEach(BiConsumer)

Overview

get(Set)

Overview

get(Collection)

Overview

get(String)

A map contains key/value pairs. The .get(String) method can be used to determine the value of the transferred key.

If a map contains the following key/value pairs:

1st pair: key="Max", value="Mustermann"
2nd pair: key="Franz", value="Meier"
3rd pair: key="Peter", value="Müller"

results in the invocation

MAP.get("Franz")

for return of a character string (cf. java.lang.String ) with the content

Meier

Overview

get(Object)

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

getOrDefault(Object, Object)

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

keySet

Overview

merge(Object, Object, BiFunction)

Overview

of

Overview

of(Object, Object)

Overview

of(Object, Object, Object, Object)

Overview

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

Overview

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

Overview

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

Overview

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

Overview

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

Overview

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

Overview

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

Overview

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

Overview

ofEntries(Map$Entry[])

Overview

print

Overview

put(Object, Object)

Overview

putAll(Map)

Overview

putIfAbsent(Object, Object)

Overview

remove(Object)

Overview

remove(Object, Object)

Overview

replace(Object, Object)

Overview

replace(Object, Object, Object)

Overview

replaceAll(BiFunction)

Overview

set(String, Object)

Overview

set(Object, Object)

Overview

size

The .size() (in Bean syntax: .size) method returns the number of the key/value pairs in a map.

The returned object is an integer (see java.lang.Integer).

Overview

toJSON

Overview

toString

Overview

type

Overview

values

Overview