eu.cdevreeze.yaidom.scalaxml

ScalaXmlElem

final class ScalaXmlElem extends ScalaXmlNode with ScopedElemLike[ScalaXmlElem] with IsNavigable[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
IsNavigable[ScalaXmlElem], IsNavigableApi[ScalaXmlElem], ScopedElemLike[ScalaXmlElem], HasText, HasEName, ElemLike[ScalaXmlElem], ScopedElemApi[ScalaXmlElem], HasTextApi, HasScopeApi, HasQNameApi, HasENameApi, ElemApi[ScalaXmlElem], ScalaXmlNode, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ScalaXmlElem
  2. IsNavigable
  3. IsNavigableApi
  4. ScopedElemLike
  5. HasText
  6. HasEName
  7. ElemLike
  8. ScopedElemApi
  9. HasTextApi
  10. HasScopeApi
  11. HasQNameApi
  12. HasENameApi
  13. ElemApi
  14. ScalaXmlNode
  15. AnyRef
  16. 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
    ScalaXmlElem → ScalaXmlNode

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  4. 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
    ElemLike → ElemApi

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

    Shorthand for attributeOption(expandedName).

    Shorthand for attributeOption(expandedName).

    Definition Classes
    HasEName → HasENameApi

  6. 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
    ElemLike → ElemApi

  7. 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
    ElemLike → ElemApi

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. 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
    HasEName → HasENameApi

  10. 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
    ScopedElemLike → ScopedElemApi

  11. 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
    ScopedElemLike → ScopedElemApi

  12. 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
    ScopedElemLike → ScopedElemApi

  13. 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
    ScopedElemLike → ScopedElemApi

  14. 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
    HasEName → HasENameApi

  15. 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
    ScalaXmlElem → HasQNameApi

  16. def children: IndexedSeq[ScalaXmlNode]

  17. def clone(): AnyRef

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

  18. def commentChildren: IndexedSeq[ScalaXmlComment]

    Returns the comment children

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

    Definition Classes
    AnyRef

  20. def equals(obj: Any): Boolean

    Definition Classes
    ScalaXmlElem → AnyRef → Any

  21. 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
    ElemLike → ElemApi

  22. 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
    ElemLike → ElemApi

  23. 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
    ElemLike → ElemApi

  24. def finalize(): Unit

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

  25. 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
    ScalaXmlElem → ElemLike → ElemApi

  26. 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
    ElemLike → ElemApi

  27. 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
    ElemLike → ElemApi

  28. 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
    HasEName → HasENameApi

  29. 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
    ElemLike → ElemApi

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

    Definition Classes
    ScalaXmlElem → IsNavigable → IsNavigableApi

  31. 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
    ElemLike → ElemApi

  32. 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
    ElemLike → ElemApi

  33. 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. This method must be very efficient, which depends on the efficiency of method findChildElemByPathEntry.

    Definition Classes
    IsNavigable → IsNavigableApi

  34. 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
    ElemLike → ElemApi

  35. 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
    ElemLike → ElemApi

  36. 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
    ElemLike → ElemApi

  37. final def getChildElemByPathEntry(entry: Entry): ScalaXmlElem

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

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

    Definition Classes
    IsNavigable → IsNavigableApi

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

    Definition Classes
    AnyRef → Any

  39. final def getElemOrSelfByPath(path: Path): ScalaXmlElem

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

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

    Definition Classes
    IsNavigable → IsNavigableApi

  40. def hashCode(): Int

    Definition Classes
    ScalaXmlElem → AnyRef → Any

  41. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  42. 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
    HasEName → HasENameApi

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

    Definition Classes
    AnyRef

  44. final def normalizedText: String

    Returns XmlStringUtils.normalizeString(text).

    Returns XmlStringUtils.normalizeString(text).

    Definition Classes
    HasText → HasTextApi

  45. final def notify(): Unit

    Definition Classes
    AnyRef

  46. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  47. def qname: QName

    The QName of the element

    The QName of the element

    Definition Classes
    ScalaXmlElem → HasQNameApi

  48. 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
    ScalaXmlElem → HasENameApi

  49. 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
    ScalaXmlElem → HasENameApi

  50. 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
    ScalaXmlElem → HasScopeApi

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

    Definition Classes
    AnyRef

  52. 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
    ScalaXmlElem → HasTextApi

  53. final def textAsQName: QName

    Returns QName(text.trim)

    Returns QName(text.trim)

    Definition Classes
    ScopedElemLike → ScopedElemApi

  54. final def textAsResolvedQName: EName

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

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

    Definition Classes
    ScopedElemLike → ScopedElemApi

  55. def textChildren: IndexedSeq[ScalaXmlText]

    Returns the text children

  56. final def toString(): String

    Definition Classes
    ScalaXmlNode → AnyRef → Any

  57. final def trimmedText: String

    Returns text.trim.

    Returns text.trim.

    Definition Classes
    HasText → HasTextApi

  58. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  61. val wrappedNode: Elem

    Definition Classes
    ScalaXmlElem → ScalaXmlNode

Inherited from IsNavigable[ScalaXmlElem]

Inherited from IsNavigableApi[ScalaXmlElem]

Inherited from ScopedElemLike[ScalaXmlElem]

Inherited from HasText

Inherited from HasEName

Inherited from ElemLike[ScalaXmlElem]

Inherited from ScopedElemApi[ScalaXmlElem]

Inherited from HasTextApi

Inherited from HasScopeApi

Inherited from HasQNameApi

Inherited from HasENameApi

Inherited from ElemApi[ScalaXmlElem]

Inherited from ScalaXmlNode

Inherited from AnyRef

Inherited from Any

Ungrouped