Package org.rumbledb.items

Class LazyObjectItem

java.lang.Object

org.rumbledb.items.AbstractMapItem

org.rumbledb.items.LazyObjectItem

All Implemented Interfaces:

Serializable, Item

public class LazyObjectItem
extends AbstractMapItem

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	LazyObjectItem.LazyValue

Constructor Summary

Constructors

Constructor	Description
LazyObjectItem()

Method Summary

Modifier and Type	Method	Description
Item	copy(boolean mutable)	Makes a copy.
ItemType	getDynamicType()	Returns the dynamic type of the item (only for error message purposes).
boolean	getEffectiveBooleanValue()	Returns the effective boolean value of the item, if atomic.
Item	getItemByKey(String key)	Returns the value item associated with a specific key, if it is a map.
Item	getItemByKey(Item key)	Returns the value item associated with a specific key, if it is an object.
List<Item>	getItemKeys()	Returns the (possibly non-string) atomic keys of the item, if it is a map-like object.
List<Item>	getItemValues()	Returns the values of the item, if it is a map.
List<Item>	getSequenceByKey(String key)	Returns the value sequence associated with a string key, if it is a map.
List<Item>	getSequenceByKey(Item key)	Returns the value sequence associated with a key, if it is a map-like object.
List<List<Item>>	getSequenceValues()	Returns the value sequences of the item, if it is a map.
List<String>	getStringKeys()	Returns the string keys of the item, if it is a map.
String	getStringValue()	Returns the string value of the item, if it is an atomic item.
boolean	isMap()	Tests whether the item is a map.
boolean	isObject()	Tests whether the item is an object.
void	putItemByKey(String key, Item value)	Adds a key-value pair, if it is a map.
void	putItemByKey(Item key, Item value)	Adds a key-value pair, if it is a map.
void	putLazyItemByKey(String key, ItemRuntimePlan iterator, DynamicContext context, boolean isArray)	Adds a key-value pair, if it is a lazy object item.
void	putSequenceByKey(String key, List<Item> valueSequence)	Adds a key-sequence pair, if it is a map.
void	putSequenceByKey(Item key, List<Item> valueSequence)	Adds a key-sequence pair, if it is a map.
void	removeItemByKey(String key)	Removes a key-value pair, if it is a map.
void	removeItemByKey(Item key)	Removes a key-value pair, if it is a map.

Methods inherited from class org.rumbledb.items.AbstractMapItem

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.rumbledb.api.Item

addOrReplaceNamespace, addParentToDescendants, appendItem, appendSequence, atomizedValue, attributes, baseUri, castToDecimalValue, castToDoubleValue, castToFloatValue, castToIntegerValue, castToIntValue, children, clearSchemaType, declaredNamespaceNodes, documentUri, generateNativeQuery, getBinaryValue, getBodyIterator, getBooleanValue, getCollection, getContent, getDateTimeValue, getDay, getDayTimeDurationComponent, getDecimalValue, getDFVariablesInClosure, getDoubleValue, getDurationValue, getEpochMillis, getEstimator, getFloatValue, getHour, getIdentifier, getIntegerValue, getIntValue, getItemAt, getItemMembers, getLocalVariablesInClosure, getMinute, getModuleDynamicContext, getMonth, getMutabilityLevel, getNanosecond, getNotationValue, getOffset, getParameterNames, getPathIn, getPeriodValue, getQNameValue, getRDDVariablesInClosure, getSchemaTypeAnnotation, getSecond, getSequenceAt, getSequenceMembers, getSignature, getSize, getSparkSQLType, getSparkSQLValue, getSparkSQLValue, getTableLocation, getTextValue, getTimeValue, getTopLevelID, getTopLevelOrder, getTransformer, getVariantValue, getXmlDocumentPosition, getYear, hasDateTime, hasKey, hasKey, hasTimeZone, isAnyURI, isArray, isArrayOfItems, isAtomic, isAttributeNode, isBase64Binary, isBinary, isBoolean, isBuiltinFunction, isCommentNode, isDate, isDateTime, isDayTimeDuration, isDecimal, isDocumentNode, isDouble, isDuration, isElementNode, isEstimator, isFloat, isFunction, isGDay, isGMonth, isGMonthDay, isGYear, isGYearMonth, isHexBinary, isId, isIdrefs, isInt, isInteger, isNamespaceNode, isNaN, isNode, isNotation, isNull, isNumeric, isPeriod, isProcessingInstructionNode, isQName, isString, isTextNode, isTime, isTransformer, isUntypedAtomic, isYearMonthDuration, namespaceNodes, nilled, nodeKind, nodeName, parent, physicalEquals, putItemAt, putItemsAt, putSequenceAt, putSequencesAt, removeItemAt, removeSequenceAt, serialize, serializeAsJSON, setCollection, setMutabilityLevel, setParent, setPathIn, setSchemaType, setSchemaType, setTableLocation, setTopLevelID, setTopLevelOrder, setXmlDocumentPosition, setXmlSchemaIdentityProperties, setXmlSchemaNilled, typedValue, typeName, unparsedEntityPublicId, unparsedEntitySystemId

