Package org.rumbledb.items

Class MapEntryItem

java.lang.Object
org.rumbledb.items.AbstractMapItem
org.rumbledb.items.MapEntryItem
All Implemented Interfaces:
Serializable, Item
public class MapEntryItem extends AbstractMapItem
See Also:

  • Constructor Details

    • MapEntryItem

      public MapEntryItem(Item key, List<Item> value)

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

    • getSize

      public int getSize()
      Description copied from interface: Item
      Returns the size of the item, if it is an array, or the number of keys if it is a map.
      Returns:
      the size as an int.

    • hasKey

      public boolean hasKey(String key) throws UnsupportedOperationException
      Description copied from interface: Item
      Checks whether the item has a key, if it is a map.
      Returns:
      true if the item has the key, false otherwise.
      Throws:
      UnsupportedOperationException - if the item is not an array or a map.

    • hasKey

      public boolean hasKey(Item key) throws UnsupportedOperationException
      Description copied from interface: Item
      Checks whether the item has a key, if it is a map.
      Returns:
      true if the item has the key, false otherwise.
      Throws:
      UnsupportedOperationException - if the item is not an array or a map.

    • 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(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.

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

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

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

    • getEffectiveBooleanValue

      public boolean getEffectiveBooleanValue()
      Description copied from interface: Item
      Returns the effective boolean value of the item, if atomic.
      Returns:
      the effective boolean value.

    • getMutabilityLevel

      public int getMutabilityLevel()
      Description copied from interface: Item
      Returns the mutability level of the item.
      Returns:
      an int representing nestedness of the item inside transform expressions.

    • setMutabilityLevel

      public void setMutabilityLevel(int mutabilityLevel)
      Description copied from interface: Item
      Sets the mutability level of the item to a supplied value.
      Parameters:
      mutabilityLevel - new mutability level.

    • getTopLevelID

      public long getTopLevelID()
      Description copied from interface: Item
      Returns the top level ID of the item.
      Returns:
      int representing the rowID of the item within a DeltaFile.

    • setTopLevelID

      public void setTopLevelID(long topLevelID)
      Description copied from interface: Item
      Sets the top level ID of the item to a supplied value.
      Parameters:
      topLevelID - new top level ID.

    • getTopLevelOrder

      public double getTopLevelOrder()
      Description copied from interface: Item
      Returns the top level order (sequence number) identifier
      Returns:
      double representing rowOrder of the tuple

    • setTopLevelOrder

      public void setTopLevelOrder(double topLevelOrder)
      Description copied from interface: Item
      Sets the top level order parameter (rowOrder)
      Parameters:
      topLevelOrder - new rowOrder value

    • getPathIn

      public String getPathIn()
      Description copied from interface: Item
      Returns the path from the top level object of a DeltaFile for the item.
      Returns:
      String representing the path of the item from the top level within a DeltaFile.

    • setPathIn

      public void setPathIn(String pathIn)
      Description copied from interface: Item
      Sets the path from the top level object of a DeltaFile for the item to a supplied value.
      Parameters:
      pathIn - new path from top level.

    • getTableLocation

      public String getTableLocation()
      Description copied from interface: Item
      Returns the location of the DeltaFile for the item.
      Returns:
      String representing the location of the DeltaFile for the item.

    • setTableLocation

      public void setTableLocation(String location)
      Description copied from interface: Item
      Sets the location of the DeltaFile for the item to a supplied value.
      Parameters:
      location - new location of the DeltaFile for the item.

    • getSparkSQLValue

      public String getSparkSQLValue()
      Description copied from interface: Item
      Returns the SparkSQL value of the item for use in a query.
      Returns:
      String representing the SparkSQL value of the item.

    • getSparkSQLValue

      public String getSparkSQLValue(ItemType itemType)
      Description copied from interface: Item
      Returns the SparkSQL value of the item for use in a query.
      Returns:
      String representing the SparkSQL value of the item.

    • getSparkSQLType

      public String getSparkSQLType()
      Description copied from interface: Item
      Returns the SparkSQL type of the item for use in a query.
      Returns:
      String representing the SparkSQL type of the item.

    • atomizedValue

      public List<Item> atomizedValue()
      Description copied from interface: Item
      XDM 3.1 Section 5.12 string-value Accessor. dm:string-value($n as node()) as xs:string "The dm:string-value accessor returns the string-value of the node as defined for each node kind." In this API, node string values are exposed via getStringValue() and the default implementation of dm:typed-value delegates to atomizedValue().

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

    • getVariantValue

      public Object getVariantValue()
      Description copied from interface: Item
      Returns the Object containing the converted value of the item for a DataFrame. For use to build Variant columns.
      Returns:
      Object representing the converted value of the item.

    • getCollection

      public Collection getCollection()
      Description copied from interface: Item
      Returns the collection to which the item belongs, if any. Only defined for top-level items.
      Returns:
      the collection.

    • setCollection

      public void setCollection(Collection collection)
      Description copied from interface: Item
      Sets the collection to which the item belongs. Only defined for top-level items.
      Parameters:
      collection - the collection.