eu.cdevreeze.yaidom.dom

DomElem

final class DomElem extends CanBeDomDocumentChild with Elem with ScopedElemLike with HasParent

Wrapper around org.w3c.dom.Element, conforming to the eu.cdevreeze.yaidom.queryapi.ElemLike API.

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

By design the only state of the DomElem is the wrapped element. Otherwise it would be easy to cause any inconsistency between this wrapper element and the wrapped element. The down-side is that computing the resolved name or resolved attributes is expensive, because on each call first the in-scope namespaces are computed (by following namespace declarations in the ancestry and in the element itself). This is done for reliable namespace support, independent of namespace-awareness of the underlying element's document.

This choice for reliable namespace support (see the documented properties of ScopedElemApi) and defensive handling of mutable state makes this DomElem slower (when querying for resolved names or attributes) than other wrapper element implementations, such as ScalaXmlElem. On the other hand, if the use of org.w3c.dom is a given, then this DomElem makes namespace-aware querying of DOM elements far easier than direct querying of DOM elements.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DomElem
  2. HasParent
  3. HasParentApi
  4. ScopedElemLike
  5. ClarkElemLike
  6. HasText
  7. HasEName
  8. IsNavigable
  9. ElemLike
  10. ScopedElemApi
  11. HasScopeApi
  12. HasQNameApi
  13. ClarkElemApi
  14. HasTextApi
  15. IsNavigableApi
  16. ElemApi
  17. AnyElemApi
  18. Elem
  19. HasENameApi
  20. Elem
  21. CanBeDomDocumentChild
  22. CanBeDocumentChild
  23. DomNode
  24. Node
  25. Node
  26. AnyRef
  27. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DomElem(wrappedNode: Element)

