SubtypeAwareElemLike

Type Members

abstract type ThisElem <: ThisElemApi

The ("stable") element type itself.
The ("stable") element type itself. It is not restricted in the query API traits (only indirectly, through ThisElemApi).
Concrete element classes will restrict this type to that element class itself.
Why do we need 2 type members ThisElem and ThisElemApi and not just ThisElem? Consider for example query method implementations in trait ElemLike. Had we used just one type member ThisElem (restricting it to be a sub-type of ElemLike), then a call of a function like findAllChildElems on another element would not return a value of the same type (ElemLike.this.ThisElem) according to the Scala compiler. To prevent the use of casts, we used 2 type members ThisElem and ThisElemApi instead.

Definition Classes
AnyElemApi
abstract type ThisElemApi <: SubtypeAwareElemLike

Upperbound on type ThisElem, which must be restricted to a sub-type of the query API trait in question.
Upperbound on type ThisElem, which 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.
The purely abstract query API traits (XXXApi) should only restrict this type to a sub-type of the query API trait, without putting any further restrictions on the type. This way these purely abstract traits are easy to use as "generic" element contracts abstracting over multiple backing element implementations (for example, Saxon tiny trees and native yaidom elements) without "infecting" the client code with generics.
To a lesser extent, this should also be true for the partially implemented query API traits (XXXLike).

Definition Classes
SubtypeAwareElemLike → SubtypeAwareElemApi → ElemLike → 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
ElemLike → ElemApi
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 \\(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
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 filterChildElemsOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): IndexedSeq[B]

Returns the child elements of the given sub-type obeying the given predicate.
Returns the child elements of the given sub-type obeying the given predicate.

Definition Classes
SubtypeAwareElemLike → SubtypeAwareElemApi
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 filterElemsOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): IndexedSeq[B]

Returns the descendant elements of the given sub-type obeying the given predicate.
Returns the descendant elements of the given sub-type obeying the given predicate.

Definition Classes
SubtypeAwareElemLike → SubtypeAwareElemApi
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
final def filterElemsOrSelfOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): IndexedSeq[B]

Returns the descendant-or-self elements of the given sub-type obeying the given predicate.
Returns the descendant-or-self elements of the given sub-type obeying the given predicate.

Definition Classes
SubtypeAwareElemLike → SubtypeAwareElemApi
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def findAllChildElemsOfType[B <: ThisElem](subType: ClassTag[B]): IndexedSeq[B]

Returns all child elements of the given sub-type, in the correct order.
Returns all child elements of the given sub-type, in the correct order.

Definition Classes
SubtypeAwareElemLike → SubtypeAwareElemApi
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 findAllElemsOfType[B <: ThisElem](subType: ClassTag[B]): IndexedSeq[B]

Returns all descendant elements of the given sub-type (not including this element).
Returns all descendant elements of the given sub-type (not including this element).

Definition Classes
SubtypeAwareElemLike → SubtypeAwareElemApi
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 findAllElemsOrSelfOfType[B <: ThisElem](subType: ClassTag[B]): IndexedSeq[B]

Returns all descendant-or-self elements of the given sub-type.
Returns all descendant-or-self elements of the given sub-type.

Definition Classes
SubtypeAwareElemLike → SubtypeAwareElemApi
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 findChildElemOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): Option[B]

Returns the first found child element of the given sub-type obeying the given predicate, if any, wrapped in an Option.
Returns the first found child element of the given sub-type obeying the given predicate, if any, wrapped in an Option.

Definition Classes
SubtypeAwareElemLike → SubtypeAwareElemApi
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 findElemOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): Option[B]

Returns the first found (topmost) descendant element of the given sub-type obeying the given predicate, if any, wrapped in an Option.
Returns the first found (topmost) descendant element of the given sub-type obeying the given predicate, if any, wrapped in an Option.

Definition Classes
SubtypeAwareElemLike → SubtypeAwareElemApi
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 findElemOrSelfOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): Option[B]

Returns the first found (topmost) descendant-or-self element of the given sub-type obeying the given predicate, if any, wrapped in an Option.
Returns the first found (topmost) descendant-or-self element of the given sub-type obeying the given predicate, if any, wrapped in an Option.

Definition Classes
SubtypeAwareElemLike → SubtypeAwareElemApi
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 findTopmostElemsOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): IndexedSeq[B]

Returns the descendant elements of the given sub-type obeying the given predicate that have no ancestor of the given sub-type obeying the predicate.
Returns the descendant elements of the given sub-type obeying the given predicate that have no ancestor of the given sub-type obeying the predicate.

Definition Classes
SubtypeAwareElemLike → SubtypeAwareElemApi
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 findTopmostElemsOrSelfOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): IndexedSeq[B]

Returns the descendant-or-self elements of the given sub-type obeying the given predicate, such that no ancestor of the given sub-type obeys the predicate.
Returns the descendant-or-self elements of the given sub-type obeying the given predicate, such that no ancestor of the given sub-type obeys the predicate.

Definition Classes
SubtypeAwareElemLike → SubtypeAwareElemApi
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 getChildElemOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): B

Returns the single child element of the given sub-type obeying the given predicate, and throws an exception otherwise.
Returns the single child element of the given sub-type obeying the given predicate, and throws an exception otherwise.

Definition Classes
SubtypeAwareElemLike → SubtypeAwareElemApi
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 SubtypeAwareElemLike | package queryapi

trait SubtypeAwareElemLike extends ElemLike with SubtypeAwareElemApi

Type Members

abstract type ThisElem <: ThisElemApi

abstract type ThisElemApi <: SubtypeAwareElemLike

Abstract Value Members

abstract def findAllChildElems: IndexedSeq[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 \\(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

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

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

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

final def filterChildElemsOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): IndexedSeq[B]

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

final def filterElemsOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): IndexedSeq[B]

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

final def filterElemsOrSelfOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): IndexedSeq[B]

def finalize(): Unit

final def findAllChildElemsOfType[B <: ThisElem](subType: ClassTag[B]): IndexedSeq[B]

final def findAllElems: IndexedSeq[ThisElem]

final def findAllElemsOfType[B <: ThisElem](subType: ClassTag[B]): IndexedSeq[B]

final def findAllElemsOrSelf: IndexedSeq[ThisElem]

final def findAllElemsOrSelfOfType[B <: ThisElem](subType: ClassTag[B]): IndexedSeq[B]

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

final def findChildElemOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): Option[B]

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

final def findElemOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): Option[B]

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

final def findElemOrSelfOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): Option[B]

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

final def findTopmostElemsOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): IndexedSeq[B]

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

final def findTopmostElemsOrSelfOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): IndexedSeq[B]

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

final def getChildElemOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): B

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 SubtypeAwareElemApi

Inherited from ElemLike

Inherited from ElemApi

Inherited from AnyElemApi

Inherited from AnyRef

Inherited from Any

Ungrouped