ScopedElemLike

Type Members

abstract type ThisElem <: ThisElemApi

Definition Classes
AnyElemApi
abstract type ThisElemApi <: ScopedElemLike

Definition Classes
ScopedElemLike → ClarkElemLike → IsNavigable → ElemLike → ScopedElemApi → ClarkElemApi → IsNavigableApi → ElemApi → AnyElemApi

Abstract Value Members

abstract 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
HasQNameApi
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
ElemLike → ElemApi
abstract def qname: QName

The QName of the element
The QName of the element

Definition Classes
HasQNameApi
abstract 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
HasENameApi
abstract def resolvedName: EName

The EName of the element
The EName of the element

Definition Classes
HasENameApi
abstract def scope: Scope

The Scope stored with the element
The Scope stored with the element

Definition Classes
HasScopeApi
abstract 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
HasTextApi
abstract def thisElem: ThisElem

Definition Classes
AnyElemApi

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
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 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
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
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
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
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
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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.
Returns the descendant elements obeying the given predicate. 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.
Returns the descendant-or-self elements obeying the given predicate. 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).
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
final def findAllElemsOrSelf: IndexedSeq[ThisElem]

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
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 (e => e.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
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def textAsQName: QName

Returns QName(text.trim)
Returns QName(text.trim)

Definition Classes
ScopedElemLike → ScopedElemApi
final def textAsResolvedQName: EName

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

Definition Classes
ScopedElemLike → ScopedElemApi
def toString(): String

Definition Classes
AnyRef → Any
final def trimmedText: String

Returns text.trim.
Returns text.trim.

Definition Classes
HasText → HasTextApi
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( ... )

trait ScopedElemLike extends ScopedElemApi with ClarkElemLike

Type Members

abstract type ThisElem <: ThisElemApi

abstract type ThisElemApi <: ScopedElemLike

Abstract Value Members

abstract def attributes: Iterable[(QName, String)]

abstract def findAllChildElems: IndexedSeq[ThisElem]

abstract def qname: QName

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

abstract def resolvedName: EName

abstract def scope: Scope

abstract def text: String

abstract def thisElem: ThisElem

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

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 attributeAsQName(expandedName: EName): QName

final def attributeAsQNameOption(expandedName: EName): Option[QName]

final def attributeAsResolvedQName(expandedName: EName): EName

final def attributeAsResolvedQNameOption(expandedName: EName): Option[EName]

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

def clone(): AnyRef

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

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

final def textAsQName: QName

final def textAsResolvedQName: EName

def toString(): String

final def trimmedText: String

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 ScopedElemApi

Inherited from HasScopeApi

Inherited from HasQNameApi

Inherited from ClarkElemApi

Inherited from HasTextApi