eu.cdevreeze.yaidom.ElemLike

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 the ElemLike API itself, but by trait HasText instead):

val bookstoreElm = doc.documentElement
require(bookstoreElm.localName == "Bookstore")

val cheapBookElms =
  for {
    bookElm <- bookstoreElm \ "Book"
    price = bookElm.attribute(EName("Price"))
    if price.toInt < 90
  } yield bookElm

val cheapBookAuthors = {
  val result =
    for {
      cheapBookElm <- cheapBookElms
      authorElm <- cheapBookElm \\ "Author"
    } yield {
      val firstNameElmOption = authorElm findChildElem { _.localName == "First_Name" }
      val lastNameElmOption = authorElm findChildElem { _.localName == "Last_Name" }

      val firstName = firstNameElmOption.map(_.text).getOrElse("")
      val lastName = lastNameElmOption.map(_.text).getOrElse("")
      (firstName + " " + lastName).trim
    }

  result.toSet
}

Above, shorthand operator notation is used for querying child elements and descendant-or-self elements.

bookstoreElm \ "Book"

is equivalent to:

bookstoreElm filterChildElems { _.localName == "Book" }

Moreover:

cheapBookElm \\ "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 and resolvedAttributes. 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:

Attribute query methods
Element query methods taking an EName or local name (which trivially correspond to method calls in the supertrait)
A method to get the local name of the element, without the namespace

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 current ElemLike API, which requires no implicits, is trivial to use.

E: The captured element subtype

Self Type: E

Linear Supertypes

ParentElemLike[E], AnyRef, Any

Known Subclasses

DomElem, Elem, Elem, PathAwareElemLike, UpdatableElemLike

Abstract Value Members

abstract def allChildElems: IndexedSeq[E]

Returns all child elements, in the correct order.
Returns all child elements, in the correct order. The faster this method is, the faster the other ElemLike methods will be.

Definition Classes
ElemLike → ParentElemLike
abstract def resolvedAttributes: Map[EName, String]

The attributes as a Map from ENames (instead of QNames) to values
abstract def resolvedName: EName

Resolved name of the element, as EName

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def \(localName: String): IndexedSeq[E]

Shorthand for filterChildElems { _.localName == localName }.
final def \(expandedName: EName): IndexedSeq[E]

Shorthand for filterChildElems(expandedName).
final def \(p: (E) ⇒ Boolean): IndexedSeq[E]

Shorthand for filterChildElems(p).
Shorthand for filterChildElems(p). Use this shorthand only if the predicate is a short expression.

Definition Classes
ParentElemLike
final def \@(localName: String): Option[String]

Shorthand for findAttribute(localName)
final def \@(expandedName: EName): Option[String]

Shorthand for attributeOption(expandedName)
final def \\(localName: String): IndexedSeq[E]

Shorthand for filterElemsOrSelf { _.localName == localName }.
final def \\(expandedName: EName): IndexedSeq[E]

Shorthand for filterElemsOrSelf(expandedName).
final def \\(p: (E) ⇒ Boolean): IndexedSeq[E]

Shorthand for filterElemsOrSelf(p).
Shorthand for filterElemsOrSelf(p). Use this shorthand only if the predicate is a short expression.

Definition Classes
ParentElemLike
final def \\!(localName: String): IndexedSeq[E]

Shorthand for findTopmostElemsOrSelf { _.localName == localName }.
final def \\!(expandedName: EName): IndexedSeq[E]

Shorthand for findTopmostElemsOrSelf(expandedName).
final def \\!(p: (E) ⇒ Boolean): IndexedSeq[E]

Shorthand for findTopmostElemsOrSelf(p).
Shorthand for findTopmostElemsOrSelf(p). Use this shorthand only if the predicate is a short expression.

Definition Classes
ParentElemLike
final def asInstanceOf[T0]: T0

Definition Classes
Any
final def attribute(expandedName: EName): String

Returns the value of the attribute with the given expanded name, and throws an exception otherwise
final def attributeOption(expandedName: EName): Option[String]

