AbstractIndexedClarkElem

Instance Constructors

new AbstractIndexedClarkElem(docUriOption: Option[URI], parentBaseUriOption: Option[URI], underlyingRootElem: U, path: Path, underlyingElem: U)

Type Members

abstract type ThisElem <: Aux[ThisElem, U]

The element type itself.
The element type itself. It must be restricted to a sub-type of the query API trait in question.
Concrete element classes will restrict this type to that element class itself.

Definition Classes
AbstractIndexedClarkElem → ClarkElemLike → IsNavigable → ElemLike → IndexedClarkElemApi → ClarkElemApi → IsNavigableApi → ElemApi → AnyElemApi

Abstract Value Members

abstract def findAllChildElems: IndexedSeq[ThisElem]

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
AbstractIndexedClarkElem → ElemLike → ElemApi
abstract def reverseAncestryOrSelf: IndexedSeq[ThisElem]

Returns the reversed ancestor-or-self elements.
Returns the reversed ancestor-or-self elements. That is, returns:
```
rootElem.findReverseAncestryOrSelfByPath(path).get
```
Definition Classes
AbstractIndexedClarkElem → IndexedClarkElemApi
abstract def rootElem: ThisElem

The root element
The root element

Definition Classes
AbstractIndexedClarkElem → IndexedClarkElemApi
abstract def thisElem: ThisElem

This element itself.
This element itself.

Definition Classes
AnyElemApi