Type Members

  1. type DomType = Element

    Definition Classes
    DomElemDomNode
  2. type ThisElem = DomElem

    Definition Classes
    DomElemAnyElemApi
  3. type ThisElemApi = DomElem

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 \(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

    Shorthand for filterChildElems(p).

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

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

    Shorthand for attributeOption(expandedName).

    Shorthand for attributeOption(expandedName).

    Definition Classes
    HasENameHasENameApi
  8. final def \\(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

    Shorthand for filterElemsOrSelf(p).

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

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

    Shorthand for findTopmostElemsOrSelf(p).

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

    Definition Classes
    ElemLikeElemApi
  10. final def ancestors: IndexedSeq[ThisElem]

    Returns ancestorsOrSelf.drop(1)

    Returns ancestorsOrSelf.drop(1)

    Definition Classes
    HasParentHasParentApi
  11. final def ancestorsOrSelf: IndexedSeq[ThisElem]

    Returns all ancestor elements or self

    Returns all ancestor elements or self

    Definition Classes
    HasParentHasParentApi
  12. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  13. 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
    HasENameHasENameApi
  14. final def attributeAsQName(expandedName: EName): QName

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

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

    Definition Classes
    ScopedElemLikeScopedElemApi
  15. final def attributeAsQNameOption(expandedName: EName): Option[QName]

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

    Returns the QName value of the attribute with the given expanded name, if any, wrapped in an Option. If the attribute exists, but its value is not a QName, an exception is thrown.

    Definition Classes
    ScopedElemLikeScopedElemApi
  16. final def attributeAsResolvedQName(expandedName: EName): EName

    Returns the resolved QName value (as EName) of the attribute with the given expanded name, and throws an exception otherwise

    Returns the resolved QName value (as EName) of the attribute with the given expanded name, and throws an exception otherwise

    Definition Classes
    ScopedElemLikeScopedElemApi
  17. final def attributeAsResolvedQNameOption(expandedName: EName): Option[EName]

    Returns the resolved QName value (as EName) of the attribute with the given expanded name, if any, wrapped in an Option.

    Returns the resolved QName value (as EName) of the attribute with the given expanded name, if any, wrapped in an Option. None is returned if the attribute does not exist. If the QName value cannot be resolved given the scope of the element, an exception is thrown.

    Definition Classes
    ScopedElemLikeScopedElemApi
  18. 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
    HasENameHasENameApi
  19. def attributeScope: Scope

    The attribute Scope, which is the same Scope but without the default namespace (which is not used for attributes)

  20. def attributes: IndexedSeq[(QName, String)]

    The attributes of the element as mapping from QNames to values

    The attributes of the element as mapping from QNames to values

    Definition Classes
    DomElemHasQNameApi
  21. def children: IndexedSeq[DomNode]

    Definition Classes
    DomElemElem
  22. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. def commentChildren: IndexedSeq[DomComment]

    Returns the comment children

  24. def declarations: Declarations

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

    Definition Classes
    AnyRef
  26. final def equals(obj: Any): Boolean

    Definition Classes
    DomNode → AnyRef → Any
  27. final def filterChildElems(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

    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: ThisElem => Boolean): immutable.IndexedSeq[ThisElem] =
    this.findAllChildElems.filter(p)
    Definition Classes
    ElemLikeElemApi
  28. final def filterElems(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

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

    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: ThisElem => Boolean): immutable.IndexedSeq[ThisElem] =
    Vector(this).filter(p) ++ (this.findAllChildElems flatMap (_.filterElemsOrSelf(p)))

    It can be proven that the result is equivalent to findAllElemsOrSelf filter p.

    Definition Classes
    ElemLikeElemApi
  30. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  31. def findAllChildElems: IndexedSeq[DomElem]

    Returns the element children

    Returns the element children

    Definition Classes
    DomElemElemLikeElemApi
  32. final def findAllChildElemsWithPathEntries: IndexedSeq[(ThisElem, Entry)]

    Returns all child elements paired with their path entries.

    Returns all child elements paired with their path entries.

    This method is final, so more efficient implementations for sub-types are not supported. This implementation is only efficient if finding all child elements as well as computing their resolved names is efficient. That is not the case for DOM wrappers or Scala XML Elem wrappers (due to their expensive Scope computations). On the other hand, those wrapper element implementations are convenient, but not intended for heavy use in production. Hence, this method should typically be fast enough.

    Definition Classes
    ClarkElemLikeIsNavigableIsNavigableApi
  33. final def findAllElems: IndexedSeq[ThisElem]

    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
    ElemLikeElemApi
  34. final def findAllElemsOrSelf: IndexedSeq[ThisElem]

    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
    ElemLikeElemApi
  35. final def findAncestor(p: (ThisElem) ⇒ Boolean): Option[ThisElem]

    Returns the first found ancestor element obeying the given predicate, if any, wrapped in an Option

    Returns the first found ancestor element obeying the given predicate, if any, wrapped in an Option

    Definition Classes
    HasParentHasParentApi
  36. final def findAncestorOrSelf(p: (ThisElem) ⇒ Boolean): Option[ThisElem]

    Returns the first found ancestor-or-self element obeying the given predicate, if any, wrapped in an Option

    Returns the first found ancestor-or-self element obeying the given predicate, if any, wrapped in an Option

    Definition Classes
    HasParentHasParentApi
  37. 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
    HasENameHasENameApi
  38. final def findChildElem(p: (ThisElem) ⇒ Boolean): Option[ThisElem]

    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
    ElemLikeElemApi
  39. final def findChildElemByPathEntry(entry: Entry): Option[ThisElem]

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

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

    This method is final, so more efficient implementations for sub-types are not supported. This implementation is only efficient if finding all child elements as well as computing their resolved names is efficient. That is not the case for DOM wrappers or Scala XML Elem wrappers (due to their expensive Scope computations). On the other hand, those wrapper element implementations are convenient, but not intended for heavy use in production. Hence, this method should typically be fast enough.

    Definition Classes
    ClarkElemLikeIsNavigableIsNavigableApi
  40. final def findElem(p: (ThisElem) ⇒ Boolean): Option[ThisElem]

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

    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
    ElemLikeElemApi
  42. final def findElemOrSelfByPath(path: Path): Option[ThisElem]

    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.

    That is, returns:

    findReverseAncestryOrSelfByPath(path).map(_.last)

    Note that for each non-empty Path, we have:

    findElemOrSelfByPath(path) == findChildElemByPathEntry(path.firstEntry) flatMap (e => e.findElemOrSelfByPath(path.withoutFirstEntry))
    Definition Classes
    IsNavigableIsNavigableApi
  43. final def findReverseAncestryOrSelfByPath(path: Path): Option[IndexedSeq[ThisElem]]

    Finds the reversed ancestry-or-self of the element with the given Path (where this element is the root), wrapped in an Option.

    Finds the reversed ancestry-or-self of the element with the given Path (where this element is the root), wrapped in an Option. None is returned if no element can be found at the given Path.

    Hence, the resulting element collection, if any, starts with this element and ends with the element at the given Path, relative to this element.

    This method comes in handy for (efficiently) computing base URIs, where the (reverse) ancestry-or-self is needed as input.

    Definition Classes
    IsNavigableIsNavigableApi
  44. final def findTopmostElems(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

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

    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: ThisElem => Boolean): immutable.IndexedSeq[ThisElem] =
    if (p(this)) Vector(this)
    else (this.findAllChildElems flatMap (_.findTopmostElemsOrSelf(p)))
    Definition Classes
    ElemLikeElemApi
  46. final def getChildElem(p: (ThisElem) ⇒ Boolean): ThisElem

    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
    ElemLikeElemApi
  47. final def getChildElemByPathEntry(entry: Entry): ThisElem

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

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

    Definition Classes
    IsNavigableIsNavigableApi
  48. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  49. final def getElemOrSelfByPath(path: Path): ThisElem

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

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

    Definition Classes
    IsNavigableIsNavigableApi
  50. final def getReverseAncestryOrSelfByPath(path: Path): IndexedSeq[ThisElem]

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

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

    Definition Classes
    IsNavigableIsNavigableApi
  51. final def hashCode(): Int

    Definition Classes
    DomNode → AnyRef → Any
  52. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  53. final def localName: String

    The local name, that is, the local part of the EName

    The local name, that is, the local part of the EName

    Definition Classes
    HasENameHasENameApi
  54. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  55. final def normalizedText: String

    Returns XmlStringUtils.normalizeString(text).

    Returns XmlStringUtils.normalizeString(text).

    Definition Classes
    HasTextHasTextApi
  56. final def notify(): Unit

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

    Definition Classes
    AnyRef
  58. final def parent: ThisElem

    Returns the equivalent parentOption.get, throwing an exception if this is the root element

    Returns the equivalent parentOption.get, throwing an exception if this is the root element

    Definition Classes
    HasParentHasParentApi
  59. def parentOption: Option[DomElem]

    Returns the parent element, if any, wrapped in an Option

    Returns the parent element, if any, wrapped in an Option

    Definition Classes
    DomElemHasParentApi
  60. def qname: QName

    The QName of the element

    The QName of the element

    Definition Classes
    DomElemHasQNameApi
  61. def resolvedAttributes: IndexedSeq[(EName, String)]

    The attributes as an ordered mapping from ENames (instead of QNames) to values, obtained by resolving attribute QNames against the attribute scope

    The attributes as an ordered mapping from ENames (instead of QNames) to values, obtained by resolving attribute QNames against the attribute scope

    Definition Classes
    DomElemHasENameApi
  62. def resolvedName: EName

    The EName of the element

    The EName of the element

    Definition Classes
    DomElemHasENameApi
  63. def scope: Scope

    The Scope stored with the element

    The Scope stored with the element

    Definition Classes
    DomElemHasScopeApi
  64. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  65. def text: String

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

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

    Definition Classes
    DomElemHasTextApi
  66. final def textAsQName: QName

    Returns QName(text.trim)

    Returns QName(text.trim)

    Definition Classes
    ScopedElemLikeScopedElemApi
  67. final def textAsResolvedQName: EName

    Returns the equivalent of scope.resolveQNameOption(textAsQName).get

    Returns the equivalent of scope.resolveQNameOption(textAsQName).get

    Definition Classes
    ScopedElemLikeScopedElemApi
  68. def textChildren: IndexedSeq[DomText]

    Returns the text children

  69. def thisElem: ThisElem

    Definition Classes
    DomElemAnyElemApi
  70. final def toString(): String

    Definition Classes
    DomNode → AnyRef → Any
  71. final def trimmedText: String

    Returns text.trim.

    Returns text.trim.

    Definition Classes
    HasTextHasTextApi
  72. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  75. val wrappedNode: Element

    Definition Classes
    DomElemDomNode

Inherited from HasParent

Inherited from HasParentApi

Inherited from ScopedElemLike

Inherited from ClarkElemLike

Inherited from HasText

Inherited from HasEName

Inherited from IsNavigable

Inherited from ElemLike

Inherited from ScopedElemApi

Inherited from HasScopeApi

Inherited from HasQNameApi

Inherited from ClarkElemApi

Inherited from HasTextApi

Inherited from IsNavigableApi

Inherited from ElemApi

Inherited from AnyElemApi

Inherited from Elem

Inherited from HasENameApi

Inherited from Elem

Inherited from CanBeDomDocumentChild

Inherited from CanBeDocumentChild

Inherited from DomNode

Inherited from Node

Inherited from Node

Inherited from AnyRef

Inherited from Any

Ungrouped