eu.cdevreeze.yaidom.resolved

Elem

final case class Elem(resolvedName: EName, resolvedAttributes: Map[EName, String], children: IndexedSeq[Node]) extends Node with UpdatableElemLike[Node, Elem] with TransformableElemLike[Node, Elem] with HasText with Product with Serializable

Element as abstract data type. It contains only expanded names, not qualified names. This reminds of James Clark notation for XML trees and expanded names, where qualified names are absent.

See the documentation of the mixed-in query API trait(s) for more details on the uniform query API offered by this class.

Namespace declarations (and undeclarations) are not considered attributes in this API, just like in the rest of yaidom.

To illustrate equality comparisons in action, consider the following example yaidom Elem, named schemaElem1:

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://book" elementFormDefault="qualified">
  <xsd:element name="book">
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="isbn" type="xsd:string" />
        <xsd:element name="title" type="xsd:string" />
        <xsd:element name="authors" type="xsd:string" />
      </xsd:sequence>
    </xsd:complexType>
  </xsd:element>
</xsd:schema>

Now consider the following equivalent yaidom Elem, named schemaElem2, differing only in namespace prefixes, and in indentation:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://book" elementFormDefault="qualified">
    <xs:element name="book">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="isbn" type="xs:string" />
                <xs:element name="title" type="xs:string" />
                <xs:element name="authors" type="xs:string" />
            </xs:sequence>
        </xs:complexType>
    </xs:element>
</xs:schema>

These 2 XML trees can be considered equal, if we take indentation and namespace prefixes out of the equation. Note that namespace prefixes also occur in the "type" attributes! The following equality comparison returns true:

def replaceTypeAttributes(elem: Elem): Elem = {
  elem transformElemsOrSelf { e =>
    e.plusAttributeOption(QName("type"), e.attributeAsResolvedQNameOption(EName("type")).map(_.toString))
  }
}

resolved.Elem(replaceTypeAttributes(schemaElem1)).removeAllInterElementWhitespace ==
  resolved.Elem(replaceTypeAttributes(schemaElem2)).removeAllInterElementWhitespace
