Package org.rumbledb.items.xml

Class CommentItem

java.lang.Object
org.rumbledb.items.xml.CommentItem
All Implemented Interfaces:
com.esotericsoftware.kryo.KryoSerializable, Serializable, Item
public class CommentItem extends Object implements Item
See Also:

  • Constructor Details

    • CommentItem

      public CommentItem()

    • CommentItem

      public CommentItem(String content)

    • CommentItem

      public CommentItem(Node commentNode)

  • Method Details

    • setXmlDocumentPosition

      public int setXmlDocumentPosition(String path, int current)
      Description copied from interface: Item
      Set the position of the Node inside the XML document (and path incase of multiple docs) for sorting / uniqueness
      Specified by:
      setXmlDocumentPosition in interface Item
      Parameters:
      path - the path of the XML document
      current - the current position
      Returns:
      the new position

    • getXmlDocumentPosition

      public XMLDocumentPosition getXmlDocumentPosition()
      Description copied from interface: Item
      Get the position of the Node inside the XML document (and path incase of multiple docs) for sorting / uniqueness
      Specified by:
      getXmlDocumentPosition in interface Item
      Returns:
      the XML document position

    • setParent

      public void setParent(Item parent)
      Specified by:
      setParent in interface Item

    • parent

      public Item parent()
      Description copied from interface: Item
      XDM 3.1 Section 5.11 parent Accessor. dm:parent($n as node()) as node()? "The dm:parent accessor returns the parent of the node, or the empty sequence if the node has no parent."
      Specified by:
      parent in interface Item

    • getDynamicType

      public ItemType getDynamicType()
      Description copied from interface: Item
      Returns the dynamic type of the item (only for error message purposes).
      Specified by:
      getDynamicType in interface Item
      Returns:
      the dynamic type as an item type.

    • isNode

      public boolean isNode()
      Description copied from interface: Item
      Tests whether the item is an XML node.
      Specified by:
      isNode in interface Item
      Returns:
      true if it is an XML node, false otherwise.

    • isCommentNode

      public boolean isCommentNode()
      Specified by:
      isCommentNode in interface Item

    • nodeKind

      public String nodeKind()
      XDM 3.1 Section 6.6 Comment Node Accessors — node-kind. "For a Comment Node, dm:node-kind returns the string \"comment\"."
      Specified by:
      nodeKind in interface Item

    • nodeName

      public Name nodeName()
      XDM 3.1 Section 6.6 Comment Node Accessors — node-name. "For a Comment Node, dm:node-name returns the empty sequence."
      Specified by:
      nodeName in interface Item
      Returns:
      the expanded name (Name) of the node, or null when the accessor yields the empty sequence

    • getStringValue

      public String getStringValue()
      Description copied from interface: Item
      Returns the string value of the item, if it is an atomic item.
      Specified by:
      getStringValue in interface Item
      Returns:
      the string value.

    • 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().
      Specified by:
      atomizedValue in interface Item

    • equals

      public boolean equals(Object other)
      Description copied from interface: Item
      Tests for logical equality. The semantics are that of the eq operator.
      Specified by:
      equals in interface Item
      Overrides:
      equals in class Object
      Parameters:
      other - another item.
      Returns:
      true it is equal to other, false otherwise.

    • write

      public void write(com.esotericsoftware.kryo.Kryo kryo, com.esotericsoftware.kryo.io.Output output)
      Specified by:
      write in interface com.esotericsoftware.kryo.KryoSerializable

    • read

      public void read(com.esotericsoftware.kryo.Kryo kryo, com.esotericsoftware.kryo.io.Input input)
      Specified by:
      read in interface com.esotericsoftware.kryo.KryoSerializable

    • namespaceNodes

      public List<Item> namespaceNodes()
      Description copied from interface: Item
      XDM 3.1 Section 5.7 namespace-nodes Accessor. dm:namespace-nodes($n as node()) as namespace-node()* "The dm:namespace-nodes accessor returns the dynamic, unordered set of Namespace Nodes. It is defined on all seven node kinds." This default implementation is only a placeholder on the generic Item interface and must be overridden by XML node implementations that support namespaces.
      Specified by:
      namespaceNodes in interface Item

    • declaredNamespaceNodes

      public List<Item> declaredNamespaceNodes()
      Description copied from interface: Item
      Helper accessor for XML element nodes: returns namespace nodes for the namespace bindings declared directly on the element. This does not include inherited or statically known namespaces — only the bindings explicitly declared on the element (for example via xmlns attributes). Non-element nodes must override this to return the empty sequence.
      Specified by:
      declaredNamespaceNodes in interface Item

    • attributes

      public List<Item> attributes()
      XDM 3.1 Section 6.6 Comment Node Accessors — attributes. For a Comment Node, dm:attributes returns the empty sequence.
      Specified by:
      attributes in interface Item

    • children

      public List<Item> children()
      XDM 3.1 Section 6.6 Comment Node Accessors — children. For a Comment Node, dm:children returns the empty sequence.
      Specified by:
      children in interface Item

    • baseUri

      public List<Item> baseUri()
      XDM 3.1 Section 6.6 Comment Node Accessors — base-uri. For a Comment Node, dm:base-uri returns the base URI of the parent node, if it has one; otherwise it returns the empty sequence.
      Specified by:
      baseUri in interface Item

    • documentUri

      public List<Item> documentUri()
      XDM 3.1 Section 6.6 Comment Node Accessors — document-uri. For a Comment Node, dm:document-uri returns the document-uri of the document node that is the root of the tree containing the comment node, if it has one; otherwise it returns the empty sequence.
      Specified by:
      documentUri in interface Item

    • isId

      public boolean isId()
      XDM 3.1 Section 6.6 Comment Node Accessors — is-id. For a Comment Node, dm:is-id returns false.
      Specified by:
      isId in interface Item

    • isIdrefs

      public boolean isIdrefs()
      XDM 3.1 Section 6.6 Comment Node Accessors — is-idrefs. For a Comment Node, dm:is-idrefs returns false.
      Specified by:
      isIdrefs in interface Item

    • nilled

      public List<Item> nilled()
      XDM 3.1 Section 6.6 Comment Node Accessors — nilled. For a Comment Node, dm:nilled returns the empty sequence.
      Specified by:
      nilled in interface Item

    • typeName

      public List<Item> typeName()
      XDM 3.1 Section 6.6 Comment Node Accessors — type-name. For a Comment Node, dm:type-name returns the empty sequence.
      Specified by:
      typeName in interface Item