Class/Object

eu.cdevreeze.yaidom.indexed

LazyIndexedClarkElem

Related Docs: object LazyIndexedClarkElem | package indexed

Permalink

final class LazyIndexedClarkElem[U <: ClarkElemApi[U]] extends queryapi.Nodes.Elem with IndexedClarkElemLike[LazyIndexedClarkElem[U], U]

Very lightweight lazy indexed element implementation. It offers the IndexedClarkElemApi 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. LazyIndexedClarkElem
  2. IndexedClarkElemLike
  3. ClarkElemLike
  4. HasText
  5. HasEName
  6. IsNavigable
  7. ElemLike
  8. IndexedClarkElemApi
  9. ClarkElemApi
  10. HasTextApi
  11. HasENameApi
  12. IsNavigableApi
  13. ElemApi
  14. Elem
  15. CanBeDocumentChild
  16. Node
  17. AnyRef
  18. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def \(p: (LazyIndexedClarkElem[U]) ⇒ Boolean): IndexedSeq[LazyIndexedClarkElem[U]]

    Permalink

    Shorthand for filterChildElems(p).

    Shorthand for filterChildElems(p). Use this shorthand only if the predicate is a short expression.

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

    Permalink

    Shorthand for attributeOption(expandedName).

    Shorthand for attributeOption(expandedName).

    Definition Classes
    HasENameHasENameApi
  6. final def \\(p: (LazyIndexedClarkElem[U]) ⇒ Boolean): IndexedSeq[LazyIndexedClarkElem[U]]

    Permalink

    Shorthand for filterElemsOrSelf(p).

    Shorthand for filterElemsOrSelf(p). Use this shorthand only if the predicate is a short expression.

    Definition Classes
    ElemLikeElemApi
  7. final def \\!(p: (LazyIndexedClarkElem[U]) ⇒ Boolean): IndexedSeq[LazyIndexedClarkElem[U]]

    Permalink

    Shorthand for findTopmostElemsOrSelf(p).

    Shorthand for findTopmostElemsOrSelf(p). Use this shorthand only if the predicate is a short expression.

    Definition Classes
    ElemLikeElemApi
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. final def attribute(expandedName: EName): String

    Permalink

    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
  10. final def attributeOption(expandedName: EName): Option[String]

    Permalink

    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
  11. final def baseUriOption: Option[URI]

    Permalink

    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
    LazyIndexedClarkElemIndexedClarkElemLikeIndexedClarkElemApi
  12. def clone(): AnyRef

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

    Permalink

    The optional document URI of the containing document, if any

    The optional document URI of the containing document, if any

    Definition Classes
    LazyIndexedClarkElemIndexedClarkElemLikeIndexedClarkElemApi
  14. val elem: U

    Permalink

    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
    LazyIndexedClarkElemIndexedClarkElemLikeIndexedClarkElemApi
  15. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    LazyIndexedClarkElem → AnyRef → Any
  17. final def filterChildElems(p: (LazyIndexedClarkElem[U]) ⇒ Boolean): IndexedSeq[LazyIndexedClarkElem[U]]

    Permalink

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

    Permalink

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

    Permalink

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

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

    Permalink

    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
    LazyIndexedClarkElemIndexedClarkElemLikeElemLikeElemApi
  22. final def findAllChildElemsWithPathEntries: IndexedSeq[(LazyIndexedClarkElem[U], Entry)]

    Permalink

    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
  23. final def findAllElems: IndexedSeq[LazyIndexedClarkElem[U]]

    Permalink

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

    Permalink

    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
  25. final def findAttributeByLocalName(localName: String): Option[String]

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  37. final def getElemOrSelfByPath(path: Path): LazyIndexedClarkElem[U]

    Permalink

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

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

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

    Permalink

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

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

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

    Permalink
    Definition Classes
    LazyIndexedClarkElem → AnyRef → Any
  40. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  41. final def localName: String

    Permalink

    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
  42. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  43. final def normalizedText: String

    Permalink

    Returns XmlStringUtils.normalizeString(text).

    Returns XmlStringUtils.normalizeString(text).

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

    Permalink
    Definition Classes
    AnyRef
  45. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  46. val path: Path

    Permalink

    The path of this element, relative to the root element

    The path of this element, relative to the root element

    Definition Classes
    LazyIndexedClarkElemIndexedClarkElemLikeIndexedClarkElemApi
  47. final def resolvedAttributes: Iterable[(EName, String)]

    Permalink

    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
  48. final def resolvedName: EName

    Permalink

    The EName of the element

    The EName of the element

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

    Permalink

    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
  50. final def reverseAncestryOrSelf: IndexedSeq[U]

    Permalink

    Returns the reversed ancestor-or-self elements.

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

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

    Permalink

    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
  52. val rootElem: U

    Permalink

    The root element of the underlying element type

    The root element of the underlying element type

    Definition Classes
    LazyIndexedClarkElemIndexedClarkElemLikeIndexedClarkElemApi
  53. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  54. final def text: String

    Permalink

    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
  55. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  56. final def trimmedText: String

    Permalink

    Returns text.trim.

    Returns text.trim.

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ClarkElemLike[LazyIndexedClarkElem[U]]

Inherited from HasText

Inherited from HasEName

Inherited from IsNavigable[LazyIndexedClarkElem[U]]

Inherited from ElemLike[LazyIndexedClarkElem[U]]

Inherited from ClarkElemApi[LazyIndexedClarkElem[U]]

Inherited from HasTextApi

Inherited from HasENameApi

Inherited from ElemApi[LazyIndexedClarkElem[U]]

Inherited from queryapi.Nodes.Elem

Inherited from CanBeDocumentChild

Inherited from Node

Inherited from AnyRef

Inherited from Any

Ungrouped