AbsolutePath

Absolute path of a descendant (or self) Elem relative to and starting with a root Elem. It represents a unique absolute path to an element, given a root element, independent of other types of nodes, as if the XML tree only consists of elements.

Unlike Path objects, which are navigation paths and relative to some root element, absolute paths are absolute, containing the root element (as absolute path entry) as well. The absolute paths can never be empty (unlike navigation paths).

An eu.cdevreeze.yaidom.core.AbsolutePath corresponds to one and only one canonical path of the element, which is the corresponding (canonical) XPath expression. See http://ns.inria.org/active-tags/glossary/glossary.html#canonical-path. Note, however, that these XPath expression use URI qualified EQ-names rather than qualified names.

The toString format of absolute paths is the same as for the equally named class in Saxon. Note the Saxon absolute paths may be empty, whereas yaidom absolute paths can never be empty. After all, yaidom absolute paths can only be used for elements, not for documents.

Linear Supertypes

Immutable, AnyRef, Any

Instance Constructors

new AbsolutePath(entries: IndexedSeq[Entry])

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
def ancestors: IndexedSeq[AbsolutePath]

Returns the ancestors, starting with the parent (if any), and ending with a root absolute path
def ancestorsOrSelf: IndexedSeq[AbsolutePath]

Returns the ancestors-or-self, starting with this absolute path, then the parent (if any), and ending with a root absolute path.
def append(entry: Entry): AbsolutePath

Appends a given Entry to this AbsolutePath
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def containsName(ename: EName): Boolean

Convenience method returning true if at least one entry has the given element name
def elementName: EName

Returns the element name (as EName) of the last absolute path entry
val entries: IndexedSeq[Entry]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(obj: Any): Boolean

Definition Classes
AbsolutePath → AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def findAncestor(p: (AbsolutePath) ⇒ Boolean): Option[AbsolutePath]

Returns ancestors.find(p)
def findAncestorOrSelf(p: (AbsolutePath) ⇒ Boolean): Option[AbsolutePath]

Returns ancestorsOrSelf.find(p)
def firstEntry: Entry

Returns the first entry
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
def isRoot: Boolean

Returns true if this absolute path has precisely one entry
def lastEntry: Entry

Returns the last entry
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def parent: AbsolutePath

Like parentOption, but unwrapping the result (or throwing an exception otherwise)
def parentOption: Option[AbsolutePath]

Gets the parent (if any, because a root path has no parent) wrapped in an Option.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toCanonicalXPath: String

Returns the corresponding canonical XPath, replacing QNames by URI qualified EQ-names.
Returns the corresponding canonical XPath, replacing QNames by URI qualified EQ-names.
See http://ns.inria.org/active-tags/glossary/glossary.html#canonical-path for (real) canonical XPath.
The XPath expressions returned by this method need no context to convey their semantics, unlike XPath expressions containing QNames (canonical or otherwise). This is an important advantage of these expressions, in spite of their relative verbosity. A good use case is error reporting about parts of XML documents. For example, Saxon-EE uses a similar notation for error reporting (in XML format) in its schema validator.
def toString(): String

Returns toCanonicalXPath
Returns toCanonicalXPath

Definition Classes
AbsolutePath → 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 AbsolutePath | package core

final class AbsolutePath extends Immutable

Instance Constructors

new AbsolutePath(entries: IndexedSeq[Entry])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def ancestors: IndexedSeq[AbsolutePath]

def ancestorsOrSelf: IndexedSeq[AbsolutePath]

def append(entry: Entry): AbsolutePath

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def containsName(ename: EName): Boolean

def elementName: EName

val entries: IndexedSeq[Entry]

final def eq(arg0: AnyRef): Boolean

def equals(obj: Any): Boolean

def finalize(): Unit

def findAncestor(p: (AbsolutePath) ⇒ Boolean): Option[AbsolutePath]

def findAncestorOrSelf(p: (AbsolutePath) ⇒ Boolean): Option[AbsolutePath]

def firstEntry: Entry

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def isRoot: Boolean

def lastEntry: Entry

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def parent: AbsolutePath

def parentOption: Option[AbsolutePath]

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

def toCanonicalXPath: String

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Immutable

Inherited from AnyRef

Inherited from Any

Ungrouped