eu.cdevreeze.yaidom.scalaxml

ScalaXmlElem

final class ScalaXmlElem extends CanBeScalaXmlDocumentChild with Elem with ScopedElemLike[ScalaXmlElem]

Wrapper around scala.xml.Elem, conforming to the eu.cdevreeze.yaidom.queryapi.ElemApi API.

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

Keep in mind that the HasENameApi specific part of the API is a broken abstraction. If the wrapped Scala XML element misses some namespace declarations for used element or attribute names, these element and/or attribute names cannot be resolved, and exceptions are thrown when querying for them! The ElemApi part of the API does not suffer from this broken abstraction, so is less dangerous to use.

The wrapper instances are very light-weight, and typically very short-lived. On the other hand, each query may create many wrapper instances for the query results. By design, the only state of each wrapper instance is the wrapped Scala XML Elem.

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

Instance Constructors

  1. new ScalaXmlElem(wrappedNode: Elem)

Type Members

  1. type DomType = Elem

    Definition Classes
    ScalaXmlElemScalaXmlNode

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

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

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

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

    Definition Classes
    Any
  11. 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
  12. 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
  13. 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
  14. 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
  15. 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
  16. 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
  17. 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
    ScalaXmlElemHasQNameApi
  18. def children: IndexedSeq[ScalaXmlNode]

    Definition Classes
    ScalaXmlElemElem
  19. def clone(): AnyRef

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

    Returns the comment children

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

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

    Definition Classes
    ScalaXmlNode → AnyRef → Any
  23. final def filterChildElems(p: (ScalaXmlElem) ⇒ Boolean): IndexedSeq[ScalaXmlElem]

    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
    ElemLikeElemApi
  24. final def filterElems(p: (ScalaXmlElem) ⇒ Boolean): IndexedSeq[ScalaXmlElem]

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

    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
    ElemLikeElemApi
  26. def finalize(): Unit

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

    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
    ScalaXmlElemElemLikeElemApi
  28. final def findAllChildElemsWithPathEntries: IndexedSeq[(ScalaXmlElem, 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
    ClarkElemLikeClarkElemApi
  29. final def findAllElems: IndexedSeq[ScalaXmlElem]

    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
  30. final def findAllElemsOrSelf: IndexedSeq[ScalaXmlElem]

    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
  31. 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
  32. final def findChildElem(p: (ScalaXmlElem) ⇒ Boolean): Option[ScalaXmlElem]

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

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

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

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

    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
  37. final def findReverseAncestryOrSelfByPath(path: Path): Option[IndexedSeq[ScalaXmlElem]]

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

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

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

    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
  41. final def getChildElemByPathEntry(entry: Entry): ScalaXmlElem

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

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

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

    Definition Classes
    AnyRef → Any
  43. final def getElemOrSelfByPath(path: Path): ScalaXmlElem

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

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

    Definition Classes
    IsNavigableIsNavigableApi
  44. final def getReverseAncestryOrSelfByPath(path: Path): IndexedSeq[ScalaXmlElem]

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

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

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

    Definition Classes
    ScalaXmlNode → AnyRef → Any
  46. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  47. 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
  48. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  49. final def normalizedText: String

    Returns XmlStringUtils.normalizeString(text).

    Returns XmlStringUtils.normalizeString(text).

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

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

    Definition Classes
    AnyRef
  52. def qname: QName

    The QName of the element

    The QName of the element

    Definition Classes
    ScalaXmlElemHasQNameApi
  53. def resolvedAttributes: IndexedSeq[(EName, String)]

    Returns the "resolved attributes".

    Returns the "resolved attributes". Note that there is no guarantee that the attributes names can be resolved!

    Definition Classes
    ScalaXmlElemHasENameApi
  54. def resolvedName: EName

    Returns the resolved name of the element.

    Returns the resolved name of the element. Note that there is no guarantee that the element name can be resolved!

    Definition Classes
    ScalaXmlElemHasENameApi
  55. def scope: Scope

    Returns the scope of the element.

    Returns the scope of the element. Note that there is no guarantee that this scope is complete!

    Definition Classes
    ScalaXmlElemHasScopeApi
  56. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  57. 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
    ScalaXmlElemHasTextApi
  58. final def textAsQName: QName

    Returns QName(text.trim)

    Returns QName(text.trim)

    Definition Classes
    ScopedElemLikeScopedElemApi
  59. final def textAsResolvedQName: EName

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

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

    Definition Classes
    ScopedElemLikeScopedElemApi
  60. def textChildren: IndexedSeq[ScalaXmlText]

    Returns the text children

  61. final def toString(): String

    Definition Classes
    ScalaXmlNode → AnyRef → Any
  62. final def trimmedText: String

    Returns text.trim.

    Returns text.trim.

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  66. val wrappedNode: Elem

    Definition Classes
    ScalaXmlElemScalaXmlNode

Inherited from ScopedElemLike[ScalaXmlElem]

Inherited from ClarkElemLike[ScalaXmlElem]

Inherited from HasText

Inherited from HasEName

Inherited from IsNavigable[ScalaXmlElem]

Inherited from ElemLike[ScalaXmlElem]

Inherited from ScopedElemApi[ScalaXmlElem]

Inherited from HasScopeApi

Inherited from HasQNameApi

Inherited from ClarkElemApi[ScalaXmlElem]

Inherited from HasTextApi

Inherited from IsNavigableApi[ScalaXmlElem]

Inherited from ElemApi[ScalaXmlElem]

Inherited from Elem

Inherited from HasENameApi

Inherited from Elem

Inherited from CanBeDocumentChild

Inherited from ScalaXmlNode

Inherited from Node

Inherited from Node

Inherited from AnyRef

Inherited from Any

Ungrouped