eu.cdevreeze.yaidom

ElemApi

trait ElemApi[E <: ElemApi[E]] extends ParentElemApi[E]

API for elements as containers of elements, each having a name and possible attributes. See ElemLike.

This purely abstract query API trait leaves the implementation completely open. For example, an implementation backed by an XML database would not use the ElemLike implementation, for reasons of efficiency.

E

The captured element subtype

Self Type
E
Linear Supertypes
ParentElemApi[E], AnyRef, Any
Known Subclasses
DomElem, Elem, Elem, Elem, ElemLike, PathAwareElemApi, PathAwareElemLike, UpdatableElemApi, UpdatableElemLike
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. ElemApi
  2. ParentElemApi
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def \(localName: String): IndexedSeq[E]

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

  2. abstract def \(expandedName: EName): IndexedSeq[E]

    Shorthand for filterChildElems(expandedName).

  3. abstract 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
    ParentElemApi

  4. abstract def \@(localName: String): Option[String]

    Shorthand for findAttribute(localName)

  5. abstract def \@(expandedName: EName): Option[String]

    Shorthand for attributeOption(expandedName)

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

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

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

    Shorthand for filterElemsOrSelf(expandedName).

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

  9. abstract def \\!(localName: String): IndexedSeq[E]

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

  10. abstract def \\!(expandedName: EName): IndexedSeq[E]

    Shorthand for findTopmostElemsOrSelf(expandedName).

  11. abstract 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
    ParentElemApi

  12. abstract def allChildElems: IndexedSeq[E]

    Returns all child elements, in the correct order.

    Returns all child elements, in the correct order.

    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
    ParentElemApi

  13. abstract def attribute(expandedName: EName): String

    Returns the value of the attribute with the given expanded name, and throws an exception otherwise

  14. abstract def attributeOption(expandedName: EName): Option[String]

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

  15. abstract def collectFromChildElems[B](pf: PartialFunction[E, B]): IndexedSeq[B]

    Returns allChildElems collect pf

    Returns allChildElems collect pf

    Definition Classes
    ParentElemApi

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

  17. abstract 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
    ParentElemApi

  18. abstract def filterChildElems(expandedName: EName): IndexedSeq[E]

    Returns the child elements with the given expanded name

  19. abstract 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
    ParentElemApi

  20. abstract def filterElems(expandedName: EName): IndexedSeq[E]

    Returns the descendant elements with the given expanded name

  21. abstract 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
    ParentElemApi

  22. abstract def filterElemsOrSelf(expandedName: EName): IndexedSeq[E]

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

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

  24. abstract 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
    ParentElemApi

  25. abstract 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
    ParentElemApi

  26. abstract 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.

  27. abstract def findChildElem(expandedName: EName): Option[E]

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

  28. abstract 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
    ParentElemApi

  29. abstract def findElem(expandedName: EName): Option[E]

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

  30. abstract 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
    ParentElemApi

  31. abstract 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

  32. abstract 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
    ParentElemApi

  33. abstract def findTopmostElems(expandedName: EName): IndexedSeq[E]

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

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

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

  36. abstract 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
    ParentElemApi

  37. abstract def getChildElem(expandedName: EName): E

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

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

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

  40. abstract def localName: String

    The local name (or local part).

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

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

  42. abstract def resolvedName: EName

    Resolved name of the element, as EName

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 asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  18. def toString(): String

    Definition Classes
    AnyRef → Any

  19. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from ParentElemApi[E]

Inherited from AnyRef

Inherited from Any