Package org.rumbledb.items.xml
Class TextItem
java.lang.Object
org.rumbledb.items.xml.AbstractNodeItem
org.rumbledb.items.xml.TextItem
- All Implemented Interfaces:
Serializable,Item
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidMethod sets the parent item for all descendents of the current item.XDM 3.1 Section 5.12 string-value Accessor.XDM 3.1 Section 6.7 Text Node Accessors — attributes.baseUri()XDM 3.1 Section 6.7 Text Node Accessors — base-uri.children()XDM 3.1 Section 6.7 Text Node Accessors — children.copy(boolean mutable) Makes a copy.Helper accessor for XML element nodes: returns namespace nodes for the namespace bindings declared directly on the element.XDM 3.1 Section 6.7 Text Node Accessors — document-uri.Returns the dynamic type of the item (only for error message purposes).booleanReturns the effective boolean value of the item, if atomic.Returns the string value of the item, if it is an atomic item.Returns the string value of the text item, if it is a text item.Get the position of the Node inside the XML document (and path incase of multiple docs) for sorting / uniquenessbooleanisId()XDM 3.1 Section 6.7 Text Node Accessors — is-id.booleanisIdrefs()XDM 3.1 Section 6.7 Text Node Accessors — is-idrefs.booleanisNode()Tests whether the item is an XML node.booleanXDM 3.1 Section 5.7 namespace-nodes Accessor.nilled()XDM 3.1 Section 6.7 Text Node Accessors — nilled.nodeKind()XDM 3.1 Section 6.7 Text Node Accessors — node-kind.nodeName()XDM 3.1 Section 5.10 node-name Accessor.parent()XDM 3.1 Section 5.11 parent Accessor.voidintsetXmlDocumentPosition(String path, int current) Set the position of the Node inside the XML document (and path incase of multiple docs) for sorting / uniquenesstypeName()XDM 3.1 Section 6.7 Text Node Accessors — type-name: For a Text Node, dm:type-name returns xs:untypedAtomic.Methods inherited from class org.rumbledb.items.xml.AbstractNodeItem
equals, hashCodeMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.rumbledb.api.Item
addOrReplaceNamespace, appendItem, appendSequence, castToDecimalValue, castToDoubleValue, castToFloatValue, castToIntegerValue, castToIntValue, clearSchemaType, 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, getSchemaTypeAnnotation, getSecond, getSequenceAt, getSequenceByKey, getSequenceByKey, getSequenceMembers, getSequenceValues, getSignature, getSize, getSparkSQLType, getSparkSQLValue, getSparkSQLValue, getStringKeys, getTableLocation, 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, isElementNode, isEstimator, isFloat, isFunction, isGDay, isGMonth, isGMonthDay, isGYear, isGYearMonth, isHexBinary, isInt, isInteger, isMap, isNamespaceNode, isNaN, isNotation, isNull, isNumeric, isObject, isPeriod, isProcessingInstructionNode, isQName, isString, isTime, isTransformer, isUntypedAtomic, isYearMonthDuration, physicalEquals, putItemAt, putItemByKey, putItemByKey, putItemsAt, putLazyItemByKey, putSequenceAt, putSequenceByKey, putSequenceByKey, putSequencesAt, removeItemAt, removeItemByKey, removeItemByKey, removeSequenceAt, serialize, serializeAsJSON, setCollection, setMutabilityLevel, setPathIn, setSchemaType, setSchemaType, setTableLocation, setTopLevelID, setTopLevelOrder, setXmlSchemaIdentityProperties, setXmlSchemaNilled, typedValue, unparsedEntityPublicId, unparsedEntitySystemId
-
Constructor Details
-
TextItem
-
TextItem
Create a new Text Node with the given content.- Parameters:
content- the content of the text node
-
-
Method Details
-
copy
Description copied from interface:ItemMakes a copy.- Parameters:
mutable- whether the copy should be mutable (if supported by the item).- Returns:
- a copy
-
setXmlDocumentPosition
Description copied from interface:ItemSet 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 documentcurrent- the current position- Returns:
- the new position
-
getXmlDocumentPosition
Description copied from interface:ItemGet the position of the Node inside the XML document (and path incase of multiple docs) for sorting / uniqueness- Returns:
- the XML document position
-
setParent
-
addParentToDescendants
public void addParentToDescendants()Description copied from interface:ItemMethod sets the parent item for all descendents of the current item. -
getTextValue
Description copied from interface:ItemReturns the string value of the text item, if it is a text item.- Returns:
- the string value.
-
getEffectiveBooleanValue
public boolean getEffectiveBooleanValue()Description copied from interface:ItemReturns the effective boolean value of the item, if atomic.- Returns:
- the effective boolean value.
-
getStringValue
Description copied from interface:ItemReturns the string value of the item, if it is an atomic item.- Returns:
- the string value.
-
parent
Description copied from interface:ItemXDM 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." -
getDynamicType
Description copied from interface:ItemReturns the dynamic type of the item (only for error message purposes).- Returns:
- the dynamic type as an item type.
-
isNode
public boolean isNode()Description copied from interface:ItemTests whether the item is an XML node.- Returns:
- true if it is an XML node, false otherwise.
-
isTextNode
public boolean isTextNode() -
nodeName
Description copied from interface:ItemXDM 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, ornullwhen the accessor yields the empty sequence
-
nodeKind
XDM 3.1 Section 6.7 Text Node Accessors — node-kind. "For a Text Node, dm:node-kind returns the string \"text\"." -
attributes
XDM 3.1 Section 6.7 Text Node Accessors — attributes. "For a Text Node, dm:attributes returns the empty sequence." -
children
XDM 3.1 Section 6.7 Text Node Accessors — children. "For a Text Node, dm:children returns the empty sequence." -
atomizedValue
Description copied from interface:ItemXDM 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(). -
namespaceNodes
Description copied from interface:ItemXDM 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. -
declaredNamespaceNodes
Description copied from interface:ItemHelper 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. -
baseUri
XDM 3.1 Section 6.7 Text Node Accessors — base-uri. For a Text Node, dm:base-uri returns the base URI of the parent node, if it has one; otherwise it returns the empty sequence. -
documentUri
XDM 3.1 Section 6.7 Text Node Accessors — document-uri. For a Text Node, dm:document-uri returns the document-uri of the document node that is the root of the tree containing the text node, if it has one; otherwise it returns the empty sequence. -
isId
public boolean isId()XDM 3.1 Section 6.7 Text Node Accessors — is-id. For a Text Node, dm:is-id returns false. -
isIdrefs
public boolean isIdrefs()XDM 3.1 Section 6.7 Text Node Accessors — is-idrefs. For a Text Node, dm:is-idrefs returns false. -
nilled
XDM 3.1 Section 6.7 Text Node Accessors — nilled. For a Text Node, dm:nilled returns the empty sequence. -
typeName
XDM 3.1 Section 6.7 Text Node Accessors — type-name: For a Text Node, dm:type-name returns xs:untypedAtomic.
-