Returns the value of the attribute with the given expanded name, if any, wrapped in an Option
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
final def collectFromChildElems[B](pf: PartialFunction[E, B]): IndexedSeq[B]

Returns allChildElems collect pf
Returns allChildElems collect pf

Definition Classes
ParentElemLike
final def collectFromElems[B](pf: PartialFunction[E, B]): IndexedSeq[B]

Returns (the equivalent of) findAllElems collect pf
Returns (the equivalent of) findAllElems collect pf

Definition Classes
ParentElemLike
final def collectFromElemsOrSelf[B](pf: PartialFunction[E, B]): IndexedSeq[B]

Returns (the equivalent of) findAllElemsOrSelf collect pf
Returns (the equivalent of) findAllElemsOrSelf collect pf

Definition Classes
ParentElemLike
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def filterChildElems(expandedName: EName): IndexedSeq[E]

Returns the child elements with the given expanded name
final def filterChildElems(p: (E) ⇒ Boolean): IndexedSeq[E]

Returns the child elements obeying the given predicate
Returns the child elements obeying the given predicate

Definition Classes
ParentElemLike
final def filterElems(expandedName: EName): IndexedSeq[E]

Returns the descendant elements with the given expanded name
final def filterElems(p: (E) ⇒ Boolean): IndexedSeq[E]

Returns the descendant elements obeying the given predicate, that is, findAllElems filter p
Returns the descendant elements obeying the given predicate, that is, findAllElems filter p

Definition Classes
ParentElemLike
final def filterElemsOrSelf(expandedName: EName): IndexedSeq[E]

Returns the descendant-or-self elements that have the given expanded name
final def filterElemsOrSelf(p: (E) ⇒ Boolean): IndexedSeq[E]

Returns the descendant-or-self elements that obey the given predicate.
Returns the descendant-or-self elements that obey the given predicate. That is, the result is equivalent to findAllElemsOrSelf filter p.

Definition Classes
ParentElemLike
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
final def findAllElems: IndexedSeq[E]

Returns all descendant elements (not including this element).
Returns all descendant elements (not including this element). Equivalent to findAllElemsOrSelf.drop(1)

Definition Classes
ParentElemLike
final def findAllElemsOrSelf: IndexedSeq[E]

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)

Definition Classes
ParentElemLike
final def findAttribute(localName: String): Option[String]

Returns the first found attribute value of an attribute with the given local name, if any, wrapped in an Option.
Returns the first found attribute value of an attribute with the given local name, if any, wrapped in an Option. Because of differing namespaces, it is possible that more than one such attribute exists, although this is not often the case.
final def findChildElem(expandedName: EName): Option[E]

Returns the first found child element with the given expanded name, if any, wrapped in an Option
final def findChildElem(p: (E) ⇒ Boolean): Option[E]

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

Definition Classes
ParentElemLike
final def findElem(expandedName: EName): Option[E]

Returns the first found (topmost) descendant element with the given expanded name, if any, wrapped in an Option
final def findElem(p: (E) ⇒ Boolean): Option[E]

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

Definition Classes
ParentElemLike
final def findElemOrSelf(expandedName: EName): Option[E]

Returns the first found (topmost) descendant-or-self element with the given expanded name, if any, wrapped in an Option
final def findElemOrSelf(p: (E) ⇒ Boolean): Option[E]

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

Definition Classes
ParentElemLike
final def findTopmostElems(expandedName: EName): IndexedSeq[E]

Returns the descendant elements with the given expanded name that have no ancestor with the same name
final def findTopmostElems(p: (E) ⇒ Boolean): IndexedSeq[E]

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

Definition Classes
ParentElemLike
final def findTopmostElemsOrSelf(expandedName: EName): IndexedSeq[E]

Returns the descendant-or-self elements with the given expanded name that have no ancestor with the same name
final def findTopmostElemsOrSelf(p: (E) ⇒ Boolean): IndexedSeq[E]

