Package org.rumbledb.items.xml

Class ElementItem

java.lang.Object

org.rumbledb.items.xml.AbstractNodeItem

org.rumbledb.items.xml.ElementItem

All Implemented Interfaces:

Serializable, Item

public class ElementItem
extends AbstractNodeItem

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ElementItem(Name dmNodeName, List<Item> children, List<Item> attributes)	Constructed element with a resolved expanded name (e.g. from XQuery direct/computed constructors).
ElementItem(Node elementNode, List<Item> children, List<Item> attributes)
ElementItem(Node elementNode, List<Item> children, List<Item> attributes, Map<String,String> namespaceBindings)

Method Summary

Modifier and Type	Method	Description
void	addOrReplaceNamespace(Item namespaceItem)
void	addParentToDescendants()	Method sets the parent item for all descendents of the current item.
List<Item>	atomizedValue()	XDM 3.1 Section 5.12 string-value Accessor.
List<Item>	attributes()	XDM 3.1 Section 5.1 attributes Accessor.
List<Item>	baseUri()	XDM 3.1 Section 6.2 Element Node Accessors — base-uri.
List<Item>	children()	XDM 3.1 Section 5.3 children Accessor.
void	clearSchemaType()	Removes a node's schema annotation and restores its untyped typed-value behavior.
Item	copy(boolean mutable)	Makes a copy.
List<Item>	declaredNamespaceNodes()	Helper accessor for XML element nodes: returns namespace nodes for the namespace bindings declared directly on the element.
void	declareNamespaceBinding(String prefix, String uri)	Declares or overrides a namespace binding on this element without rewriting the element name.
List<Item>	documentUri()	XDM 3.1 Section 6.2 Element Node Accessors — document-uri.
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.
XmlSchemaTypeAnnotation	getSchemaTypeAnnotation()
String	getStringValue()	Returns the string value of the item, if it is an atomic item.
XMLDocumentPosition	getXmlDocumentPosition()	Get the position of the Node inside the XML document (and path incase of multiple docs) for sorting / uniqueness
boolean	isElementNode()	Tests whether the item is an XML Element node.
boolean	isId()	XDM 3.1 Section 6.2 Element Node Accessors — is-id.
boolean	isIdrefs()	XDM 3.1 Section 6.2 Element Node Accessors — is-idrefs.
boolean	isNode()	Tests whether the item is an XML node.
List<Item>	namespaceNodes()	XDM 3.1 Section 5.7 namespace-nodes Accessor.
List<Item>	nilled()	XDM 3.1 Section 6.2 Element Node Accessors — nilled.
String	nodeKind()	XDM 3.1 Section 6.2 Element Node Accessors — node-kind.
Name	nodeName()	XDM 3.1 Section 5.10 node-name Accessor.
Item	parent()	XDM 3.1 Section 5.11 parent Accessor.
void	setDeclaredNamespaces(Map<String,String> namespaces)
void	setNodeName(Name nodeName)	Updates the element node-name after namespace fixup chooses a non-conflicting prefix.
void	setParent(Item parent)
void	setSchemaType(@NonNull XmlSchemaTypeAnnotation typeAnnotation)	Sets an element node's schema type annotation when its typed value is unavailable.
void	setSchemaType(@NonNull XmlSchemaTypeAnnotation typeAnnotation, List<Item> typedValue)	Sets a node's schema type annotation together with its XDM typed value.
int	setXmlDocumentPosition(String path, int current)	Set the position of the Node inside the XML document (and path incase of multiple docs) for sorting / uniqueness
void	setXmlSchemaIdentityProperties(boolean id, boolean idRefs)	Records the ID and IDREF properties supplied by XML Schema validation.
void	setXmlSchemaNilled(boolean nilled)	Records the nilled property supplied by XML Schema validation.
List<Item>	typedValue()	XDM 3.1 Section 6.2 Element Node Accessors — typed-value.
List<Item>	typeName()	XDM 3.1 Section 6.2 Element Node Accessors — type-name.

Methods inherited from class org.rumbledb.items.xml.AbstractNodeItem

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

