Shorthand for filterChildElems(expandedName).
Shorthand for filterChildElems(p).
Shorthand for filterChildElems(p). Use this shorthand only if the predicate is a short expression.
Shorthand for attributeOption(expandedName)
Shorthand for filterElemsOrSelf(expandedName).
Shorthand for filterElemsOrSelf(p).
Shorthand for filterElemsOrSelf(p). Use this shorthand only if the predicate is a short expression.
Shorthand for findTopmostElemsOrSelf(expandedName).
Shorthand for findTopmostElemsOrSelf(p).
Shorthand for findTopmostElemsOrSelf(p). Use this shorthand only if the predicate is a short expression.
Returns the value of the attribute with the given expanded name, and throws an exception otherwise
Returns the value of the attribute with the given expanded name, if any, wrapped in an Option
The attribute Scope, which is the same Scope but without the default namespace (which is not used for attributes)
Returns the child node index of the given ElemPath.Entry with respect to this element as parent element.
Returns the child node index of the given ElemPath.Entry with respect to this element as parent element.
If the path entry is not found, -1 is returned.
Methods updated (taking ElemPaths) heavily use this method to turn ElemPaths into child node indexes.
This method should therefore be very fast (preferably using a cache from ElemPath.Entry instances to indexes).
Returns the child nodes of this element, in the correct order
Returns the child nodes of this element, in the correct order
Returns the comment children
Returns the paths of child elements obeying the given predicate
Returns the paths of child elements obeying the given predicate
Returns the child elements with the given expanded name
Core method that returns the child elements obeying the given predicate.
Core method that returns the child elements obeying the given predicate. This method could be defined as:
def filterChildElems(p: E => Boolean): immutable.IndexedSeq[E] = this.findAllChildElems.filter(p)
Returns the paths of descendant-or-self elements that obey the given predicate.
Returns the paths of descendant-or-self elements that obey the given predicate.
That is, the result is equivalent to the paths of findAllElemsOrSelf filter p.
Returns the paths of descendant elements obeying the given predicate, that is, the paths of findAllElems filter p
Returns the paths of descendant elements obeying the given predicate, that is, the paths of findAllElems filter p
Returns the descendant elements with the given expanded name
Returns the descendant elements obeying the given predicate.
Returns the descendant elements obeying the given predicate. This method could be defined as:
this.findAllChildElems flatMap (_.filterElemsOrSelf(p))Returns the descendant-or-self elements that have the given expanded name
Core method that returns the descendant-or-self elements obeying the given predicate.
Core method that returns the descendant-or-self elements obeying the given predicate. This method could be defined as:
def filterElemsOrSelf(p: E => Boolean): immutable.IndexedSeq[E] = Vector(this).filter(p) ++ (this.findAllChildElems flatMap (_.filterElemsOrSelf(p)))
It can be proven that the result is equivalent to findAllElemsOrSelf filter p.
Returns the ElemPath entries of all child elements, in the correct order.
Returns the ElemPath entries of all child elements, in the correct order.
Equivalent to findAllChildElemsWithPathEntries map { _._2 }.
Returns findAllChildElemsWithPathEntries map { case (e, pe) => ElemPath.from(pe) }
Returns findAllChildElemsWithPathEntries map { case (e, pe) => ElemPath.from(pe) }
Returns the element children
Returns the element children
Returns all child elements with their ElemPath entries, in the correct order.
Returns all child elements with their ElemPath entries, in the correct order.
The implementation must be such that the following holds: (findAllChildElemsWithPathEntries map (_._1)) == findAllChildElems
Returns the path of this element followed by the paths of all descendant elements (that is, the descendant-or-self elements)
Returns the path of this element followed by the paths of all descendant elements (that is, the descendant-or-self elements)
Returns the paths of all descendant elements (not including this element).
Returns the paths of all descendant elements (not including this element). Equivalent to findAllElemOrSelfPaths.drop(1)
Returns all descendant elements (not including this element).
Returns all descendant elements (not including this element). This method could be defined as filterElems { e => true }.
Equivalent to findAllElemsOrSelf.drop(1).
Returns this element followed by all descendant elements (that is, the descendant-or-self elements).
Returns this element followed by all descendant elements (that is, the descendant-or-self elements).
This method could be defined as filterElemsOrSelf { e => true }.
Returns the first found attribute value of an attribute with the given local name, if any, wrapped in an Option.
Returns the first found child element with the given expanded name, if any, wrapped in an Option
Returns the first found child element obeying the given predicate, if any, wrapped in an Option.
Returns the first found child element obeying the given predicate, if any, wrapped in an Option.
This method could be defined as filterChildElems(p).headOption.
Returns the path of the first found child element obeying the given predicate, if any, wrapped in an Option
Returns the path of the first found child element obeying the given predicate, if any, wrapped in an Option
Returns the first found (topmost) descendant element with the given expanded name, if any, wrapped in an Option
Returns the first found (topmost) descendant element obeying the given predicate, if any, wrapped in an Option.
Returns the first found (topmost) descendant element obeying the given predicate, if any, wrapped in an Option.
This method could be defined as filterElems(p).headOption.
Returns the first found (topmost) descendant-or-self element with the given expanded name, if any, wrapped in an Option
Returns the first found (topmost) descendant-or-self element obeying the given predicate, if any, wrapped in an Option.
Returns the first found (topmost) descendant-or-self element obeying the given predicate, if any, wrapped in an Option.
This method could be defined as filterElemsOrSelf(p).headOption.
Returns the path of the first found (topmost) descendant-or-self element obeying the given predicate, if any, wrapped in an Option
Returns the path of the first found (topmost) descendant-or-self element obeying the given predicate, if any, wrapped in an Option
Returns the path of the first found (topmost) descendant element obeying the given predicate, if any, wrapped in an Option
Returns the path of the first found (topmost) descendant element obeying the given predicate, if any, wrapped in an Option
Returns the paths of the descendant-or-self elements that obey the given predicate, such that no ancestor obeys the predicate.
Returns the paths of the descendant-or-self elements that obey the given predicate, such that no ancestor obeys the predicate.
Returns the paths of the descendant elements obeying the given predicate that have no ancestor obeying the predicate
Returns the paths of the descendant elements obeying the given predicate that have no ancestor obeying the predicate
Returns the descendant elements with the given expanded name that have no ancestor with the same name
Returns the descendant elements obeying the given predicate that have no ancestor obeying the predicate.
Returns the descendant elements obeying the given predicate that have no ancestor obeying the predicate. This method could be defined as:
this.findAllChildElems flatMap (_.findTopmostElemsOrSelf(p))Returns the descendant-or-self elements with the given expanded name that have no ancestor with the same name
Core method that returns the descendant-or-self elements obeying the given predicate, such that no ancestor obeys the predicate.
Core method that returns the descendant-or-self elements obeying the given predicate, such that no ancestor obeys the predicate. This method could be defined as:
def findTopmostElemsOrSelf(p: E => Boolean): immutable.IndexedSeq[E] = if (p(this)) Vector(this) else (this.findAllChildElems flatMap (_.findTopmostElemsOrSelf(p)))
Finds the element with the given ElemPath (where this element is the root), if any, wrapped in an Option.
Finds the element with the given ElemPath (where this element is the root), if any, wrapped in an Option.
This method must be very efficient, which depends on the efficiency of method findWithElemPathEntry.
Returns the equivalent of findWithElemPath(ElemPath(immutable.IndexedSeq(entry))), but it should be very efficient.
Returns the equivalent of findWithElemPath(ElemPath(immutable.IndexedSeq(entry))), but it should be very efficient.
Indeed, it is function findWithElemPath that is defined in terms of this function, findWithElemPathEntry, and not
the other way around.
Returns the single child element with the given expanded name, and throws an exception otherwise
Returns the single child element obeying the given predicate, and throws an exception otherwise.
Returns the single child element obeying the given predicate, and throws an exception otherwise.
This method could be defined as findChildElem(p).get.
Returns the path of the single child element obeying the given predicate, and throws an exception otherwise
Returns the path of the single child element obeying the given predicate, and throws an exception otherwise
Returns (the equivalent of) findWithElemPath(path).get
Returns (the equivalent of) findWithElemPath(path).get
The local name (or local part).
Functionally removes the given attribute, if present.
Functionally removes the given attribute, if present.
More precisely, returns withAttributes(self.attributes filterNot (_._1 == attributeName)).
Returns a copy in which the child at the given position (0-based) has been removed
Returns a copy in which the child at the given position (0-based) has been removed
Returns XmlStringUtils.normalizeString(text).
Returns XmlStringUtils.normalizeString(text).
Returns an "equivalent" Elem in which the implicit namespace declarations throughout the tree do not contain any
prefixed namespace undeclarations, given the passed parent scope.
Returns an "equivalent" Elem in which the implicit namespace declarations throughout the tree do not contain any
prefixed namespace undeclarations, given the passed parent scope. Note that XML 1.0 does not allow prefix undeclarations.
Functionally adds or updates the given attribute.
Functionally adds or updates the given attribute.
More precisely, if an attribute with the same name exists at position idx (0-based),
withAttributes(attributes.updated(idx, (attributeName -> attributeValue))) is returned.
Otherwise, withAttributes(attributes :+ (attributeName -> attributeValue)) is returned.
Functionally adds or updates the given attribute, if a value is given.
Functionally adds or updates the given attribute, if a value is given.
That is, returns if (attributeValueOption.isEmpty) self else plusAttribute(attributeName, attributeValueOption.get).
Returns a copy in which the given child has been inserted at the end
Returns a copy in which the given child has been inserted at the end
Returns a copy in which the given child has been inserted at the given position (0-based)
Returns a copy in which the given child has been inserted at the given position (0-based)
"Prettifies" this Elem.
"Prettifies" this Elem. That is, first calls method removeAllInterElementWhitespace, and then transforms the result
by inserting text nodes with newlines and whitespace for indentation.
Returns the processing instruction children
Returns a copy where inter-element whitespace has been removed, throughout the node tree
The attributes as an ordered mapping from ENames (instead of QNames) to values, obtained by resolving attribute QNames against the attribute scope
The Elem name as EName, obtained by resolving the element QName against the Scope
Returns the concatenation of the texts of text children, including whitespace and CData.
Returns the text children
Returns the tree representation string corresponding to this element, that is, toTreeRepr.
Returns the tree representation string corresponding to this element, that is, toTreeRepr.
Possibly expensive, especially for large XML trees! Note that the toString method is often called implicitly,
for example in logging statements. So, if the toString method is not used carefully, OutOfMemoryErrors may occur.
Same as toTreeRepr(emptyScope)
Same as toTreeRepr(emptyScope)
Returns the tree representation String, conforming to the tree representation DSL that creates NodeBuilders.
Returns the tree representation String, conforming to the tree representation DSL that creates NodeBuilders.
That is, it does not correspond to the tree representation DSL of Nodes, but of NodeBuilders!
There are a couple of advantages of this method compared to some "toXmlString" method which returns the XML string:
toTreeRepr clearly corresponds to a NodeBuilder, and can indeed be parsed into onetoTreeRepr output is even valid Scala codeNodeBuilder, the following is out of scope: character escaping (for XML), entity resolving, "ignorable" whitespace handling, etc.Functionally updates the topmost descendant-or-self elements for which the partial function is defined, within the tree of which this element is the root element.
Functionally updates the topmost descendant-or-self elements for which the partial function is defined, within the tree of which this element is the root element.
This function is equivalent to:
val p = { e: E => pf.isDefinedAt(e) } val pathsReversed = findTopmostElemOrSelfPaths(p).reverse pathsReversed.foldLeft(self) { case (acc, path) => val e = acc.findWithElemPath(path).get acc.updated(path, pf(e)) }
This can be an expensive function, partly because (repeatedly) finding elements by element paths can be expensive, and partly because many intermediate element objects may be created.
Returns text.trim.
Returns text.trim.
Functionally updates the descendant-or-self elements for which the partial function is defined, within the tree of which this element is the root element.
Functionally updates the descendant-or-self elements for which the partial function is defined, within the tree of which this element is the root element.
This function is equivalent to:
val p = { e: E => pf.isDefinedAt(e) } val pathsReversed = filterElemOrSelfPaths(p).reverse pathsReversed.foldLeft(self) { case (acc, path) => val e = acc.findWithElemPath(path).get acc.updated(path, pf(e)) }
This can be an expensive function, partly because (repeatedly) finding elements by element paths can be expensive, and partly because many intermediate element objects may be created. Typically, when all elements must be "functionally updated" (so when the partial function is defined for all elements), it is better to do so by recursion, without using this function.
Returns updated(path) { e => newElem }
Returns updated(path) { e => newElem }
"Functionally updates" the tree with this element as root element, by applying the passed function to the element that has the given eu.cdevreeze.yaidom.ElemPath (compared to this element as root).
"Functionally updates" the tree with this element as root element, by applying the passed function to the element that has the given eu.cdevreeze.yaidom.ElemPath (compared to this element as root).
The method throws an exception if no element is found with the given path.
Creates a copy, but with the attributes passed as parameter newAttributes
Creates a copy, but with (only) the children passed as parameter newChildren
Creates a copy, but with (only) the children passed as parameter newChildren
Shorthand for withChildren(children.patch(from, newChildren, replace))
Shorthand for withChildren(children.patch(from, newChildren, replace))
Shorthand for withChildren(children.updated(index, newChild))
Shorthand for withChildren(children.updated(index, newChild))
Element node. An eu.cdevreeze.yaidom.Elem contains:
The eu.cdevreeze.yaidom.Scope is absolute, typically containing a lot more than the (implicit) eu.cdevreeze.yaidom.Declarations of this element.
Note that
Eleminstances are immutable, so they do not know about parent nodes. Moreover,Elems must be building blocks for larger (ancestor)Elems, and at the same time they must contain enough context for resolving element and attribute (un)qualified names. Therefore anElemcontains aScope, and not aDeclarations(whereas forElemBuilderit is the other way around). Once anElemtree is complete, the (implicit)Declarationsof the element areparentElm.scope.relativize(this.scope).Namespace declarations (and undeclarations) are not considered attributes in this API.
The API is geared towards data-oriented XML that uses namespaces, and that typically is described in schemas (so that the user of this API knows the structure of the XML being processed). The methods that return an Option say so in their name.
No notion of (value) equality has been defined. When thinking about it, it is very hard to come up with any useful notion of equality for representations of XML elements. Think about prefixes, "ignorable whitespace", DTDs and XSDs, etc.
Use the constructor with care, because it is easy to use incorrectly (regarding passed Scopes, causing implicit namespace undeclarations). To construct
Elems by hand, prefer using anElemBuilder, via methodNodeBuilder.elem. IfElems are still constructed manually (without usingElemBuilders), consider calling methodnotUndeclaringPrefixesafterwards, thus getting rid of unnecessary (implicit) namespace undeclarations. Typically, however,Elems are constructed by parsing an XML source.Example
Below follows an example. This example queries for all book elements having a price below 90. It can be written as follows, assuming a book store
Documentwith the appropriate structure:For more examples, see the eu.cdevreeze.yaidom package documentation.