eu.cdevreeze.yaidom

PathAwareElemLike

trait PathAwareElemLike[E <: PathAwareElemLike[E]] extends ElemLike[E] with PathAwareElemApi[E]

API and implementation trait for elements as containers of elements, each having a name and possible attributes, as well as having awareness of element paths. This trait extends trait eu.cdevreeze.yaidom.ElemLike, adding knowledge about element paths.

More precisely, this trait adds the following abstract methods to the abstract methods required by its super-trait: findAllChildElemsWithPathEntries and findWithElemPathEntry. Based on these abstract methods (and the super-trait), this trait offers a rich API for querying elements and element paths.

The purely abstract API offered by this trait is eu.cdevreeze.yaidom.PathAwareElemApi. See the documentation of that trait for examples of usage, and for a more formal treatment.

E

The captured element subtype

Self Type
E
Linear Supertypes
PathAwareElemApi[E], ElemLike[E], ElemApi[E], ParentElemLike[E], ParentElemApi[E], AnyRef, Any
Known Subclasses
Elem, Elem, UpdatableElemLike
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. PathAwareElemLike
  2. PathAwareElemApi
  3. ElemLike
  4. ElemApi
  5. ParentElemLike
  6. ParentElemApi
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def findAllChildElems: IndexedSeq[E]

    Core method that returns all child elements, in the correct order.

    Core method that returns all child elements, in the correct order. Other operations can be defined in terms of this one.

    Definition Classes
    ParentElemLike → ParentElemApi

  2. abstract def findAllChildElemsWithPathEntries: 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: (findAllChildElemsWithPathEntries map (_._1)) == findAllChildElems

    Definition Classes
    PathAwareElemLike → PathAwareElemApi

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

    Definition Classes
    PathAwareElemLike → PathAwareElemApi

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

    Namespace declarations are not considered attributes in yaidom, so are not included in the result.

    Definition Classes
    ElemLike → ElemApi

  5. 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 \(expandedName: EName): IndexedSeq[E]

    Shorthand for filterChildElems(expandedName).

    Shorthand for filterChildElems(expandedName).

    Definition Classes
    ElemLike → ElemApi

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

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

    Shorthand for attributeOption(expandedName)

    Shorthand for attributeOption(expandedName)

    Definition Classes
    ElemLike → ElemApi

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

    Shorthand for filterElemsOrSelf(expandedName).

    Shorthand for filterElemsOrSelf(expandedName).

    Definition Classes
    ElemLike → ElemApi

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

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

    Shorthand for findTopmostElemsOrSelf(expandedName).

    Shorthand for findTopmostElemsOrSelf(expandedName).

    Definition Classes
    ElemLike → ElemApi

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

  13. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

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

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

  16. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  18. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  19. final def filterChildElemPaths(p: (E) ⇒ Boolean): IndexedSeq[ElemPath]

    Returns the paths of child elements obeying the given predicate

    Returns the paths of child elements obeying the given predicate

    Definition Classes
    PathAwareElemLike → PathAwareElemApi

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

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

    Returns the child elements obeying the given predicate.

    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)
    Definition Classes
    ParentElemLike → ParentElemApi

  22. final 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.

    Definition Classes
    PathAwareElemLike → PathAwareElemApi

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

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

    Definition Classes
    PathAwareElemLike → PathAwareElemApi

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

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

    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))
    Definition Classes
    ParentElemLike → ParentElemApi

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

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

    Returns the descendant-or-self elements obeying the given predicate.

    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.

    Definition Classes
    ParentElemLike → ParentElemApi

  28. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  29. final def findAllChildElemPathEntries: 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 findAllChildElemsWithPathEntries map { _._2 }.

    Definition Classes
    PathAwareElemLike → PathAwareElemApi

  30. final def findAllChildElemPaths: IndexedSeq[ElemPath]

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

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

    Definition Classes
    PathAwareElemLike → PathAwareElemApi

  31. final 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)

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

    Definition Classes
    PathAwareElemLike → PathAwareElemApi

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

    Definition Classes
    PathAwareElemLike → PathAwareElemApi

  33. final def findAllElems: IndexedSeq[E]

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

    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). This method could be defined as filterElemsOrSelf { e => true }.

    Definition Classes
    ParentElemLike → ParentElemApi

  35. final def findAttributeByLocalName(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. This method could be defined as filterChildElems(p).headOption.

    Definition Classes
    ParentElemLike → ParentElemApi

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

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

    Definition Classes
    PathAwareElemLike → PathAwareElemApi

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

  40. 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. This method could be defined as filterElems(p).headOption.

    Definition Classes
    ParentElemLike → ParentElemApi

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

  42. 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. This method could be defined as filterElemsOrSelf(p).headOption.

    Definition Classes
    ParentElemLike → ParentElemApi

  43. final 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

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

    Definition Classes
    PathAwareElemLike → PathAwareElemApi

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

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

    Definition Classes
    PathAwareElemLike → PathAwareElemApi

  45. final 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.

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

    Definition Classes
    PathAwareElemLike → PathAwareElemApi

  46. final 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

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

    Definition Classes
    PathAwareElemLike → PathAwareElemApi

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

  48. 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. This method could be defined as:

    this.findAllChildElems flatMap (_.findTopmostElemsOrSelf(p))
    Definition Classes
    ParentElemLike → ParentElemApi

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

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

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

    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)))
    Definition Classes
    ParentElemLike → ParentElemApi

  51. final 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.

    Finds the element with the given ElemPath (where this element is the root), if any, wrapped in an Option. This method must be very efficient, which depends on the efficiency of method findWithElemPathEntry.

    Definition Classes
    PathAwareElemLike → PathAwareElemApi

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

  53. 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. This method could be defined as findChildElem(p).get.

    Definition Classes
    ParentElemLike → ParentElemApi

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

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

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

    Definition Classes
    PathAwareElemLike → PathAwareElemApi

  55. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

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

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

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

    Definition Classes
    PathAwareElemLike → PathAwareElemApi

  57. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  58. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  59. final def localName: String

    The local name (or local part).

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

    Definition Classes
    ElemLike → ElemApi

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

    Definition Classes
    AnyRef

  61. final def notify(): Unit

    Definition Classes
    AnyRef

  62. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  64. def toString(): String

    Definition Classes
    AnyRef → Any

  65. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from PathAwareElemApi[E]

Inherited from ElemLike[E]

Inherited from ElemApi[E]

Inherited from ParentElemLike[E]

Inherited from ParentElemApi[E]

Inherited from AnyRef

Inherited from Any

Ungrouped