Self Type
Elem
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Elem
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. HasText
  7. TransformableElemLike
  8. TransformableElemApi
  9. UpdatableElemLike
  10. UpdatableElemApi
  11. PathAwareElemLike
  12. PathAwareElemApi
  13. ElemLike
  14. ElemApi
  15. ParentElemLike
  16. ParentElemApi
  17. Node
  18. Immutable
  19. AnyRef
  20. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Elem(resolvedName: EName, resolvedAttributes: Map[EName, String], children: IndexedSeq[Node])

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[Elem]

    Shorthand for filterChildElems(expandedName).

    Shorthand for filterChildElems(expandedName).

    Definition Classes
    ElemLikeElemApi
  7. final def \(p: (Elem) ⇒ Boolean): IndexedSeq[Elem]

    Shorthand for filterChildElems(p).

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

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

    Shorthand for attributeOption(expandedName)

    Shorthand for attributeOption(expandedName)

    Definition Classes
    ElemLikeElemApi
  9. final def \\(expandedName: EName): IndexedSeq[Elem]

    Shorthand for filterElemsOrSelf(expandedName).

    Shorthand for filterElemsOrSelf(expandedName).

    Definition Classes
    ElemLikeElemApi
  10. final def \\(p: (Elem) ⇒ Boolean): IndexedSeq[Elem]

    Shorthand for filterElemsOrSelf(p).

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

    Definition Classes
    ParentElemLikeParentElemApi
  11. final def \\!(expandedName: EName): IndexedSeq[Elem]

    Shorthand for findTopmostElemsOrSelf(expandedName).

    Shorthand for findTopmostElemsOrSelf(expandedName).

    Definition Classes
    ElemLikeElemApi
  12. final def \\!(p: (Elem) ⇒ Boolean): IndexedSeq[Elem]

    Shorthand for findTopmostElemsOrSelf(p).

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

    Definition Classes
    ParentElemLikeParentElemApi
  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
    ElemLikeElemApi
  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
    ElemLikeElemApi
  16. final def childNodeIndex(childPathEntry: Entry): Int

    Shorthand for childNodeIndexesByPathEntries.getOrElse(childPathEntry, -1).

    Shorthand for childNodeIndexesByPathEntries.getOrElse(childPathEntry, -1). The faster this method is, the better.

    Definition Classes
    UpdatableElemLikeUpdatableElemApi
  17. val childNodeIndexesByPathEntries: Map[Entry, Int]

    Cache for speeding up child element lookups by path

    Cache for speeding up child element lookups by path

    Definition Classes
    ElemUpdatableElemLikeUpdatableElemApi
  18. val children: IndexedSeq[Node]

    Returns the child nodes of this element, in the correct order

    Returns the child nodes of this element, in the correct order

    Definition Classes
    ElemUpdatableElemLikeUpdatableElemApi
  19. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  20. def coalesceAllAdjacentText: Elem

    Returns a copy where adjacent text nodes have been combined into one text node, throughout the node tree

  21. def coalesceAndNormalizeAllText: Elem

    Returns a copy where adjacent text nodes have been combined into one text node, and where all text is normalized, throughout the node tree.

    Returns a copy where adjacent text nodes have been combined into one text node, and where all text is normalized, throughout the node tree. Same as calling coalesceAllAdjacentText followed by normalizeAllText, but more efficient.

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

    Definition Classes
    AnyRef
  23. final def filterChildElemPaths(p: (Elem) ⇒ Boolean): IndexedSeq[Path]

    Returns the paths of child elements obeying the given predicate

    Returns the paths of child elements obeying the given predicate

    Definition Classes
    PathAwareElemLikePathAwareElemApi
  24. final def filterChildElems(expandedName: EName): IndexedSeq[Elem]

    Returns the child elements with the given expanded name

    Returns the child elements with the given expanded name

    Definition Classes
    ElemLikeElemApi
  25. final def filterChildElems(p: (Elem) ⇒ Boolean): IndexedSeq[Elem]

    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
    ParentElemLikeParentElemApi
  26. final def filterElemOrSelfPaths(p: (Elem) ⇒ Boolean): IndexedSeq[Path]

    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
    PathAwareElemLikePathAwareElemApi
  27. final def filterElemPaths(p: (Elem) ⇒ Boolean): IndexedSeq[Path]

    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
    PathAwareElemLikePathAwareElemApi
  28. final def filterElems(expandedName: EName): IndexedSeq[Elem]

    Returns the descendant elements with the given expanded name

    Returns the descendant elements with the given expanded name

    Definition Classes
    ElemLikeElemApi
  29. final def filterElems(p: (Elem) ⇒ Boolean): IndexedSeq[Elem]

    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
    ParentElemLikeParentElemApi
  30. final def filterElemsOrSelf(expandedName: EName): IndexedSeq[Elem]

    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
    ElemLikeElemApi
  31. final def filterElemsOrSelf(p: (Elem) ⇒ Boolean): IndexedSeq[Elem]

    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
    ParentElemLikeParentElemApi
  32. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  33. final def findAllChildElemPathEntries: IndexedSeq[Entry]

    Returns the Path entries of all child elements, in the correct order.

    Returns the Path entries of all child elements, in the correct order. Equivalent to findAllChildElemsWithPathEntries map { _._2 }.

    Definition Classes
    PathAwareElemLikePathAwareElemApi
  34. final def findAllChildElemPaths: IndexedSeq[Path]

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

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

    Definition Classes
    PathAwareElemLikePathAwareElemApi
  35. def findAllChildElems: IndexedSeq[Elem]

    Returns the element children

    Returns the element children

    Definition Classes
    ElemParentElemLikeParentElemApi
  36. def findAllChildElemsWithPathEntries: IndexedSeq[(Elem, Entry)]

    Returns all child elements with their Path entries, in the correct order.

    Returns all child elements with their Path entries, in the correct order.

    The implementation must be such that the following holds: (findAllChildElemsWithPathEntries map (_._1)) == findAllChildElems

    Definition Classes
    ElemPathAwareElemLikePathAwareElemApi
  37. final def findAllElemOrSelfPaths: IndexedSeq[Path]

    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
    PathAwareElemLikePathAwareElemApi
  38. final def findAllElemPaths: IndexedSeq[Path]

    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
    PathAwareElemLikePathAwareElemApi
  39. final def findAllElems: IndexedSeq[Elem]

    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
    ParentElemLikeParentElemApi
  40. final def findAllElemsOrSelf: IndexedSeq[Elem]

    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
    ParentElemLikeParentElemApi
  41. 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
    ElemLikeElemApi
  42. final def findChildElem(expandedName: EName): Option[Elem]

    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
    ElemLikeElemApi
  43. final def findChildElem(p: (Elem) ⇒ Boolean): Option[Elem]

    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
    ParentElemLikeParentElemApi
  44. def findChildElemByPathEntry(entry: Entry): Option[Elem]

    Returns the equivalent of findElemOrSelfByPath(Path(immutable.IndexedSeq(entry))), but it should be very efficient.

    Returns the equivalent of findElemOrSelfByPath(Path(immutable.IndexedSeq(entry))), but it should be very efficient.

    Indeed, it is function findElemOrSelfByPath that is defined in terms of this function, findChildElemByPathEntry, and not the other way around.

    Definition Classes
    ElemPathAwareElemLikePathAwareElemApi
  45. final def findChildElemPath(p: (Elem) ⇒ Boolean): Option[Path]

    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
    PathAwareElemLikePathAwareElemApi
  46. final def findElem(expandedName: EName): Option[Elem]

    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
    ElemLikeElemApi
  47. final def findElem(p: (Elem) ⇒ Boolean): Option[Elem]

    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
    ParentElemLikeParentElemApi
  48. final def findElemOrSelf(expandedName: EName): Option[Elem]

    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
    ElemLikeElemApi
  49. final def findElemOrSelf(p: (Elem) ⇒ Boolean): Option[Elem]

    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
    ParentElemLikeParentElemApi
  50. final def findElemOrSelfByPath(path: Path): Option[Elem]

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

    Finds the element with the given Path (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 findChildElemByPathEntry.

    Definition Classes
    PathAwareElemLikePathAwareElemApi
  51. final def findElemOrSelfPath(p: (Elem) ⇒ Boolean): Option[Path]

    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
    PathAwareElemLikePathAwareElemApi
  52. final def findElemPath(p: (Elem) ⇒ Boolean): Option[Path]

    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
    PathAwareElemLikePathAwareElemApi
  53. final def findTopmostElemOrSelfPaths(p: (Elem) ⇒ Boolean): IndexedSeq[Path]

    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
    PathAwareElemLikePathAwareElemApi
  54. final def findTopmostElemPaths(p: (Elem) ⇒ Boolean): IndexedSeq[Path]

    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
    PathAwareElemLikePathAwareElemApi
  55. final def findTopmostElems(expandedName: EName): IndexedSeq[Elem]

    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
    ElemLikeElemApi
  56. final def findTopmostElems(p: (Elem) ⇒ Boolean): IndexedSeq[Elem]

    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
    ParentElemLikeParentElemApi
  57. final def findTopmostElemsOrSelf(expandedName: EName): IndexedSeq[Elem]

    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
    ElemLikeElemApi
  58. final def findTopmostElemsOrSelf(p: (Elem) ⇒ Boolean): IndexedSeq[Elem]

    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
    ParentElemLikeParentElemApi
  59. final def getChildElem(expandedName: EName): Elem

    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
    ElemLikeElemApi
  60. final def getChildElem(p: (Elem) ⇒ Boolean): Elem

    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
    ParentElemLikeParentElemApi
  61. final def getChildElemByPathEntry(entry: Entry): Elem

    Returns (the equivalent of) findChildElemByPathEntry(entry).get

    Returns (the equivalent of) findChildElemByPathEntry(entry).get

    Definition Classes
    PathAwareElemLikePathAwareElemApi
  62. final def getChildElemPath(p: (Elem) ⇒ Boolean): Path

    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
    PathAwareElemLikePathAwareElemApi
  63. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  64. final def getElemOrSelfByPath(path: Path): Elem

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

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

    Definition Classes
    PathAwareElemLikePathAwareElemApi
  65. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  66. final def localName: String

    The local name (or local part).

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

    Definition Classes
    ElemLikeElemApi
  67. final def minusChild(index: Int): Elem

    Returns a copy in which the child at the given position (0-based) has been removed

    Returns a copy in which the child at the given position (0-based) has been removed

    Definition Classes
    UpdatableElemLikeUpdatableElemApi
  68. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  69. def normalizeAllText: Elem

    Returns a copy where text nodes have been normalized, throughout the node tree.

    Returns a copy where text nodes have been normalized, throughout the node tree. Note that it makes little sense to call this method before coalesceAllAdjacentText.

  70. final def normalizedText: String

    Returns XmlStringUtils.normalizeString(text).

    Returns XmlStringUtils.normalizeString(text).

    Definition Classes
    HasText
  71. final def notify(): Unit

    Definition Classes
    AnyRef
  72. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  73. final def plusChild(child: Node): Elem

    Returns a copy in which the given child has been inserted at the end

    Returns a copy in which the given child has been inserted at the end

    Definition Classes
    UpdatableElemLikeUpdatableElemApi
  74. final def plusChild(index: Int, child: Node): Elem

    Returns a copy in which the given child has been inserted at the given position (0-based)

    Returns a copy in which the given child has been inserted at the given position (0-based)

    Definition Classes
    UpdatableElemLikeUpdatableElemApi
  75. def removeAllInterElementWhitespace: Elem

    Returns a copy where inter-element whitespace has been removed, throughout the node tree

  76. val resolvedAttributes: Map[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
    ElemElemLikeElemApi
  77. val resolvedName: EName

    Resolved name of the element, as EName

    Resolved name of the element, as EName

    Definition Classes
    ElemElemLikeElemApi
  78. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  79. def text: String

    Returns the concatenation of the texts of text children, including whitespace.

    Returns the concatenation of the texts of text children, including whitespace. Non-text children are ignored. If there are no text children, the empty string is returned.

    Definition Classes
    ElemHasText
  80. def textChildren: IndexedSeq[Text]

    Returns the text children

  81. def transformChildElems(f: (Elem) ⇒ Elem): Elem

    Returns the same element, except that child elements have been replaced by applying the given function.

    Returns the same element, except that child elements have been replaced by applying the given function. Non-element child nodes occur in the result element unaltered.

    That is, returns the equivalent of:

    val newChildren =
      children map {
        case e: E => f(e)
        case n: N => n
      }
    withChildren(newChildren)
    Definition Classes
    ElemTransformableElemLikeTransformableElemApi
  82. def transformChildElemsToNodeSeq(f: (Elem) ⇒ IndexedSeq[Node]): Elem

    Returns the same element, except that child elements have been replaced by applying the given function.

    Returns the same element, except that child elements have been replaced by applying the given function. Non-element child nodes occur in the result element unaltered.

    That is, returns the equivalent of:

    val newChildren =
      children flatMap {
        case e: E => f(e)
        case n: N => Vector(n)
      }
    withChildren(newChildren)
    Definition Classes
    ElemTransformableElemLikeTransformableElemApi
  83. final def transformElems(f: (Elem) ⇒ Elem): Elem

    Transforms the element by applying the given function to all its descendant elements, in a bottom-up manner.

    Transforms the element by applying the given function to all its descendant elements, in a bottom-up manner.

    That is, returns the equivalent of:

    transformChildElems (e => e.transformElemsOrSelf(f))
    Definition Classes
    TransformableElemLikeTransformableElemApi
  84. final def transformElemsOrSelf(f: (Elem) ⇒ Elem): Elem

    Transforms the element by applying the given function to all its descendant-or-self elements, in a bottom-up manner.

    Transforms the element by applying the given function to all its descendant-or-self elements, in a bottom-up manner.

    That is, returns the equivalent of:

    f(transformChildElems (e => e.transformElemsOrSelf(f)))

    In other words, returns the equivalent of:

    f(transformElems(f))
    Definition Classes
    TransformableElemLikeTransformableElemApi
  85. final def transformElemsOrSelfToNodeSeq(f: (Elem) ⇒ IndexedSeq[Node]): IndexedSeq[Node]

    Transforms each descendant element to a node sequence by applying the given function to all its descendant-or-self elements, in a bottom-up manner.

    Transforms each descendant element to a node sequence by applying the given function to all its descendant-or-self elements, in a bottom-up manner.

    That is, returns the equivalent of:

    f(transformChildElemsToNodeSeq(e => e.transformElemsOrSelfToNodeSeq(f)))

    In other words, returns the equivalent of:

    f(transformElemsToNodeSeq(f))
    Definition Classes
    TransformableElemLikeTransformableElemApi
  86. final def transformElemsToNodeSeq(f: (Elem) ⇒ IndexedSeq[Node]): Elem

    Transforms each descendant element to a node sequence by applying the given function to all its descendant elements, in a bottom-up manner.

    Transforms each descendant element to a node sequence by applying the given function to all its descendant elements, in a bottom-up manner. The function is not applied to this element itself.

    That is, returns the equivalent of:

    transformChildElemsToNodeSeq(e => e.transformElemsOrSelfToNodeSeq(f))

    It is equivalent to the following expression:

    transformElemsOrSelf { e => e.transformChildElemsToNodeSeq(che => f(che)) }
    Definition Classes
    TransformableElemLikeTransformableElemApi
  87. final def trimmedText: String

    Returns text.trim.

    Returns text.trim.

    Definition Classes
    HasText
  88. final def updated(path: Path, newElem: Elem): Elem

    Returns updated(path) { e => newElem }

    Returns updated(path) { e => newElem }

    Definition Classes
    UpdatableElemLikeUpdatableElemApi
  89. final def updated(path: Path)(f: (Elem) ⇒ Elem): Elem

    Method that "functionally updates" the tree with this element as root element, by applying the passed function to the element that has the given eu.cdevreeze.yaidom.Path (compared to this element as root).

    Method that "functionally updates" the tree with this element as root element, by applying the passed function to the element that has the given eu.cdevreeze.yaidom.Path (compared to this element as root).

    The method throws an exception if no element is found with the given path.

    It can be defined (recursively) as follows:

    if (path == Path.Root) f(self)
    else updated(path.firstEntry) { e => e.updated(path.withoutFirstEntry)(f) }
    Definition Classes
    UpdatableElemLikeUpdatableElemApi
  90. final def updated(pathEntry: Entry)(f: (Elem) ⇒ Elem): Elem

    Core method that "functionally updates" the tree with this element as root element, by applying the passed function to the element that has the given eu.cdevreeze.yaidom.Path.Entry (compared to this element as root).

    Core method that "functionally updates" the tree with this element as root element, by applying the passed function to the element that has the given eu.cdevreeze.yaidom.Path.Entry (compared to this element as root).

    The method throws an exception if no element is found with the given path entry.

    It can be defined as follows:

    val idx = self.childNodeIndex(pathEntry)
    self.withUpdatedChildren(idx, f(children(idx).asInstanceOf[E]))
    Definition Classes
    UpdatableElemLikeUpdatableElemApi
  91. final def updatedAtPathEntries(pathEntries: Set[Entry])(f: (Elem, Entry) ⇒ Elem): Elem

    Method that "functionally updates" the tree with this element as root element, by applying the passed function to all child elements with the given path entries (compared to this element as root).

    Method that "functionally updates" the tree with this element as root element, by applying the passed function to all child elements with the given path entries (compared to this element as root).

    It can be defined as follows (ignoring exceptions):

    val newChildren = childNodeIndexesByPathEntries.filterKeys(pathEntries).toSeq.sortBy(_._2).reverse.foldLeft(children) {
      case (acc, (pathEntry, idx)) =>
        acc.updated(idx, f(acc(idx).asInstanceOf[E], pathEntry))
    }
    withChildren(newChildren)
    Definition Classes
    UpdatableElemLikeUpdatableElemApi
  92. final def updatedAtPaths(paths: Set[Path])(f: (Elem, Path) ⇒ Elem): Elem

    Method that "functionally updates" the tree with this element as root element, by applying the passed function to all descendant-or-self elements with the given paths (compared to this element as root).

    Method that "functionally updates" the tree with this element as root element, by applying the passed function to all descendant-or-self elements with the given paths (compared to this element as root).

    It can be defined (recursively) as follows (ignoring exceptions):

    def updatedAtPaths(paths: Set[Path])(f: (E, Path) => E): E = {
    val pathsByPathEntries = paths.filter(path => !path.isRoot).groupBy(path => path.firstEntry)
    val resultWithoutSelf = self.updatedAtPathEntries(pathsByPathEntries.keySet) { (che, pathEntry) =>
      val newChe = che.updatedAtPaths(paths.map(_.withoutFirstEntry)) { (elem, relativePath) =>
        f(elem, relativePath.prepend(pathEntry))
      }
      newChe
    }
    if (paths.contains(Path.Root)) f(resultWithoutSelf, Path.Root) else resultWithoutSelf
    }

    It is also equivalent to:

    val pathsReversed = findAllElemOrSelfPaths.filter(p => paths.contains(p)).reverse
    pathsReversed.foldLeft(self) { case (acc, path) => acc.updated(path) { e => f(e, path) } }
    Definition Classes
    UpdatableElemLikeUpdatableElemApi
  93. final def updatedWithNodeSeq(path: Path, newNodes: IndexedSeq[Node]): Elem

    Returns updatedWithNodeSeq(path) { e => newNodes }

    Returns updatedWithNodeSeq(path) { e => newNodes }

    Definition Classes
    UpdatableElemLikeUpdatableElemApi
  94. final def updatedWithNodeSeq(path: Path)(f: (Elem) ⇒ IndexedSeq[Node]): Elem

    "Functionally updates" the tree with this element as root element, by applying the passed function to the element that has the given eu.cdevreeze.yaidom.Path (compared to this element as root).

    "Functionally updates" the tree with this element as root element, by applying the passed function to the element that has the given eu.cdevreeze.yaidom.Path (compared to this element as root). If the given path is the root path, this element itself is returned unchanged.

    This function could be defined as follows:

    // First define function g as follows:
    
    def g(e: Elem): Elem = {
      if (path == Path.Root) e
      else {
        e.withPatchedChildren(
          e.childNodeIndex(path.lastEntry),
          f(e.findChildElemByPathEntry(path.lastEntry).get),
          1)
      }
    }
    
    // Then the function updatedWithNodeSeq(path)(f) could be defined as:
    
    updated(path.parentPathOption.getOrElse(Path.Root))(g)

    After all, this is just a functional update that replaces the parent element, if it exists.

    The method throws an exception if no element is found with the given path.

    Definition Classes
    UpdatableElemLikeUpdatableElemApi
  95. final def updatedWithNodeSeqAtPathEntries(pathEntries: Set[Entry])(f: (Elem, Entry) ⇒ IndexedSeq[Node]): Elem

    Method that "functionally updates" the tree with this element as root element, by applying the passed function to all child elements with the given path entries (compared to this element as root).

    Method that "functionally updates" the tree with this element as root element, by applying the passed function to all child elements with the given path entries (compared to this element as root).

    It can be defined as follows (ignoring exceptions):

    val indexesByPathEntries = childNodeIndexesByPathEntries.filterKeys(pathEntries).toSeq.sortBy(_._2).reverse
    val newChildGroups =
      indexesByPathEntries.foldLeft(self.children.map(n => immutable.IndexedSeq(n))) {
        case (acc, (pathEntry, idx)) =>
          acc.updated(idx, f(acc(idx).head.asInstanceOf[E], pathEntry))
      }
    withChildren(newChildGroups.flatten)
    Definition Classes
    UpdatableElemLikeUpdatableElemApi
  96. final def updatedWithNodeSeqAtPaths(paths: Set[Path])(f: (Elem, Path) ⇒ IndexedSeq[Node]): Elem

    Method that "functionally updates" the tree with this element as root element, by applying the passed function to all descendant elements with the given paths (compared to this element as root), but ignoring the root path.

    Method that "functionally updates" the tree with this element as root element, by applying the passed function to all descendant elements with the given paths (compared to this element as root), but ignoring the root path.

    It can be defined as follows (ignoring exceptions):

    val pathsByParentPaths = paths.filter(path => !path.isRoot).groupBy(path => path.parentPath)
    self.updatedAtPaths(pathsByParentPaths.keySet) { (elem, path) =>
      val childPathEntries = pathsByParentPaths(path).map(_.lastEntry)
      elem.updatedWithNodeSeqAtPathEntries(childPathEntries) { (che, pathEntry) =>
        f(che, path.append(pathEntry))
      }
    }
    Definition Classes
    UpdatableElemLikeUpdatableElemApi
  97. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  100. def withChildren(newChildren: IndexedSeq[Node]): Elem

    Creates a copy, but with (only) the children passed as parameter newChildren

    Creates a copy, but with (only) the children passed as parameter newChildren

    Definition Classes
    ElemUpdatableElemLikeUpdatableElemApi
  101. final def withPatchedChildren(from: Int, newChildren: IndexedSeq[Node], replace: Int): Elem

    Shorthand for withChildren(children.patch(from, newChildren, replace))

    Shorthand for withChildren(children.patch(from, newChildren, replace))

    Definition Classes
    UpdatableElemLikeUpdatableElemApi
  102. final def withUpdatedChildren(index: Int, newChild: Node): Elem

    Shorthand for withChildren(children.updated(index, newChild))

    Shorthand for withChildren(children.updated(index, newChild))

    Definition Classes
    UpdatableElemLikeUpdatableElemApi

Deprecated Value Members

  1. final def findWithElemPath(path: Path): Option[Elem]

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

    Finds the element with the given Path (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 findChildElemByPathEntry.

    Definition Classes
    PathAwareElemLikePathAwareElemApi
    Annotations
    @deprecated
    Deprecated

    (Since version 0.7.1) Use findElemOrSelfByPath instead

  2. final def findWithElemPathEntry(entry: Entry): Option[Elem]

    Returns the equivalent of findElemOrSelfByPath(Path(immutable.IndexedSeq(entry))), but it should be very efficient.

    Returns the equivalent of findElemOrSelfByPath(Path(immutable.IndexedSeq(entry))), but it should be very efficient.

    Indeed, it is function findElemOrSelfByPath that is defined in terms of this function, findChildElemByPathEntry, and not the other way around.

    Definition Classes
    PathAwareElemLikePathAwareElemApi
    Annotations
    @deprecated
    Deprecated

    (Since version 0.7.1) Use findChildElemByPathEntry instead

  3. final def getWithElemPath(path: Path): Elem

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

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

    Definition Classes
    PathAwareElemLikePathAwareElemApi
    Annotations
    @deprecated
    Deprecated

    (Since version 0.7.1) Use getElemOrSelfByPath instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from HasText

Inherited from TransformableElemLike[Node, Elem]

Inherited from TransformableElemApi[Node, Elem]

Inherited from UpdatableElemLike[Node, Elem]

Inherited from UpdatableElemApi[Node, Elem]

Inherited from PathAwareElemLike[Elem]

Inherited from PathAwareElemApi[Elem]

Inherited from ElemLike[Elem]

Inherited from ElemApi[Elem]

Inherited from ParentElemLike[Elem]

Inherited from ParentElemApi[Elem]

Inherited from Node

Inherited from Immutable

Inherited from AnyRef

Inherited from Any

Ungrouped