com.marklogic.client.expression

Interface MapExpr

public interface MapExpr

Builds expressions to call functions in the map server library for a row pipeline.

Method Summary

Modifier and Type	Method and Description
XsBooleanExpr	contains(MapMapExpr map, String key) Returns true if the key exists in the map.
XsBooleanExpr	contains(MapMapExpr map, XsStringExpr key) Returns true if the key exists in the map.
XsUnsignedIntExpr	count(MapMapExpr map) Returns the number of keys used in the map.
MapMapExpr	entry(XsStringExpr key, ItemSeqExpr value) Constructs a new map with a single entry consisting of the key and value specified as arguments.
ItemSeqExpr	get(MapMapExpr map, String key) Get a value from a map.
ItemSeqExpr	get(MapMapExpr map, XsStringExpr key) Get a value from a map.
XsStringSeqExpr	keys(MapMapExpr map) Get the keys used in the map.
MapMapExpr	map() Creates a map.
MapMapExpr	map(ElementNodeExpr map) Creates a map.
MapMapSeqExpr	mapSeq(MapMapExpr... items) Constructs a sequence of MapMapExpr items.

Method Detail

contains

XsBooleanExpr contains(MapMapExpr map,
                       String key)

Returns true if the key exists in the map.

Provides a client interface to a server function. See map:contains

Parameters:

map - A map.

key - A key.

Returns:

a XsBooleanExpr expression

contains

XsBooleanExpr contains(MapMapExpr map,
                       XsStringExpr key)

Returns true if the key exists in the map.

Provides a client interface to a server function. See map:contains

Parameters:

map - A map.

key - A key.

Returns:

a XsBooleanExpr expression

count

XsUnsignedIntExpr count(MapMapExpr map)

Returns the number of keys used in the map.

Provides a client interface to a server function. See map:count

Parameters:

map - A map.

Returns:

a XsUnsignedIntExpr expression

entry

MapMapExpr entry(XsStringExpr key,
                 ItemSeqExpr value)

Constructs a new map with a single entry consisting of the key and value specified as arguments. This is particularly helpful when used as part of an argument to map:new().

Provides a client interface to a server function. See map:entry

Parameters:

key - The map key.

value - The map value.

Returns:

a MapMapExpr expression

get

ItemSeqExpr get(MapMapExpr map,
                String key)

Get a value from a map.

Provides a client interface to a server function. See map:get

Parameters:

map - A map.

key - A key.

Returns:

a ItemSeqExpr expression sequence

get

ItemSeqExpr get(MapMapExpr map,
                XsStringExpr key)

Get a value from a map.

Provides a client interface to a server function. See map:get

Parameters:

map - A map.

key - A key.

Returns:

a ItemSeqExpr expression sequence

keys

XsStringSeqExpr keys(MapMapExpr map)

Get the keys used in the map.

Provides a client interface to a server function. See map:keys

Parameters:

map - A map.

Returns:

a XsStringSeqExpr expression sequence

map

MapMapExpr map()

Creates a map.

Provides a client interface to a server function. See map:map

Returns:

a MapMapExpr expression

map

MapMapExpr map(ElementNodeExpr map)

Creates a map.

Provides a client interface to a server function. See map:map

Parameters:

map - A serialized map element.

Returns:

a MapMapExpr expression

mapSeq

MapMapSeqExpr mapSeq(MapMapExpr... items)

Constructs a sequence of MapMapExpr items.