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 all child elements, in the correct order.
Returns all child elements, in the correct order. Other operations can be defined in terms of this one.
Returns all child elements with their ElemPath entries, in the correct order.
Returns all child elements with their ElemPath entries, in the correct order. This method should be very efficient.
The implementation must be such that the following holds: (findAllChildElemsWithPathEntries map (_._1)) == findAllChildElems
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.
The attributes as a mapping from ENames (instead of QNames) to values.
Resolved name of the element, as EName
Returns an element with the same name, attributes and scope as this element, but with the given child nodes
Returns an element with the same name, attributes and scope as this element, but with the given child nodes
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
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 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 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).
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 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)
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.
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.
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))
"Updatable" element. It defines a contract for "functional updates".
Most users of the yaidom API do not use this trait directly, so may skip the documentation of this trait.
This trait is a sub-trait of eu.cdevreeze.yaidom.PathAwareElemLike. It adds a type parameter for (arbitrary) nodes. It also requires concrete implementations for abstract methods
children,withChildrenandchildNodeIndex. Based on these 4 methods, and super-traitPathAwareElemLike, this trait offers a reasonably rich API for "functionally updating" elements.This trait adds the following groups of methods to the methods offered by the supertrait
PathAwareElemLike:ElemPathIt is important that the abstract methods are mutually consistent in their implementations. For example, the following equality must hold (for some concrete class
Ethat mixes in this trait):e.findAllChildElems == (e.children collect { case e: E => e })The node supertype of the element subtype
The captured element subtype