Returns the descendant-or-self elements that obey the given predicate, such that no ancestor obeys the predicate.
Returns the descendant-or-self elements that obey the given predicate, such that no ancestor obeys the predicate.

Definition Classes
ParentElemLike
final def getChildElem(expandedName: EName): E

Returns the single child element with the given expanded name, and throws an exception otherwise
final def getChildElem(p: (E) ⇒ Boolean): E

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

Definition Classes
ParentElemLike
final def getClass(): java.lang.Class[_]

Definition Classes
AnyRef → Any
final def getIndex[K](f: (E) ⇒ K): Map[K, IndexedSeq[E]]

Computes an index on the given function taking an element, for example a function returning some unique element "identifier"
Computes an index on the given function taking an element, for example a function returning some unique element "identifier"

Definition Classes
ParentElemLike
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def localName: String

The local name (or local part).
The local name (or local part). Convenience method.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws()

ElemLike

trait ElemLike[E <: ElemLike[E]] extends ParentElemLike[E]

ElemLike methods

Abstract Value Members

abstract def allChildElems: IndexedSeq[E]

abstract def resolvedAttributes: Map[EName, String]

abstract def resolvedName: EName

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def \(localName: String): IndexedSeq[E]

final def \(expandedName: EName): IndexedSeq[E]

final def \(p: (E) ⇒ Boolean): IndexedSeq[E]

final def \@(localName: String): Option[String]

final def \@(expandedName: EName): Option[String]

final def \\(localName: String): IndexedSeq[E]

final def \\(expandedName: EName): IndexedSeq[E]

final def \\(p: (E) ⇒ Boolean): IndexedSeq[E]

final def \\!(localName: String): IndexedSeq[E]

final def \\!(expandedName: EName): IndexedSeq[E]

final def \\!(p: (E) ⇒ Boolean): IndexedSeq[E]

final def asInstanceOf[T0]: T0

final def attribute(expandedName: EName): String

final def attributeOption(expandedName: EName): Option[String]

def clone(): AnyRef

final def collectFromChildElems[B](pf: PartialFunction[E, B]): IndexedSeq[B]

final def collectFromElems[B](pf: PartialFunction[E, B]): IndexedSeq[B]

final def collectFromElemsOrSelf[B](pf: PartialFunction[E, B]): IndexedSeq[B]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def filterChildElems(expandedName: EName): IndexedSeq[E]

final def filterChildElems(p: (E) ⇒ Boolean): IndexedSeq[E]

final def filterElems(expandedName: EName): IndexedSeq[E]

final def filterElems(p: (E) ⇒ Boolean): IndexedSeq[E]

final def filterElemsOrSelf(expandedName: EName): IndexedSeq[E]

final def filterElemsOrSelf(p: (E) ⇒ Boolean): IndexedSeq[E]

def finalize(): Unit

final def findAllElems: IndexedSeq[E]

final def findAllElemsOrSelf: IndexedSeq[E]

final def findAttribute(localName: String): Option[String]

final def findChildElem(expandedName: EName): Option[E]

final def findChildElem(p: (E) ⇒ Boolean): Option[E]

final def findElem(expandedName: EName): Option[E]

final def findElem(p: (E) ⇒ Boolean): Option[E]

final def findElemOrSelf(expandedName: EName): Option[E]

final def findElemOrSelf(p: (E) ⇒ Boolean): Option[E]

final def findTopmostElems(expandedName: EName): IndexedSeq[E]

final def findTopmostElems(p: (E) ⇒ Boolean): IndexedSeq[E]

final def findTopmostElemsOrSelf(expandedName: EName): IndexedSeq[E]

final def findTopmostElemsOrSelf(p: (E) ⇒ Boolean): IndexedSeq[E]

final def getChildElem(expandedName: EName): E

final def getChildElem(p: (E) ⇒ Boolean): E

final def getClass(): java.lang.Class[_]

final def getIndex[K](f: (E) ⇒ K): Map[K, IndexedSeq[E]]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def localName: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from ParentElemLike[E]

Inherited from AnyRef

Inherited from Any