eu.cdevreeze.yaidom.scalaxml

ScalaXmlElem

final class ScalaXmlElem extends ScalaXmlNode with ElemLike[ScalaXmlElem] with HasText

Wrapper around scala.xml.Elem, conforming to the eu.cdevreeze.yaidom.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 ElemApi 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 ParentElemApi 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. HasText
  3. ElemLike
  4. ElemApi
  5. ParentElemLike
  6. ParentElemApi
  7. ScalaXmlNode
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ScalaXmlElem(wrappedNode: scala.xml.Elem)

Type Members

  1. type DomType = scala.xml.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 \(expandedName: EName): IndexedSeq[ScalaXmlElem]

    Shorthand for filterChildElems(expandedName).

    Shorthand for filterChildElems(expandedName).

    Definition Classes
    ElemLikeElemApi
  7. 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
    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[ScalaXmlElem]

    Shorthand for filterElemsOrSelf(expandedName).

    Shorthand for filterElemsOrSelf(expandedName).

    Definition Classes
    ElemLikeElemApi
  10. 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
    ParentElemLikeParentElemApi
  11. final def \\!(expandedName: EName): IndexedSeq[ScalaXmlElem]

    Shorthand for findTopmostElemsOrSelf(expandedName).

    Shorthand for findTopmostElemsOrSelf(expandedName).

    Definition Classes
    ElemLikeElemApi
  12. 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
    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. def attributes: IndexedSeq[(QName, String)]

  17. def children: IndexedSeq[ScalaXmlNode]

  18. def clone(): AnyRef

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

    Returns the comment children

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

    Definition Classes
    AnyRef
  21. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  22. final def filterChildElems(expandedName: EName): IndexedSeq[ScalaXmlElem]

    Returns the child elements with the given expanded name

    Returns the child elements with the given expanded name

    Definition Classes
    ElemLikeElemApi
  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
    ParentElemLikeParentElemApi
  24. final def filterElems(expandedName: EName): IndexedSeq[ScalaXmlElem]

    Returns the descendant elements with the given expanded name

    Returns the descendant elements with the given expanded name

    Definition Classes
    ElemLikeElemApi
  25. 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
    ParentElemLikeParentElemApi
  26. final def filterElemsOrSelf(expandedName: EName): IndexedSeq[ScalaXmlElem]

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  29. 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
    ScalaXmlElemParentElemLikeParentElemApi
  30. 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
    ParentElemLikeParentElemApi
  31. 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
    ParentElemLikeParentElemApi
  32. 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
  33. final def findChildElem(expandedName: EName): Option[ScalaXmlElem]

    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
  34. 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
    ParentElemLikeParentElemApi
  35. final def findElem(expandedName: EName): Option[ScalaXmlElem]

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

    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
  38. 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
    ParentElemLikeParentElemApi
  39. final def findTopmostElems(expandedName: EName): IndexedSeq[ScalaXmlElem]

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

    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
  42. 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
    ParentElemLikeParentElemApi
  43. final def getChildElem(expandedName: EName): ScalaXmlElem

    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
  44. 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
    ParentElemLikeParentElemApi
  45. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  46. def hashCode(): Int

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

    Definition Classes
    Any
  48. final def localName: String

    The local name (or local part).

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

    Definition Classes
    ElemLikeElemApi
  49. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  50. final def normalizedText: String

    Returns XmlStringUtils.normalizeString(text).

    Returns XmlStringUtils.normalizeString(text).

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

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

    Definition Classes
    AnyRef
  53. def qname: QName

  54. 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
    ScalaXmlElemElemLikeElemApi
  55. 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
    ScalaXmlElemElemLikeElemApi
  56. 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!

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

    Definition Classes
    AnyRef
  58. 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
    ScalaXmlElemHasText
  59. def textChildren: IndexedSeq[ScalaXmlText]

    Returns the text children

  60. final def toString(): String

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

    Returns text.trim.

    Returns text.trim.

    Definition Classes
    HasText
  62. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  65. val wrappedNode: scala.xml.Elem

    Definition Classes
    ScalaXmlElemScalaXmlNode

Inherited from HasText

Inherited from ElemLike[ScalaXmlElem]

Inherited from ElemApi[ScalaXmlElem]

Inherited from ParentElemLike[ScalaXmlElem]

Inherited from ParentElemApi[ScalaXmlElem]

Inherited from ScalaXmlNode

Inherited from AnyRef

Inherited from Any

Ungrouped