eu.cdevreeze.tqa.common.xpointer

Type members

Classlikes

final case class ChildSequencePointer(childSequence: List[Int]) extends ElementSchemePointer

Element-scheme XPointer containing (only) a child sequence. The indexes in the child sequence are 1-based.

Element-scheme XPointer containing (only) a child sequence. The indexes in the child sequence are 1-based.

final case class ElemPointer(docUri: URI, xpointer: XPointer)

Element pointer, consisting of a document URI and an XPointer. This combination points to an XML element in a set of documents, such as a taxonomy.

Element pointer, consisting of a document URI and an XPointer. This combination points to an XML element in a set of documents, such as a taxonomy.

Note that different XPointers may point to the same element, given the document. Therefore equality of XPointers, and by extension, element pointers, is not a reliable method for determining whether the elements pointed to are the same.

An element pointer corresponds to a URI containing the document URI and the XPointer as fragment part.

Authors

Chris de Vreeze

Companion
object
object ElemPointer
Companion
class
sealed trait ElementSchemePointer extends XPointer
final case class IdChildSequencePointer(id: String, childSequence: List[Int]) extends ElementSchemePointer with XPointerContainingId

Element-scheme XPointer starting with an ID and followed by a child sequence. The indexes in the child sequence are 1-based.

Element-scheme XPointer starting with an ID and followed by a child sequence. The indexes in the child sequence are 1-based.

final case class IdPointer(id: String) extends ElementSchemePointer with XPointerContainingId

Element-scheme XPointer containing only an ID. It is therefore semantically equivalent to a shorthand pointer.

Element-scheme XPointer containing only an ID. It is therefore semantically equivalent to a shorthand pointer.

final case class ShorthandPointer(id: String) extends XPointerContainingId

Shorthand pointer, which is by far the most commonly used kind of XPointer in XBRL (and in general).

Shorthand pointer, which is by far the most commonly used kind of XPointer in XBRL (and in general).

sealed trait XPointer

XPointer, with sub-types for shorthand pointers and element scheme pointers.

XPointer, with sub-types for shorthand pointers and element scheme pointers.

Note that a locator href attribute may contain multiple element scheme pointers in succession. Method parseXPointers in the XPointer companion object can parse those successive XPointers.

Authors

Chris de Vreeze

Companion
object
object XPointer
Companion
class
sealed trait XPointerContainingId extends XPointer

XPointer containing an ID. The significance of such an XPointer is that if we know that IDs are unique across documents, we need no document URI context other than the XPointer to find an XML element in a set of documents.

XPointer containing an ID. The significance of such an XPointer is that if we know that IDs are unique across documents, we need no document URI context other than the XPointer to find an XML element in a set of documents.