ParentElemApi

API for elements as containers of elements, as element nodes in a node tree. See eu.cdevreeze.yaidom.ParentElemLike.

This purely abstract query API trait leaves the implementation (but not the semantics) completely open. For example, an implementation backed by an XML database would not use the ParentElemLike implementation, for reasons of efficiency.

The basic operations of this trait are \ (alias for filterChildElems), \\ (alias for filterElemsOrSelf) and \\! (alias for findTopmostElemsOrSelf). Their semantics must be as if they had been defined as follows:

def filterChildElems(p: E => Boolean): immutable.IndexedSeq[E] =
  this.findAllChildElems.filter(p)

def filterElemsOrSelf(p: E => Boolean): immutable.IndexedSeq[E] =
  Vector(this).filter(p) ++ (this.findAllChildElems flatMap (_.filterElemsOrSelf(p)))

def findTopmostElemsOrSelf(p: E => Boolean): immutable.IndexedSeq[E] =
  if (p(this)) Vector(this)
  else (this.findAllChildElems flatMap (_.findTopmostElemsOrSelf(p)))

Similarly, we could have defined:

def filterElems(p: E => Boolean): immutable.IndexedSeq[E] =
  this.findAllChildElems flatMap (_.filterElemsOrSelf(p))

def findTopmostElems(p: E => Boolean): immutable.IndexedSeq[E] =
  this.findAllChildElems flatMap (_.findTopmostElemsOrSelf(p))

The following properties must hold (in the absence of side-effects), and can indeed be proven (given the documented "definitions" of these operations):

// Filtering

elem.filterElems(p) == elem.findAllElems.filter(p)

elem.filterElemsOrSelf(p) == elem.findAllElemsOrSelf.filter(p)

// Finding topmost

elem.findTopmostElems(p) == {
  elem.filterElems(p) filter { e =>
    val hasNoMatchingAncestor = elem.filterElems(p) forall { _.findElem(_ == e).isEmpty }
    hasNoMatchingAncestor
  }
}

elem.findTopmostElemsOrSelf(p) == {
  elem.filterElemsOrSelf(p) filter { e =>
    val hasNoMatchingAncestor = elem.filterElemsOrSelf(p) forall { _.findElem(_ == e).isEmpty }
    hasNoMatchingAncestor
  }
}

(elem.findTopmostElems(p) flatMap (_.filterElemsOrSelf(p))) == (elem.filterElems(p))

(elem.findTopmostElemsOrSelf(p) flatMap (_.filterElemsOrSelf(p))) == (elem.filterElemsOrSelf(p))

E: The captured element subtype

Self Type: E

Linear Supertypes

AnyRef, Any

Known Subclasses

DomElem, Elem, Elem, Elem, ElemApi, ElemBuilder, ElemLike, ParentElemLike, PathAwareElemApi, PathAwareElemLike, UpdatableElemApi, UpdatableElemLike

Abstract Value Members

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

Shorthand for filterChildElems(p).
Shorthand for filterChildElems(p). Use this shorthand only if the predicate is a short expression.
abstract def \\(p: (E) ⇒ Boolean): IndexedSeq[E]

Shorthand for filterElemsOrSelf(p).
Shorthand for filterElemsOrSelf(p). Use this shorthand only if the predicate is a short expression.
abstract def \\!(p: (E) ⇒ Boolean): IndexedSeq[E]

Shorthand for findTopmostElemsOrSelf(p).
Shorthand for findTopmostElemsOrSelf(p). Use this shorthand only if the predicate is a short expression.
abstract def filterChildElems(p: (E) ⇒ Boolean): IndexedSeq[E]

Core method that returns the child elements obeying the given predicate.
Core method that 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)
```
abstract def filterElems(p: (E) ⇒ Boolean): IndexedSeq[E]

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))
```
abstract def filterElemsOrSelf(p: (E) ⇒ Boolean): IndexedSeq[E]

Core method that returns the descendant-or-self elements obeying the given predicate.
Core method that 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.
abstract def findAllChildElems: IndexedSeq[E]

Returns all child elements, in the correct order.
Returns all child elements, in the correct order. Other operations can be defined in terms of this one.
abstract def findAllElems: IndexedSeq[E]

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).
abstract def findAllElemsOrSelf: IndexedSeq[E]

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 }.
abstract def findChildElem(p: (E) ⇒ Boolean): Option[E]

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.
abstract def findElem(p: (E) ⇒ Boolean): Option[E]

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.
abstract def findElemOrSelf(p: (E) ⇒ Boolean): Option[E]

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.
abstract def findTopmostElems(p: (E) ⇒ Boolean): IndexedSeq[E]

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))
```
abstract def findTopmostElemsOrSelf(p: (E) ⇒ Boolean): IndexedSeq[E]

Core method that returns the descendant-or-self elements obeying the given predicate, such that no ancestor obeys the predicate.
Core method that 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)))
```
abstract def getChildElem(p: (E) ⇒ Boolean): E

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.

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 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()
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()

trait ParentElemApi[E <: ParentElemApi[E]] extends AnyRef

Abstract Value Members

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

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

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

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

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

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

abstract def findAllChildElems: IndexedSeq[E]

abstract def findAllElems: IndexedSeq[E]

abstract def findAllElemsOrSelf: IndexedSeq[E]

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

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

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

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

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

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

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 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 AnyRef

Inherited from Any

Ungrouped