IsNavigableApi

This trait offers Path-based navigation support.

This trait typically does not show up in application code using yaidom, yet its (uniform) API does. Hence, it makes sense to read the documentation of this trait, knowing that the API is offered by multiple element implementations.

This trait is purely abstract. The most common implementation of this trait is eu.cdevreeze.yaidom.queryapi.IsNavigable.

IsNavigableApi more formally

Some properties are expected to hold for "navigable elements":

getElemOrSelfByPath(Path.Root) == self

findElemOrSelfByPath(path1).flatMap(e => e.findElemOrSelfByPath(path2)) == findElemOrSelfByPath(path1.append(path2))

E: The captured element subtype

Self Type: E

Linear Supertypes

AnyRef, Any

Known Subclasses

ClarkElemApi, ClarkElemLike, DomElem, Elem, Elem, IndexedClarkElem, IndexedClarkElemApi, IndexedClarkElemLike, IndexedScopedElem, IndexedScopedElemApi, IndexedScopedElemLike, IsNavigable, ScalaXmlElem, ScopedElemApi, ScopedElemLike, UpdatableElemApi, UpdatableElemLike

Abstract Value Members

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

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.
abstract def findElemOrSelfByPath(path: Path): Option[E]

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))
```
abstract def findReverseAncestryOrSelfByPath(path: Path): Option[IndexedSeq[E]]

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.
abstract def getChildElemByPathEntry(entry: Entry): E

Returns (the equivalent of) findChildElemByPathEntry(entry).get
abstract def getElemOrSelfByPath(path: Path): E

Returns (the equivalent of) findElemOrSelfByPath(path).get
abstract def getReverseAncestryOrSelfByPath(path: Path): IndexedSeq[E]

Returns (the equivalent of) findReverseAncestryOrSelfByPath(path).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( 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( ... )

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

IsNavigableApi more formally

Abstract Value Members

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

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

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

abstract def getChildElemByPathEntry(entry: Entry): E

abstract def getElemOrSelfByPath(path: Path): E

abstract def getReverseAncestryOrSelfByPath(path: Path): IndexedSeq[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