eu.cdevreeze.yaidom.indexed

LazyIndexedScopedElem

final class LazyIndexedScopedElem[U <: ScopedElemApi[U]] extends queryapi.Nodes.Elem with IndexedScopedElemLike[LazyIndexedScopedElem[U], U]

Very lightweight lazy indexed element implementation. It offers the IndexedScopedElemApi query API. It is optimized for fast (just-in-time) element creation, not for fast querying.

U

The underlying element type

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. LazyIndexedScopedElem
  2. IndexedScopedElemLike
  3. ScopedElemLike
  4. IndexedClarkElemLike
  5. ClarkElemLike
  6. HasText
  7. HasEName
  8. IsNavigable
  9. ElemLike
  10. IndexedScopedElemApi
  11. ScopedElemApi
  12. HasScopeApi
  13. HasQNameApi
  14. IndexedClarkElemApi
  15. ClarkElemApi
  16. HasTextApi
  17. HasENameApi
  18. IsNavigableApi
  19. ElemApi
  20. Elem
  21. CanBeDocumentChild
  22. Node
  23. AnyRef
  24. 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 \(p: (LazyIndexedScopedElem[U]) ⇒ Boolean): IndexedSeq[LazyIndexedScopedElem[U]]

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

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

    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. final def attributes: Iterable[(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
    IndexedScopedElemLikeHasQNameApi
  18. final def baseUriOption: Option[URI]

    Returns the optional base URI, computed from the document URI, if any, and the XML base attributes of the ancestors, if any.

    Returns the optional base URI, computed from the document URI, if any, and the XML base attributes of the ancestors, if any.

    Definition Classes
    LazyIndexedScopedElemIndexedScopedElemLikeIndexedClarkElemLikeIndexedClarkElemApi
  19. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. val docUriOption: Option[URI]

    The optional document URI of the containing document, if any

    The optional document URI of the containing document, if any

    Definition Classes
    LazyIndexedScopedElemIndexedScopedElemLikeIndexedClarkElemLikeIndexedClarkElemApi
  21. val elem: U

    The underlying element, of the underlying element type.

    The underlying element, of the underlying element type. It must be equal to:

    rootElem.getElemOrSelfByPath(path)
    Definition Classes
    LazyIndexedScopedElemIndexedScopedElemLikeIndexedClarkElemLikeIndexedClarkElemApi
  22. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    LazyIndexedScopedElem → AnyRef → Any
  24. final def filterChildElems(p: (LazyIndexedScopedElem[U]) ⇒ Boolean): IndexedSeq[LazyIndexedScopedElem[U]]

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

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. final def findAllChildElems: IndexedSeq[LazyIndexedScopedElem[U]]

    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
    LazyIndexedScopedElemIndexedScopedElemLikeIndexedClarkElemLikeElemLikeElemApi
  29. final def findAllChildElemsWithPathEntries: IndexedSeq[(LazyIndexedScopedElem[U], 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
    ClarkElemLikeIsNavigableIsNavigableApi
  30. final def findAllElems: IndexedSeq[LazyIndexedScopedElem[U]]

    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
  31. final def findAllElemsOrSelf: IndexedSeq[LazyIndexedScopedElem[U]]

    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
  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
    HasENameHasENameApi
  33. final def findChildElem(p: (LazyIndexedScopedElem[U]) ⇒ Boolean): Option[LazyIndexedScopedElem[U]]

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

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

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

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

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

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

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

    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
  41. final def getChildElem(p: (LazyIndexedScopedElem[U]) ⇒ Boolean): LazyIndexedScopedElem[U]

    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
  42. final def getChildElemByPathEntry(entry: Entry): LazyIndexedScopedElem[U]

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

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

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

    Definition Classes
    AnyRef → Any
  44. final def getElemOrSelfByPath(path: Path): LazyIndexedScopedElem[U]

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

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

    Definition Classes
    IsNavigableIsNavigableApi
  45. final def getReverseAncestryOrSelfByPath(path: Path): IndexedSeq[LazyIndexedScopedElem[U]]

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

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

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

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

    Definition Classes
    Any
  48. 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
  49. 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.

    Definition Classes
    IndexedScopedElemLikeIndexedScopedElemApi
  50. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  51. final def normalizedText: String

    Returns XmlStringUtils.normalizeString(text).

    Returns XmlStringUtils.normalizeString(text).

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

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

    Definition Classes
    AnyRef
  54. val path: Path

    The path of this element, relative to the root element

    The path of this element, relative to the root element

    Definition Classes
    LazyIndexedScopedElemIndexedScopedElemLikeIndexedClarkElemLikeIndexedClarkElemApi
  55. final def qname: QName

    The QName of the element

    The QName of the element

    Definition Classes
    IndexedScopedElemLikeHasQNameApi
  56. final def resolvedAttributes: Iterable[(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
    IndexedClarkElemLikeHasENameApi
  57. final def resolvedName: EName

    The EName of the element

    The EName of the element

    Definition Classes
    IndexedClarkElemLikeHasENameApi
  58. final def reverseAncestryENames: IndexedSeq[EName]

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

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

    That is, returns:

    reverseAncestryOrSelfENames.dropRight(1)
    Definition Classes
    IndexedClarkElemLikeIndexedClarkElemApi
  59. final def reverseAncestryOrSelf: IndexedSeq[U]

    Returns the reversed ancestor-or-self elements.

    Returns the reversed ancestor-or-self elements. That is, returns:

    rootElem.findReverseAncestryOrSelfByPath(path).get
    Definition Classes
    IndexedClarkElemLikeIndexedClarkElemApi
  60. final def reverseAncestryOrSelfENames: IndexedSeq[EName]

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

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

    That is, returns:

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

    This is equal to:

    reverseAncestryOrSelf.map(_.resolvedName)
    Definition Classes
    IndexedClarkElemLikeIndexedClarkElemApi
  61. val rootElem: U

    The root element of the underlying element type

    The root element of the underlying element type

    Definition Classes
    LazyIndexedScopedElemIndexedScopedElemLikeIndexedClarkElemLikeIndexedClarkElemApi
  62. final def scope: Scope

    The Scope stored with the element

    The Scope stored with the element

    Definition Classes
    IndexedScopedElemLikeHasScopeApi
  63. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  64. final def text: String

    Returns the concatenation of the text values of (the implicit) text children, including whitespace and CData.

    Returns the concatenation of the text values of (the implicit) text children, including whitespace and CData. Non-text children are ignored. If there are no text children, the empty string is returned.

    Therefore, element children are ignored and do not contribute to the resulting text string.

    Definition Classes
    IndexedClarkElemLikeHasTextApi
  65. final def textAsQName: QName

    Returns QName(text.trim)

    Returns QName(text.trim)

    Definition Classes
    ScopedElemLikeScopedElemApi
  66. final def textAsResolvedQName: EName

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

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

    Definition Classes
    ScopedElemLikeScopedElemApi
  67. def toString(): String

    Definition Classes
    AnyRef → Any
  68. final def trimmedText: String

    Returns text.trim.

    Returns text.trim.

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from HasText

Inherited from HasEName

Inherited from IsNavigable[LazyIndexedScopedElem[U]]

Inherited from ElemLike[LazyIndexedScopedElem[U]]

Inherited from HasScopeApi

Inherited from HasQNameApi

Inherited from ClarkElemApi[LazyIndexedScopedElem[U]]

Inherited from HasTextApi

Inherited from HasENameApi

Inherited from ElemApi[LazyIndexedScopedElem[U]]

Inherited from queryapi.Nodes.Elem

Inherited from CanBeDocumentChild

Inherited from Node

Inherited from AnyRef

Inherited from Any

Ungrouped