Constructor Details

LazyObjectItem

public LazyObjectItem()

Method Details

copy

public Item copy(boolean mutable)

Description copied from interface: Item

Makes a copy.

Parameters:

mutable - whether the copy should be mutable (if supported by the item).

Returns:

a copy

isMap

public boolean isMap()

Description copied from interface: Item

Tests whether the item is a map.

Returns:

true if it is a map, false otherwise.

isObject

public boolean isObject()

Description copied from interface: Item

Tests whether the item is an object. Object items are legacy JSONiq objects, that allow only for

• string keys
• singleton values

Returns:

true if it is an object, false otherwise.

getStringKeys

public List<String> getStringKeys()

Description copied from interface: Item

Returns the string keys of the item, if it is a map.

Returns:

a list of strings, corresponding to the keys of the map.

getItemKeys

public List<Item> getItemKeys()

Description copied from interface: Item

Returns the (possibly non-string) atomic keys of the item, if it is a map-like object.

Returns:

the list of atomic keys as items.

getItemValues

public List<Item> getItemValues()

Description copied from interface: Item

Returns the values of the item, if it is a map.

Returns:

a list containing, for each key in the map, the item associated with that key.

getSequenceValues

public List<List<Item>> getSequenceValues()

Description copied from interface: Item

Returns the value sequences of the item, if it is a map.

Returns:

a list containing, for each key in the map, the sequence of items associated with that key.

getItemByKey

public Item getItemByKey(String key)

Description copied from interface: Item

Returns the value item associated with a specific key, if it is a map.

Parameters:

key - a string key.

Returns:

the item associated with the key, or null if absent.

getItemByKey

public Item getItemByKey(Item key)

Description copied from interface: Item

Returns the value item associated with a specific key, if it is an object.

Parameters:

key - a key item.

Returns:

the item associated with the key, or null if absent.

getSequenceByKey

public List<Item> getSequenceByKey(String key)

Description copied from interface: Item

Returns the value sequence associated with a string key, if it is a map.

Parameters:

key - a string key.

Returns:

the value sequence for the key, or null if absent.

getSequenceByKey

public List<Item> getSequenceByKey(Item key)

Description copied from interface: Item

Returns the value sequence associated with a key, if it is a map-like object.

Parameters:

key - an atomic key item.

Returns:

the value sequence for the key, or null if absent.

putItemByKey

public void putItemByKey(String key,
 Item value)

Description copied from interface: Item

Adds a key-value pair, if it is a map.

Parameters:

key - a key.

value - a value.

putItemByKey

public void putItemByKey(Item key,
 Item value)

Description copied from interface: Item

Adds a key-value pair, if it is a map.

Parameters:

key - an atomic key.

value - a value.

putSequenceByKey

public void putSequenceByKey(Item key,
 List<Item> valueSequence)

Description copied from interface: Item

Adds a key-sequence pair, if it is a map.

Parameters:

key - an atomic key.

valueSequence - a value sequence.

putSequenceByKey

public void putSequenceByKey(String key,
 List<Item> valueSequence)

Description copied from interface: Item

Adds a key-sequence pair, if it is a map.

Parameters:

key - an atomic key.

valueSequence - a value sequence.

removeItemByKey

public void removeItemByKey(String key)

Description copied from interface: Item

Removes a key-value pair, if it is a map.

Parameters:

key - a key.

removeItemByKey

public void removeItemByKey(Item key)

Description copied from interface: Item

Removes a key-value pair, if it is a map.

Parameters:

key - an atomic key.

putLazyItemByKey

public void putLazyItemByKey(String key,
 ItemRuntimePlan iterator,
 DynamicContext context,
 boolean isArray)

Description copied from interface: Item

Adds a key-value pair, if it is a lazy object item. The value is lazily computed.

Parameters:

key - a key.

iterator - a runtime iterator.

context - a dynamic context.

isArray - whether to always wrap the result in an array.

getDynamicType

public ItemType getDynamicType()

Description copied from interface: Item

Returns the dynamic type of the item (only for error message purposes).

Returns:

the dynamic type as an item type.

getStringValue

public String getStringValue()

Description copied from interface: Item

Returns the string value of the item, if it is an atomic item.

Returns:

the string value.

getEffectiveBooleanValue

public boolean getEffectiveBooleanValue()

Description copied from interface: Item

Returns the effective boolean value of the item, if atomic.

Returns:

the effective boolean value.