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.
The attributes as a mapping from EName
s (instead of QName
s) to values.
Resolved name of the element, as EName
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 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 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 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 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 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)))
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
.
The local name (or local part).
API and implementation trait for elements as containers of elements, each having a name and possible attributes. This trait extends trait ParentElemLike, adding knowledge about names of elements and of attributes.
Most users of the yaidom API do not use this trait directly, so may skip the documentation of this trait.
Example usage (where the
text
method is not offered by theElemLike
API itself, but by traitHasText
instead):Above, shorthand operator notation is used for querying child elements and descendant-or-self elements.
bookstoreElm \ (_.localName == "Book")
is equivalent to:
bookstoreElm filterChildElems { _.localName == "Book" }
Moreover:
cheapBookElm \\ (_.localName == "Author")
is equivalent to:
cheapBookElm filterElemsOrSelf { _.localName == "Author" }
ElemLike methods
This trait adds the following abstract methods to the abstract methods required by its supertrait:
resolvedName
andresolvedAttributes
. Based on these abstract methods (and the supertrait), this trait offers a rich API for querying elements by (expanded) name, and for querying attributes.This trait only knows about elements, not about nodes in general. Hence this trait has no knowledge about child nodes in general. Hence the single type parameter, for the captured element type itself.
The element query methods that need no knowledge about element names and attributes are implemented by supertrait ParentElemLike.
This trait adds the following groups of methods to the methods offered by the supertrait
ParentElemLike
:EName
or local name (which trivially correspond to method calls in the supertrait)Obviously, this API does not offer much to the parent trait API. After all, the element query methods taking a local name or expanded name are only syntactic sugar for specific calls to the corresponding
ParentElemLike
methods taking an element predicate. Had we defined implicit conversions from local/expanded names to element predicates, most of this API would have been superfluous. On the other hand, the currentElemLike
API, which requires no implicits, is trivial to use.The captured element subtype