appendItem, appendSequence, castToDecimalValue, castToDoubleValue, castToFloatValue, castToIntegerValue, castToIntValue, generateNativeQuery, getBinaryValue, getBodyIterator, getBooleanValue, getCollection, getContent, getDateTimeValue, getDay, getDayTimeDurationComponent, getDecimalValue, getDFVariablesInClosure, getDoubleValue, getDurationValue, getEpochMillis, getEstimator, getFloatValue, getHour, getIdentifier, getIntegerValue, getIntValue, getItemAt, getItemByKey, getItemByKey, getItemKeys, getItemMembers, getItemValues, getLocalVariablesInClosure, getMinute, getModuleDynamicContext, getMonth, getMutabilityLevel, getNanosecond, getNotationValue, getOffset, getParameterNames, getPathIn, getPeriodValue, getQNameValue, getRDDVariablesInClosure, getSecond, getSequenceAt, getSequenceByKey, getSequenceByKey, getSequenceMembers, getSequenceValues, getSignature, getSize, getSparkSQLType, getSparkSQLValue, getSparkSQLValue, getStringKeys, getTableLocation, getTextValue, getTimeValue, getTopLevelID, getTopLevelOrder, getTransformer, getVariantValue, getYear, hasDateTime, hasKey, hasKey, hasTimeZone, isAnyURI, isArray, isArrayOfItems, isAtomic, isAttributeNode, isBase64Binary, isBinary, isBoolean, isBuiltinFunction, isCommentNode, isDate, isDateTime, isDayTimeDuration, isDecimal, isDocumentNode, isDouble, isDuration, isEstimator, isFloat, isFunction, isGDay, isGMonth, isGMonthDay, isGYear, isGYearMonth, isHexBinary, isInt, isInteger, isMap, isNamespaceNode, isNaN, isNotation, isNull, isNumeric, isObject, isPeriod, isProcessingInstructionNode, isQName, isString, isTextNode, isTime, isTransformer, isUntypedAtomic, isYearMonthDuration, physicalEquals, putItemAt, putItemByKey, putItemByKey, putItemsAt, putLazyItemByKey, putSequenceAt, putSequenceByKey, putSequenceByKey, putSequencesAt, removeItemAt, removeItemByKey, removeItemByKey, removeSequenceAt, serialize, serializeAsJSON, setCollection, setMutabilityLevel, setPathIn, setTableLocation, setTopLevelID, setTopLevelOrder, unparsedEntityPublicId, unparsedEntitySystemId

Constructor Details

ElementItem

public ElementItem(Name dmNodeName,
 List<Item> children,
 List<Item> attributes)

Constructed element with a resolved expanded name (e.g. from XQuery direct/computed constructors).

ElementItem

public ElementItem(Node elementNode,
 List<Item> children,
 List<Item> attributes)

ElementItem

public ElementItem(Node elementNode,
 List<Item> children,
 List<Item> attributes,
 Map<String,String> namespaceBindings)

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

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

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

Returns:

the XML document position

addParentToDescendants

public void addParentToDescendants()

Description copied from interface: Item

Method sets the parent item for all descendents of the current item.

isNode

public boolean isNode()

Description copied from interface: Item

Tests whether the item is an XML node.

Returns:

true if it is an XML node, false otherwise.

isElementNode

public boolean isElementNode()

Description copied from interface: Item

Tests whether the item is an XML Element node.

Returns:

true if it is an XML Element node, false otherwise.

attributes

public List<Item> attributes()

Description copied from interface: Item

XDM 3.1 Section 5.1 attributes Accessor. dm:attributes($n as node()) as attribute()* "The dm:attributes accessor returns the dynamic, unordered set of attribute nodes that have the node as their parent. It is defined only on element and document nodes; for other node kinds it returns the empty sequence."

children

public List<Item> children()

Description copied from interface: Item

XDM 3.1 Section 5.3 children Accessor. dm:children($n as node()) as node()* "The dm:children accessor returns the dynamic, ordered sequence of child nodes of the node. It is defined on all node kinds except attribute and namespace nodes; for those node kinds it returns the empty sequence."

nodeKind

public String nodeKind()

XDM 3.1 Section 6.2 Element Node Accessors — node-kind. "For an Element Node, dm:node-kind returns the string \"element\"."

baseUri

public List<Item> baseUri()

