eu.cdevreeze.yaidom.docaware

Elem

final class Elem extends ElemLike[Elem] with HasText with Immutable

An element just like indexed.Elem, but storing the URI of the containing document as well. See eu.cdevreeze.yaidom.indexed.Elem for more details. These details apply to eu.cdevreeze.yaidom.docaware.Elem too, except that additionally the document URI is stored.

Linear Supertypes
Immutable, HasText, ElemLike[Elem], ElemApi[Elem], ParentElemLike[Elem], ParentElemApi[Elem], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Elem
  2. Immutable
  3. HasText
  4. ElemLike
  5. ElemApi
  6. ParentElemLike
  7. ParentElemApi
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

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

  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
    ParentElemLike → ParentElemApi

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

    Shorthand for attributeOption(expandedName)

    Shorthand for attributeOption(expandedName)

    Definition Classes
    ElemLike → ElemApi

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

    Shorthand for filterElemsOrSelf(expandedName).

    Shorthand for filterElemsOrSelf(expandedName).

    Definition Classes
    ElemLike → ElemApi

  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
    ParentElemLike → ParentElemApi

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

    Shorthand for findTopmostElemsOrSelf(expandedName).

    Shorthand for findTopmostElemsOrSelf(expandedName).

    Definition Classes
    ElemLike → ElemApi

  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
    ParentElemLike → ParentElemApi

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

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

  16. def clone(): AnyRef

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

  17. val docUri: URI

  18. val elem: yaidom.Elem

    The yaidom Elem itself, stored as a val

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

    Definition Classes
    AnyRef

  20. def equals(obj: Any): Boolean

    Definition Classes
    Elem → AnyRef → Any

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

  22. 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
    ParentElemLike → ParentElemApi

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

  24. 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
    ParentElemLike → ParentElemApi

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

  26. 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
    ParentElemLike → ParentElemApi

  27. def finalize(): Unit

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

  28. def findAllChildElems: IndexedSeq[Elem]

    Returns all child elements, in the correct order.

    Returns all child elements, in the correct order.

    These child elements share the same rootElem with this element, but differ in the paths, which have one more "path entry".

    Definition Classes
    Elem → ParentElemLike → ParentElemApi

  29. 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
    ParentElemLike → ParentElemApi

  30. 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
    ParentElemLike → ParentElemApi

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

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

  33. 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
    ParentElemLike → ParentElemApi

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

  35. 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
    ParentElemLike → ParentElemApi

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

  37. 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
    ParentElemLike → ParentElemApi

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

  39. 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
    ParentElemLike → ParentElemApi

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

  41. 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
    ParentElemLike → ParentElemApi

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

  43. 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
    ParentElemLike → ParentElemApi

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

    Definition Classes
    AnyRef → Any

  45. def hashCode(): Int

    Definition Classes
    Elem → AnyRef → Any

  46. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  47. final def localName: String

    The local name (or local part).

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

    Definition Classes
    ElemLike → ElemApi

  48. final def namespaces: Declarations

    Returns the namespaces declared in this element.

    Returns the namespaces declared in this element.

    If the original parsed XML document contained duplicate namespace declarations (i.e. namespace declarations that are the same as some namespace declarations in their context), these duplicate namespace declarations were lost during parsing of the XML into an Elem tree. They therefore do not occur in the namespace declarations returned by this method.

  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. val path: Path

  54. def resolvedAttributes: IndexedSeq[(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
    Elem → ElemLike → ElemApi

  55. def resolvedName: EName

    Resolved name of the element, as EName

    Resolved name of the element, as EName

    Definition Classes
    Elem → ElemLike → ElemApi

  56. val rootElem: yaidom.Elem

  57. final def scope: Scope

    Returns this.elem.scope

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

    Definition Classes
    AnyRef

  59. 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
    Elem → HasText

  60. def toString(): String

    Definition Classes
    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()

Deprecated Value Members

  1. def elemPath: Path

    Annotations
    @deprecated
    Deprecated

    (Since version 0.7.1) Use path instead

Inherited from Immutable

Inherited from HasText

Inherited from ElemLike[Elem]

Inherited from ElemApi[Elem]

Inherited from ParentElemLike[Elem]

Inherited from ParentElemApi[Elem]

Inherited from AnyRef

Inherited from Any

Ungrouped