Package 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	Description
ServerExpression	contains(ServerExpression map, ServerExpression key)	Returns true if the key exists in the map.
ServerExpression	contains(ServerExpression map, java.lang.String key)	Returns true if the key exists in the map.
ServerExpression	count(ServerExpression map)	Returns the number of keys used in the map.
ServerExpression	entry(ServerExpression key, ServerExpression value)	Constructs a new map with a single entry consisting of the key and value specified as arguments.
ServerExpression	get(ServerExpression map, ServerExpression key)	Get a value from a map.
ServerExpression	get(ServerExpression map, java.lang.String key)	Get a value from a map.
ServerExpression	keys(ServerExpression map)	Get the keys used in the map.
ServerExpression	map()	Creates a map.
ServerExpression	map(ServerExpression map)	Creates a map.
ServerExpression	newExpr()	Constructs a new map by combining the keys from the maps given as an argument.
ServerExpression	newExpr(ServerExpression maps)	Constructs a new map by combining the keys from the maps given as an argument.

Method Detail

contains

ServerExpression contains(ServerExpression map,
                          java.lang.String key)

Returns true if the key exists in the map.

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

Parameters:

map - A map. (of map:map)

key - A key. (of xs:string)

Returns:

a server expression with the xs:boolean server data type

contains

ServerExpression contains(ServerExpression map,
                          ServerExpression key)

Returns true if the key exists in the map.

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

Parameters:

map - A map. (of map:map)

key - A key. (of xs:string)

Returns:

a server expression with the xs:boolean server data type

count

ServerExpression count(ServerExpression map)

Returns the number of keys used in the map.

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

Parameters:

map - A map. (of map:map)

Returns:

a server expression with the xs:unsignedInt server data type

entry

ServerExpression entry(ServerExpression key,
                       ServerExpression 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 the map:entry server function.

Parameters:

key - The map key. (of xs:string)

value - The map value. (of item)

Returns:

a server expression with the map:map server data type

get

ServerExpression get(ServerExpression map,
                     java.lang.String key)

Get a value from a map.

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

Parameters:

map - A map. (of map:map)

key - A key. (of xs:string)

Returns:

a server expression with the item server data type

get

ServerExpression get(ServerExpression map,
                     ServerExpression key)

Get a value from a map.

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

Parameters:

map - A map. (of map:map)

key - A key. (of xs:string)

Returns:

a server expression with the item server data type

keys

ServerExpression keys(ServerExpression map)

Get the keys used in the map.

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

Parameters:

map - A map. (of map:map)

Returns:

a server expression with the xs:string server data type

map

ServerExpression map()

Creates a map.

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

Returns:

a server expression with the map:map server data type

map

ServerExpression map(ServerExpression map)

Creates a map.

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

Parameters:

map - A serialized map element. (of element-node)

Returns:

a server expression with the map:map server data type

newExpr

ServerExpression newExpr()

Constructs a new map by combining the keys from the maps given as an argument. If a given key exists in more than one argument map, the value from the last such map is used.

Provides a client interface to the map:new server function.

Returns:

a server expression with the map:map server data type

newExpr

ServerExpression newExpr(ServerExpression maps)

Constructs a new map by combining the keys from the maps given as an argument. If a given key exists in more than one argument map, the value from the last such map is used.

Provides a client interface to the map:new server function.

Parameters:

maps - The argument maps. (of map:map)

Returns:

a server expression with the map:map server data type