XDM 3.1 Section 6.2 Element Node Accessors — base-uri. "For an Element Node, dm:base-uri returns the base URI of the element node, if it has one; otherwise it returns the empty sequence."

documentUri

public List<Item> documentUri()

XDM 3.1 Section 6.2 Element Node Accessors — document-uri. "For an Element Node, dm:document-uri returns the document URI of the document node that is the root of the tree containing the element, if it has one; otherwise it returns the empty sequence." This implementation delegates to the parent, if any, otherwise returns null.

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.

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.

isId

public boolean isId()

XDM 3.1 Section 6.2 Element Node Accessors — is-id. For schema-validated elements, this reflects whether the typed value is derived from xs:ID.

isIdrefs

public boolean isIdrefs()

XDM 3.1 Section 6.2 Element Node Accessors — is-idrefs. For schema-validated elements, this reflects whether the typed value contains a value derived from xs:IDREF.

nilled

public List<Item> nilled()

XDM 3.1 Section 6.2 Element Node Accessors — nilled. "For an Element Node, dm:nilled returns true if the element is nilled, false if it is not nilled." Schema-validated elements return true if marked as nilled in the PSVI. Untyped or unvalidated elements always return false per XDM 3.1 Section 6.2.1 constraint 10.

nodeName

public Name nodeName()

Description copied from interface: Item

XDM 3.1 Section 5.10 node-name Accessor. dm:node-name($n as node()) as xs:QName? "The dm:node-name accessor returns the name of the node as an xs:QName, or the empty sequence if the node does not have a name."

Returns:

the expanded name (Name) of the node, or null when the accessor yields the empty sequence

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

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.

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.

setParent

public void setParent(Item parent)

typeName

public List<Item> typeName()

XDM 3.1 Section 6.2 Element Node Accessors — type-name. "For an Element Node, dm:type-name returns the name of the dynamic type of the element node, or the empty sequence if the node is untyped."

typedValue

public List<Item> typedValue()

XDM 3.1 Section 6.2 Element Node Accessors — typed-value. "For an Element Node, dm:typed-value returns the typed value of the element node as a sequence of zero or more atomic values."

setSchemaType

public void setSchemaType(@NonNull
 @NonNull XmlSchemaTypeAnnotation typeAnnotation)

Description copied from interface: Item

Sets an element node's schema type annotation when its typed value is unavailable.

Parameters:

typeAnnotation - the schema type annotation

setSchemaType

public void setSchemaType(@NonNull
 @NonNull XmlSchemaTypeAnnotation typeAnnotation,
 List<Item> typedValue)

Description copied from interface: Item

Sets a node's schema type annotation together with its XDM typed value.

Parameters:

typeAnnotation - the schema type annotation

typedValue - the typed value, including an empty list for a valid empty typed value

clearSchemaType

public void clearSchemaType()

Description copied from interface: Item

Removes a node's schema annotation and restores its untyped typed-value behavior.

getSchemaTypeAnnotation

public XmlSchemaTypeAnnotation getSchemaTypeAnnotation()

Returns:

this node's XML Schema annotation, or null when the node is untyped.

setXmlSchemaNilled

public void setXmlSchemaNilled(boolean nilled)

Description copied from interface: Item

Records the nilled property supplied by XML Schema validation.

setXmlSchemaIdentityProperties

public void setXmlSchemaIdentityProperties(boolean id,
 boolean idRefs)

Description copied from interface: Item

Records the ID and IDREF properties supplied by XML Schema validation.

addOrReplaceNamespace

public void addOrReplaceNamespace(Item namespaceItem)

declareNamespaceBinding

public void declareNamespaceBinding(String prefix,
 String uri)

Declares or overrides a namespace binding on this element without rewriting the element name. This is used by constructor namespace-fixup after any necessary prefix rewrites have already been decided.

setDeclaredNamespaces

public void setDeclaredNamespaces(Map<String,String> namespaces)

setNodeName

public void setNodeName(Name nodeName)

Updates the element node-name after namespace fixup chooses a non-conflicting prefix.

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

getEffectiveBooleanValue

public boolean getEffectiveBooleanValue()

Description copied from interface: Item

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

Returns:

the effective boolean value.