IsNavigable

Type Members

abstract type ThisElem <: Aux[ThisElem]

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
IsNavigable → IsNavigableApi → AnyElemApi

Abstract Value Members

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
IsNavigable → IsNavigableApi
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
IsNavigable → IsNavigableApi
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 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 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 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 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 IsNavigable | package queryapi

trait IsNavigable extends IsNavigableApi

Type Members

abstract type ThisElem <: Aux[ThisElem]

Abstract Value Members

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

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

abstract def thisElem: ThisElem

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 findElemOrSelfByPath(path: Path): Option[ThisElem]

final def findReverseAncestryOrSelfByPath(path: Path): Option[IndexedSeq[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 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 IsNavigableApi

Inherited from AnyElemApi

Inherited from AnyRef

Inherited from Any

Ungrouped