eu.cdevreeze.yaidom

PathAwareElemApi

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

API for elements as containers of elements, each having a name and possible attributes, as well as an "element path" from the root element. See PathAwareElemLike.

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

E

The captured element subtype

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

Abstract Value Members

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

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

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

    Definition Classes
    ElemApi

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

    Shorthand for filterChildElems(expandedName).

    Shorthand for filterChildElems(expandedName).

    Definition Classes
    ElemApi

  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)

    Shorthand for findAttribute(localName)

    Definition Classes
    ElemApi

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

    Shorthand for attributeOption(expandedName)

    Shorthand for attributeOption(expandedName)

    Definition Classes
    ElemApi

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

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

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

    Definition Classes
    ElemApi

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

    Shorthand for filterElemsOrSelf(expandedName).

    Shorthand for filterElemsOrSelf(expandedName).

    Definition Classes
    ElemApi

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

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

    Definition Classes
    ElemApi

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

    Shorthand for findTopmostElemsOrSelf(expandedName).

    Shorthand for findTopmostElemsOrSelf(expandedName).

    Definition Classes
    ElemApi

  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 allChildElemPathEntries: IndexedSeq[Entry]

    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 allChildElemsWithPathEntries map { _._2 }.

  13. abstract def allChildElemPaths: IndexedSeq[ElemPath]

    Returns allChildElemsWithPathEntries map { case (e, pe) => ElemPath.from(pe) }

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

  15. abstract def allChildElemsWithPathEntries: IndexedSeq[(E, Entry)]

    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: (allChildElemsWithPathEntries map (_._1)) == allChildElems

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

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

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

    Returns allChildElems collect pf

    Returns allChildElems collect pf

    Definition Classes
    ParentElemApi

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

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

  21. abstract def filterChildElemPaths(p: (E) ⇒ Boolean): IndexedSeq[ElemPath]

    Returns the paths of child elements obeying the given predicate

  22. abstract 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
    ElemApi

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

  24. abstract def filterElemOrSelfPaths(p: (E) ⇒ Boolean): IndexedSeq[ElemPath]

    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.

  25. abstract def filterElemPaths(p: (E) ⇒ Boolean): IndexedSeq[ElemPath]

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

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

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

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

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

  30. abstract def findAllElemOrSelfPaths: IndexedSeq[ElemPath]

    Returns the path of this element followed by the paths of all descendant elements (that is, the descendant-or-self elements)

  31. abstract def findAllElemPaths: IndexedSeq[ElemPath]

    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)

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

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

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

    Definition Classes
    ElemApi

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

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

  37. abstract def findChildElemPath(p: (E) ⇒ Boolean): Option[ElemPath]

    Returns the path of the first found child element obeying the given predicate, if any, wrapped in an Option

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

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

    Definition Classes
    ElemApi

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

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

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

    Definition Classes
    ElemApi

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

  42. abstract def findElemOrSelfPath(p: (E) ⇒ Boolean): Option[ElemPath]

    Returns the path of the first found (topmost) descendant-or-self element obeying the given predicate, if any, wrapped in an Option

  43. abstract def findElemPath(p: (E) ⇒ Boolean): Option[ElemPath]

    Returns the path of the first found (topmost) descendant element obeying the given predicate, if any, wrapped in an Option

  44. abstract def findTopmostElemOrSelfPaths(p: (E) ⇒ Boolean): IndexedSeq[ElemPath]

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

  45. abstract def findTopmostElemPaths(p: (E) ⇒ Boolean): IndexedSeq[ElemPath]

    Returns the paths of the descendant elements obeying the given predicate that have no ancestor obeying the predicate

  46. abstract 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
    ElemApi

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

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

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

    Definition Classes
    ElemApi

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

  50. abstract def findWithElemPath(path: ElemPath): Option[E]

    Finds the element with the given ElemPath (where this element is the root), if any, wrapped in an Option.

  51. abstract def findWithElemPathEntry(entry: Entry): Option[E]

    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.

  52. abstract 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
    ElemApi

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

  54. abstract def getChildElemPath(p: (E) ⇒ Boolean): ElemPath

    Returns the path of the single child element obeying the given predicate, and throws an exception otherwise

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

  56. abstract def getWithElemPath(path: ElemPath): E

    Returns (the equivalent of) findWithElemPath(path).get

  57. abstract def localName: String

    The local name (or local part).

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

    Definition Classes
    ElemApi

  58. 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
    ElemApi

  59. abstract def resolvedName: EName

    Resolved name of the element, as EName

    Resolved name of the element, as EName

    Definition Classes
    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 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 ElemApi[E]

Inherited from ParentElemApi[E]

Inherited from AnyRef

Inherited from Any