eu.cdevreeze.yaidom

ElemLike

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

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:

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
ElemApi[E], ParentElemLike[E], ParentElemApi[E], AnyRef, Any
Known Subclasses
DomElem, Elem, Elem, Elem, PathAwareElemLike, UpdatableElemLike
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. ElemLike
  2. ElemApi
  3. ParentElemLike
  4. ParentElemApi
  5. AnyRef
  6. Any
Visibility
  1. Public
  2. All

Abstract Value Members

  1. 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 ParentElemLike methods will be.

    Note that this method is named "allChildElems" instead of "findAllChildElems". The latter name would be more consistent with the rest of this API, but the chosen name illustrates that allChildElems is seen more as "data" than as a "computation".

    Definition Classes
    ParentElemLike → ParentElemApi

  2. abstract def resolvedAttributes: Iterable[(EName, String)]

    The attributes as a mapping from ENames (instead of QNames) to values.

    The attributes as a mapping from ENames (instead of QNames) to values.

    The implementation must ensure that resolvedAttributes.toMap.size == resolvedAttributes.size.

    Definition Classes
    ElemLike → ElemApi

  3. abstract def resolvedName: EName

    Resolved name of the element, as EName

    Resolved name of the element, as EName

    Definition Classes
    ElemLike → ElemApi

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

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

    Shorthand for filterChildElems { _.localName == localName }.

    Shorthand for filterChildElems { _.localName == localName }.

    Definition Classes
    ElemLike → ElemApi

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

    Shorthand for filterChildElems(expandedName).

    Shorthand for filterChildElems(expandedName).

    Definition Classes
    ElemLike → ElemApi

  8. 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 → ParentElemApi

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

    Shorthand for findAttribute(localName)

    Shorthand for findAttribute(localName)

    Definition Classes
    ElemLike → ElemApi

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

    Shorthand for attributeOption(expandedName)

    Shorthand for attributeOption(expandedName)

    Definition Classes
    ElemLike → ElemApi

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

    Shorthand for filterElemsOrSelf { _.localName == localName }.

    Shorthand for filterElemsOrSelf { _.localName == localName }.

    Definition Classes
    ElemLike → ElemApi

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

    Shorthand for filterElemsOrSelf(expandedName).

    Shorthand for filterElemsOrSelf(expandedName).

    Definition Classes
    ElemLike → ElemApi

  13. 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 → ParentElemApi

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

    Shorthand for findTopmostElemsOrSelf { _.localName == localName }.

    Shorthand for findTopmostElemsOrSelf { _.localName == localName }.

    Definition Classes
    ElemLike → ElemApi

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

    Shorthand for findTopmostElemsOrSelf(expandedName).

    Shorthand for findTopmostElemsOrSelf(expandedName).

    Definition Classes
    ElemLike → ElemApi

  16. 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 → ParentElemApi

  17. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  18. final def attribute(expandedName: EName): String

    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, and throws an exception otherwise

    Definition Classes
    ElemLike → ElemApi

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

    Returns the value of the attribute with the given expanded name, if any, wrapped in an Option

    Returns the value of the attribute with the given expanded name, if any, wrapped in an Option

    Definition Classes
    ElemLike → ElemApi

  20. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Returns allChildElems collect pf

    Returns allChildElems collect pf

    Definition Classes
    ParentElemLike → ParentElemApi

  22. 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 → ParentElemApi

  23. 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 → ParentElemApi

  24. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  25. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

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

    Returns the child elements with the given expanded name

    Returns the child elements with the given expanded name

    Definition Classes
    ElemLike → ElemApi

  27. 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 → ParentElemApi

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

    Returns the descendant elements with the given expanded name

    Returns the descendant elements with the given expanded name

    Definition Classes
    ElemLike → ElemApi

  29. 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 → ParentElemApi

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

    Returns the descendant-or-self elements that have the given expanded name

    Returns the descendant-or-self elements that have the given expanded name

    Definition Classes
    ElemLike → ElemApi

  31. 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 → ParentElemApi

  32. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  33. 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 → ParentElemApi

  34. 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 → ParentElemApi

  35. 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.

    Definition Classes
    ElemLike → ElemApi

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

    Returns the first found child element with the given expanded name, if any, wrapped in an Option

    Returns the first found child element with the given expanded name, if any, wrapped in an Option

    Definition Classes
    ElemLike → ElemApi

  37. 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 → ParentElemApi

  38. 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

    Returns the first found (topmost) descendant element with the given expanded name, if any, wrapped in an Option

    Definition Classes
    ElemLike → ElemApi

  39. 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 → ParentElemApi

  40. 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

    Returns the first found (topmost) descendant-or-self element with the given expanded name, if any, wrapped in an Option

    Definition Classes
    ElemLike → ElemApi

  41. 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 → ParentElemApi

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

    Returns the descendant elements with the given expanded name that have no ancestor with the same name

    Returns the descendant elements with the given expanded name that have no ancestor with the same name

    Definition Classes
    ElemLike → ElemApi

  43. 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 → ParentElemApi

  44. 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

    Returns the descendant-or-self elements with the given expanded name that have no ancestor with the same name

    Definition Classes
    ElemLike → ElemApi

  45. 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 → ParentElemApi

  46. final def getChildElem(expandedName: EName): E

    Returns the single child element with the given expanded name, and throws an exception otherwise

    Returns the single child element with the given expanded name, and throws an exception otherwise

    Definition Classes
    ElemLike → ElemApi

  47. 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 → ParentElemApi

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

    Definition Classes
    AnyRef → Any

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

    Computes an index on the given function taking an element, that is, returns findAllElemsOrSelf groupBy f.

    Computes an index on the given function taking an element, that is, returns findAllElemsOrSelf groupBy f.

    Definition Classes
    ParentElemLike → ParentElemApi

  50. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  51. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  52. final def localName: String

    The local name (or local part).

    The local name (or local part). Convenience method.

    Definition Classes
    ElemLike → ElemApi

  53. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  54. final def notify(): Unit

    Definition Classes
    AnyRef

  55. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  57. def toString(): String

    Definition Classes
    AnyRef → Any

  58. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

  60. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from ElemApi[E]

Inherited from ParentElemLike[E]

Inherited from ParentElemApi[E]

Inherited from AnyRef

Inherited from Any