ScopedElemApi

Type Members

abstract type ThisElem <: ScopedElemApi

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
ScopedElemApi → ClarkElemApi → IsNavigableApi → ElemApi → AnyElemApi

Abstract Value Members

abstract 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
ElemApi
abstract def \@(expandedName: EName): Option[String]

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

Definition Classes
HasENameApi
abstract 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
ElemApi
abstract 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
ElemApi
abstract 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
HasENameApi
abstract def attributeAsQName(expandedName: EName): QName

Returns the QName value of the attribute with the given expanded name, and throws an exception otherwise
abstract 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.
abstract 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
abstract 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.
abstract 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
HasENameApi
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 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
ElemApi
abstract 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
ElemApi
abstract 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
ElemApi
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
ElemApi
abstract def findAllChildElemsWithPathEntries: IndexedSeq[(ThisElem, Entry)]

Returns all child elements paired with their path entries.
Returns all child elements paired with their path entries.

Definition Classes
IsNavigableApi
abstract 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
ElemApi
abstract 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
ElemApi
abstract 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
HasENameApi
abstract 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
ElemApi
abstract 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.
Typically this method must be very efficient, in order for methods like findElemOrSelfByPath to be efficient.

Definition Classes
IsNavigableApi
abstract 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
ElemApi
abstract 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
ElemApi
abstract 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
IsNavigableApi
abstract 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
IsNavigableApi
abstract 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
ElemApi
abstract 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
ElemApi
abstract 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
ElemApi
abstract def getChildElemByPathEntry(entry: Entry): ThisElem

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

Definition Classes
IsNavigableApi
abstract def getElemOrSelfByPath(path: Path): ThisElem

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

Definition Classes
IsNavigableApi
abstract def getReverseAncestryOrSelfByPath(path: Path): IndexedSeq[ThisElem]

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

Definition Classes
IsNavigableApi
abstract 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
HasENameApi
abstract def normalizedText: String

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

Definition Classes
HasTextApi
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 textAsQName: QName

Returns QName(text.trim)
abstract def textAsResolvedQName: EName

Returns the equivalent of scope.resolveQNameOption(textAsQName).get
abstract def thisElem: ThisElem

This element itself.
This element itself.

Definition Classes
AnyElemApi
abstract def trimmedText: String

Returns text.trim.
Returns text.trim.

Definition Classes
HasTextApi

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 asInstanceOf[T0]: T0

Definition Classes
Any
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
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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 ScopedElemApi | package queryapi

trait ScopedElemApi extends ClarkElemApi with HasQNameApi with HasScopeApi

ScopedElemApi more formally

Type Members

abstract type ThisElem <: ScopedElemApi

Abstract Value Members

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

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

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

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

abstract def attribute(expandedName: EName): String

abstract def attributeAsQName(expandedName: EName): QName

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

abstract def attributeAsResolvedQName(expandedName: EName): EName

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

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

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

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

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

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

abstract def findAllChildElems: IndexedSeq[ThisElem]

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

abstract def findAllElems: IndexedSeq[ThisElem]

abstract def findAllElemsOrSelf: IndexedSeq[ThisElem]

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

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

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

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

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

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

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

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

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

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

abstract def getChildElemByPathEntry(entry: Entry): ThisElem

abstract def getElemOrSelfByPath(path: Path): ThisElem

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

abstract def localName: String

abstract def normalizedText: String

abstract def qname: QName

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

abstract def resolvedName: EName

abstract def scope: Scope

abstract def text: String

abstract def textAsQName: QName

abstract def textAsResolvedQName: EName

abstract def thisElem: ThisElem

abstract def trimmedText: String

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from HasScopeApi

Inherited from HasQNameApi

Inherited from ClarkElemApi

Inherited from HasTextApi

Inherited from HasENameApi

Inherited from IsNavigableApi

Inherited from ElemApi

Inherited from AnyElemApi

Inherited from AnyRef

Inherited from Any

Ungrouped