eu.cdevreeze.yaidom.docaware

Elem

final class Elem extends ScopedElemLike[Elem] with IsNavigable[Elem] 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, IsNavigable[Elem], IsNavigableApi[Elem], ScopedElemLike[Elem], HasText, HasEName, ElemLike[Elem], ScopedElemApi[Elem], HasTextApi, HasScopeApi, HasQNameApi, HasENameApi, ElemApi[Elem], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Elem
  2. Immutable
  3. IsNavigable
  4. IsNavigableApi
  5. ScopedElemLike
  6. HasText
  7. HasEName
  8. ElemLike
  9. ScopedElemApi
  10. HasTextApi
  11. HasScopeApi
  12. HasQNameApi
  13. HasENameApi
  14. ElemApi
  15. AnyRef
  16. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

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

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

  8. final def ancestryENames: IndexedSeq[EName]

    Returns the ENames of the ancestry, starting with the root element and ending with the parent of this element, if any.

    Returns the ENames of the ancestry, starting with the root element and ending with the parent of this element, if any.

    That is, returns:

    ancestryOrSelfENames.dropRight(1)

  9. final def ancestryOrSelfENames: IndexedSeq[EName]

    Returns the ENames of the ancestry-or-self, starting with the root element and ending with this element.

    Returns the ENames of the ancestry-or-self, starting with the root element and ending with this element.

    That is, returns:

    rootElem.resolvedName +: path.entries.map(_.elementName)

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

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

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

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

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

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

  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
    Elem → HasQNameApi

  18. final def baseUri: URI

    Returns the base URI of the element, by XML Base processing starting with the document URI.

    Returns the base URI of the element, by XML Base processing starting with the document URI. That is, returns baseUriOfAncestorOrSelf(path).

  19. final def baseUriOfAncestorOrSelf(ancestorOrSelfPath: Path): URI

    Returns the base URI of an ancestor-or-self element.

  20. def clone(): AnyRef

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

  21. val docUri: URI

  22. val elem: simple.Elem

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

    Definition Classes
    AnyRef

  24. def equals(obj: Any): Boolean

    Definition Classes
    Elem → AnyRef → Any

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

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

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

  28. def finalize(): Unit

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

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

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

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

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

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

  34. def findChildElemByPathEntry(entry: Entry): Option[Elem]

    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
    Elem → IsNavigable → IsNavigableApi

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

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

  37. final def findElemOrSelfByPath(path: Path): Option[Elem]

    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

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

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

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

  41. final def getChildElemByPathEntry(entry: Entry): Elem

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

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

    Definition Classes
    IsNavigable → IsNavigableApi

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

    Definition Classes
    AnyRef → Any

  43. final def getElemOrSelfByPath(path: Path): Elem

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

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

    Definition Classes
    IsNavigable → IsNavigableApi

  44. def hashCode(): Int

    Definition Classes
    Elem → AnyRef → Any

  45. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

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

  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
    HasText → HasTextApi

  50. final def notify(): Unit

    Definition Classes
    AnyRef

  51. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  52. val path: Path

  53. def qname: QName

    The QName of the element

    The QName of the element

    Definition Classes
    Elem → HasQNameApi

  54. def resolvedAttributes: IndexedSeq[(EName, String)]

    The resolved attributes of the element as mapping from ENames to values

    The resolved attributes of the element as mapping from ENames to values

    Definition Classes
    Elem → HasENameApi

  55. def resolvedName: EName

    The EName of the element

    The EName of the element

    Definition Classes
    Elem → HasENameApi

  56. val rootElem: simple.Elem

  57. final def scope: Scope

    Returns this.elem.scope

    Returns this.elem.scope

    Definition Classes
    Elem → HasScopeApi

  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 → HasTextApi

  60. final def textAsQName: QName

    Returns QName(text.trim)

    Returns QName(text.trim)

    Definition Classes
    ScopedElemLike → ScopedElemApi

  61. final def textAsResolvedQName: EName

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

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

    Definition Classes
    ScopedElemLike → ScopedElemApi

  62. def toString(): String

    Definition Classes
    AnyRef → Any

  63. final def trimmedText: String

    Returns text.trim.

    Returns text.trim.

    Definition Classes
    HasText → HasTextApi

  64. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Immutable

Inherited from IsNavigable[Elem]

Inherited from IsNavigableApi[Elem]

Inherited from ScopedElemLike[Elem]

Inherited from HasText

Inherited from HasEName

Inherited from ElemLike[Elem]

Inherited from ScopedElemApi[Elem]

Inherited from HasTextApi

Inherited from HasScopeApi

Inherited from HasQNameApi

Inherited from HasENameApi

Inherited from ElemApi[Elem]

Inherited from AnyRef

Inherited from Any

Ungrouped