org.basex.query.item.map

Class Map

java.lang.Object

org.basex.data.ExprInfo

org.basex.query.expr.Expr

org.basex.query.item.Value

org.basex.query.item.Item

org.basex.query.item.FItem

org.basex.query.item.map.Map

All Implemented Interfaces:

java.lang.Iterable<Item>

public final class Map
extends FItem

The map item.

Author:

BaseX Team 2005-12, BSD License, Leo Woerteler

Nested Class Summary

Nested classes/interfaces inherited from class org.basex.query.expr.Expr

Expr.Use

Field Summary

Fields

Modifier and Type	Field and Description
static Map	EMPTY The empty map.

Fields inherited from class org.basex.query.item.Item

UNDEF

Fields inherited from class org.basex.query.item.Value

type

Method Summary

Methods

Modifier and Type	Method and Description
Map	addAll(Map other, InputInfo ii) Adds all bindings from the given map into this.
int	arity() Number of arguments this function item takes.
Map	coerceTo(FuncType ft, QueryContext ctx, InputInfo ii) Coerces this function item to the given function type.
Str	collation() Collation of this map.
Bln	contains(Item k, InputInfo ii) Checks if the given key exists in the map.
boolean	deep(InputInfo ii, Map o) Checks if the this map is deep-equal to the given one.
Map	delete(Item key, InputInfo ii) Deletes a key from this map.
java.lang.String	description() Returns a string description of the expression.
QNm	fName() Name of this function, null means anonymous function.
Value	get(Item key, InputInfo ii) Gets the value from this map.
int	hash(InputInfo ii) Returns a hash code for this value.
boolean	hasType(MapType t) Checks if the map has the given type.
Map	insert(Item k, Value v, InputInfo ii) Inserts the given value into this map.
Value	invValue(QueryContext ctx, InputInfo ii, Value... args) Invokes this function item with the given arguments.
Value	keys() All keys defined in this map.
Int	mapSize() Number of values contained in this map.
void	plan(Serializer ser) Serializes the expression tree.
java.util.HashMap<java.lang.Object,java.lang.Object>	toJava() Returns a Java representation of the value.
TokenObjMap<java.lang.Object>	tokenJavaMap(InputInfo ii) Converts the map to a map with tokens as keys and java objects as values.
java.lang.String	toString()

Methods inherited from class org.basex.query.item.FItem

eq, invItem, invIter, string

Methods inherited from class org.basex.query.item.Item

bool, comparable, dbl, dec, diff, ebv, equiv, flt, homogenous, input, isItem, item, itemAt, iter, iterable, itr, score, score, serialize, size, test, type, writeTo, xdmInfo

Methods inherited from class org.basex.query.item.Value

cache, comp, count, data, info, isValue, iter, iterator, removable, remove, uses, value

Methods inherited from class org.basex.query.expr.Expr

addText, compEbv, hasFreeVars, indexAccessible, indexEquivalent, isEmpty, isFunction, isVacuous, markTailCalls, sameAs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY

public static final Map EMPTY

The empty map.

Method Detail

arity

public int arity()

Description copied from class: FItem

Number of arguments this function item takes.

Specified by:

arity in class FItem

Returns:

function arity

fName

public QNm fName()

Description copied from class: FItem

Name of this function, null means anonymous function.

Specified by:

fName in class FItem

Returns:

name or null

invValue

public Value invValue(QueryContext ctx,
             InputInfo ii,
             Value... args)
               throws QueryException

Description copied from class: FItem

Invokes this function item with the given arguments.

Specified by:

invValue in class FItem

Parameters:

ctx - query context

ii - input info

args - arguments

Returns:

resulting iterator

Throws:

QueryException - query exception

delete

public Map delete(Item key,
         InputInfo ii)
           throws QueryException

Deletes a key from this map.

Parameters:

key - key to delete

ii - input info

Returns:

updated map if changed, this otherwise

Throws:

QueryException - query exception

get

public Value get(Item key,
        InputInfo ii)
          throws QueryException

Gets the value from this map.

Parameters:

key - key to look for

ii - input info

Returns:

bound value if found, the empty sequence () otherwise

Throws:

QueryException - query exception

contains

public Bln contains(Item k,
           InputInfo ii)
             throws QueryException

Checks if the given key exists in the map.

Parameters:

k - key to look for

ii - input info

Returns:

true(), if the key exists, false() otherwise

Throws:

QueryException - query exception

addAll

public Map addAll(Map other,
         InputInfo ii)
           throws QueryException

Adds all bindings from the given map into this.

Parameters:

other - map to add

ii - input info

Returns:

updated map if changed, this otherwise

Throws:

QueryException - query exception

hasType

public boolean hasType(MapType t)

Checks if the map has the given type.

Parameters:

t - type

Returns:

true if the type fits, false otherwise

coerceTo

public Map coerceTo(FuncType ft,
           QueryContext ctx,
           InputInfo ii)
             throws QueryException

Description copied from class: FItem

Coerces this function item to the given function type.

Specified by:

coerceTo in class FItem

Parameters:

ft - function type

ctx - query context

ii - input info

Returns:

coerced item

Throws:

QueryException - query exception

insert

public Map insert(Item k,
         Value v,
         InputInfo ii)
           throws QueryException

Inserts the given value into this map.

Parameters:

k - key to insert

v - value to insert

ii - input info

Returns:

updated map if changed, this otherwise

Throws:

QueryException - query exception

mapSize

public Int mapSize()

Number of values contained in this map.

Returns:

size

keys

public Value keys()

All keys defined in this map.

Returns:

list of keys

collation

public Str collation()

Collation of this map.

Returns:

collation

deep

public boolean deep(InputInfo ii,
           Map o)
             throws QueryException

Checks if the this map is deep-equal to the given one.

Parameters:

ii - input info

o - other map

Returns:

result of check

Throws:

QueryException - query exception

tokenJavaMap

public TokenObjMap<java.lang.Object> tokenJavaMap(InputInfo ii)
                                           throws QueryException

Converts the map to a map with tokens as keys and java objects as values.

Parameters:

ii - input info

Returns:

token map

Throws:

QueryException - query exception

toJava

public java.util.HashMap<java.lang.Object,java.lang.Object> toJava()
                                                            throws QueryException

Description copied from class: Value

Returns a Java representation of the value.

Overrides:

toJava in class FItem

Returns:

Java object

Throws:

QueryException - query exception

hash

public int hash(InputInfo ii)
         throws QueryException

Description copied from class: Value

Returns a hash code for this value.

Overrides:

hash in class Item

Parameters:

ii - input info

Returns:

hash code

Throws:

QueryException - if atomization can't be applied (e.g. function item)

description

public java.lang.String description()

Description copied from class: ExprInfo

Returns a string description of the expression. This method is only called by error messages. Contrary to the ExprInfo.toString() method, arguments are not included in the output.

Overrides:

description in class Value

Returns:

result of check

plan

public void plan(Serializer ser)
          throws java.io.IOException

Description copied from class: ExprInfo

Serializes the expression tree.

Specified by:

plan in class FItem

Parameters:

ser - serializer

Throws:

java.io.IOException - I/O exception

toString

public java.lang.String toString()

Specified by:

toString in class ExprInfo