Concrete Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
final def \(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

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

Definition Classes
ElemLike → ElemApi
final def \@(expandedName: EName): Option[String]

Shorthand for attributeOption(expandedName).
Shorthand for attributeOption(expandedName).

Definition Classes
HasEName → HasENameApi
final def \\(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

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

Definition Classes
ElemLike → ElemApi
final def \\!(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

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

Definition Classes
ElemLike → ElemApi
final def asInstanceOf[T0]: T0

Definition Classes
Any
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
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
final def baseUri: URI

Returns the base URI, falling back to the empty URI if absent.
Returns the base URI, falling back to the empty URI if absent.

Definition Classes
AbstractIndexedClarkElem → IndexedClarkElemApi
final def baseUriOption: Option[URI]

Returns the optional base URI.
Returns the optional base URI. This method is fast, due to the use of the optional base URI of the parent element, if any.

Definition Classes
AbstractIndexedClarkElem → IndexedClarkElemApi
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def docUri: URI

Returns the document URI, falling back to the empty URI if absent.
Returns the document URI, falling back to the empty URI if absent.

Definition Classes
AbstractIndexedClarkElem → IndexedClarkElemApi
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
AbstractIndexedClarkElem → IndexedClarkElemApi
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
final def filterChildElems(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

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: ThisElem => Boolean): immutable.IndexedSeq[ThisElem] =
  this.findAllChildElems.filter(p)
```
Definition Classes
ElemLike → ElemApi
final def filterElems(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

Returns the descendant elements obeying the given predicate, in document order.
Returns the descendant elements obeying the given predicate, in document order. This method could be defined as:
```
this.findAllChildElems flatMap (_.filterElemsOrSelf(p))
```
Definition Classes
ElemLike → ElemApi
final def filterElemsOrSelf(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

Returns the descendant-or-self elements obeying the given predicate, in document order.
Returns the descendant-or-self elements obeying the given predicate, in document order. This method could be defined as:
```
def filterElemsOrSelf(p: ThisElem => Boolean): immutable.IndexedSeq[ThisElem] =
  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
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def findAllChildElemsWithPathEntries: IndexedSeq[(ThisElem, 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
ClarkElemLike → IsNavigable → IsNavigableApi
final def findAllElems: IndexedSeq[ThisElem]

Returns all descendant elements (not including this element), in document order.
Returns all descendant elements (not including this element), in document order. This method could be defined as filterElems { e => true }. Equivalent to findAllElemsOrSelf.drop(1).

Definition Classes
ElemLike → ElemApi
final def findAllElemsOrSelf: IndexedSeq[ThisElem]

Returns this element followed by all descendant elements (that is, the descendant-or-self elements), in document order.
Returns this element followed by all descendant elements (that is, the descendant-or-self elements), in document order. This method could be defined as filterElemsOrSelf { e => true }.

Definition Classes
ElemLike → ElemApi
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
final def findChildElem(p: (ThisElem) ⇒ Boolean): Option[ThisElem]

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
final def findChildElemByPathEntry(entry: Entry): Option[ThisElem]

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
ClarkElemLike → IsNavigable → IsNavigableApi
final def findElem(p: (ThisElem) ⇒ Boolean): Option[ThisElem]

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

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
final def findElemOrSelfByPath(path: Path): Option[ThisElem]

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(_.findElemOrSelfByPath(path.withoutFirstEntry))
```
Definition Classes
IsNavigable → IsNavigableApi
final def findReverseAncestryOrSelfByPath(path: Path): Option[IndexedSeq[ThisElem]]

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
IsNavigable → IsNavigableApi
final def findTopmostElems(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

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

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: ThisElem => Boolean): immutable.IndexedSeq[ThisElem] =
  if (p(this)) Vector(this)
  else (this.findAllChildElems flatMap (_.findTopmostElemsOrSelf(p)))
```
Definition Classes
ElemLike → ElemApi
final def getChildElem(p: (ThisElem) ⇒ Boolean): ThisElem

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
final def getChildElemByPathEntry(entry: Entry): ThisElem

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

Definition Classes
IsNavigable → IsNavigableApi
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def getElemOrSelfByPath(path: Path): ThisElem

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

Definition Classes
IsNavigable → IsNavigableApi
final def getReverseAncestryOrSelfByPath(path: Path): IndexedSeq[ThisElem]

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

Definition Classes
IsNavigable → IsNavigableApi
def hashCode(): Int

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

Definition Classes
Any
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
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def normalizedText: String

Returns XmlStringUtils.normalizeString(text).
Returns XmlStringUtils.normalizeString(text).

Definition Classes
HasText → HasTextApi
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val parentBaseUriOption: Option[URI]

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

Definition Classes
AbstractIndexedClarkElem → IndexedClarkElemApi
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
AbstractIndexedClarkElem → IndexedClarkElemApi
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
AbstractIndexedClarkElem → HasENameApi
final def resolvedName: EName

The EName of the element
The EName of the element

Definition Classes
AbstractIndexedClarkElem → HasENameApi
final def reverseAncestry: IndexedSeq[ThisElem]

Returns the reversed ancestor elements.
Returns the reversed ancestor elements. That is, returns:
```
reverseAncestryOrSelf.init
```
Definition Classes
AbstractIndexedClarkElem → IndexedClarkElemApi
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
AbstractIndexedClarkElem → IndexedClarkElemApi
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
AbstractIndexedClarkElem → IndexedClarkElemApi
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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
AbstractIndexedClarkElem → HasTextApi
def toString(): String

Definition Classes
AnyRef → Any
final def trimmedText: String

Returns text.trim.
Returns text.trim.

Definition Classes
HasText → HasTextApi
val underlyingElem: U
val underlyingRootElem: U
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object AbstractIndexedClarkElem | package indexed

abstract class AbstractIndexedClarkElem[U <: Aux[U]] extends queryapi.Nodes.Elem with IndexedClarkElemApi with ClarkElemLike

Instance Constructors

new AbstractIndexedClarkElem(docUriOption: Option[URI], parentBaseUriOption: Option[URI], underlyingRootElem: U, path: Path, underlyingElem: U)

Type Members

abstract type ThisElem <: Aux[ThisElem, U]

Abstract Value Members

abstract def findAllChildElems: IndexedSeq[ThisElem]

abstract def reverseAncestryOrSelf: IndexedSeq[ThisElem]

abstract def rootElem: ThisElem

abstract def thisElem: ThisElem

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def \(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

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

final def \\(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

final def \\!(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

final def asInstanceOf[T0]: T0

final def attribute(expandedName: EName): String

final def attributeOption(expandedName: EName): Option[String]

final def baseUri: URI

final def baseUriOption: Option[URI]

def clone(): AnyRef

final def docUri: URI

val docUriOption: Option[URI]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def filterChildElems(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

final def filterElems(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

final def filterElemsOrSelf(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

def finalize(): Unit

final def findAllChildElemsWithPathEntries: IndexedSeq[(ThisElem, Entry)]

final def findAllElems: IndexedSeq[ThisElem]

final def findAllElemsOrSelf: IndexedSeq[ThisElem]

final def findAttributeByLocalName(localName: String): Option[String]

final def findChildElem(p: (ThisElem) ⇒ Boolean): Option[ThisElem]

final def findChildElemByPathEntry(entry: Entry): Option[ThisElem]

final def findElem(p: (ThisElem) ⇒ Boolean): Option[ThisElem]

final def findElemOrSelf(p: (ThisElem) ⇒ Boolean): Option[ThisElem]

final def findElemOrSelfByPath(path: Path): Option[ThisElem]

final def findReverseAncestryOrSelfByPath(path: Path): Option[IndexedSeq[ThisElem]]

final def findTopmostElems(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

final def findTopmostElemsOrSelf(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

final def getChildElem(p: (ThisElem) ⇒ Boolean): ThisElem

final def getChildElemByPathEntry(entry: Entry): ThisElem

final def getClass(): Class[_]

final def getElemOrSelfByPath(path: Path): ThisElem

final def getReverseAncestryOrSelfByPath(path: Path): IndexedSeq[ThisElem]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def localName: String

final def ne(arg0: AnyRef): Boolean

final def normalizedText: String

final def notify(): Unit

final def notifyAll(): Unit

val parentBaseUriOption: Option[URI]

val path: Path

final def resolvedAttributes: Iterable[(EName, String)]

final def resolvedName: EName

final def reverseAncestry: IndexedSeq[ThisElem]

final def reverseAncestryENames: IndexedSeq[EName]

final def reverseAncestryOrSelfENames: IndexedSeq[EName]

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

final def text: String

def toString(): String

final def trimmedText: String

val underlyingElem: U

val underlyingRootElem: U

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from ClarkElemLike

Inherited from HasText

Inherited from HasEName

Inherited from IsNavigable

Inherited from ElemLike

Inherited from IndexedClarkElemApi