ReferenceArc

final class ReferenceArc extends StandardArc

An XBRL reference arc. It is a link:referenceArc element.

An XBRL reference arc. It is a link:referenceArc element.

trait XLinkArc
trait XLinkArc
trait XLinkElem
trait XLinkElem
trait SubtypeAwareElemLike
trait SubtypeAwareElemApi
trait ScopedElemLike
trait ClarkElemLike
trait IsNavigable
trait ElemLike
trait Elem
trait ScopedElemApi
trait HasScopeApi
trait HasQNameApi
trait Elem
trait HasChildNodesApi
trait AnyElemNodeApi
trait ClarkElemApi
trait IsNavigableApi
trait ElemApi
trait AnyElemApi
trait Elem
trait CanBeDocumentChild
trait CanBeDocumentChild
trait CanBeDocumentChild
trait Node
trait Node
trait Node
class Object
trait Matchable
class Any

Type members

Inherited types

Inherited from
TaxonomyElem
Inherited from
TaxonomyElem

Value members

Inherited methods

def \(p: ThisElem => Boolean): IndexedSeq[ThisElem]
Inherited from
ElemLike
def \@(expandedName: EName): Option[String]

Shorthand for attributeOption(expandedName).

Shorthand for attributeOption(expandedName).

Inherited from
ClarkElemLike
def \\(p: ThisElem => Boolean): IndexedSeq[ThisElem]
Inherited from
ElemLike
def \\!(p: ThisElem => Boolean): IndexedSeq[ThisElem]
Inherited from
ElemLike
final def arcrole: String

Returns the arcrole. This may fail with an exception if the taxonomy is not schema-valid.

Returns the arcrole. This may fail with an exception if the taxonomy is not schema-valid.

If the taxonomy is not known to be schema-valid, use the following code instead:

attributeOption(ENames.XLinkArcroleEName)
Inherited from
XLinkArc
final override def attribute(expandedName: EName): String
Definition Classes
TaxonomyElem -> ClarkElemLike -> ClarkElemApi
Inherited from
TaxonomyElem
final override def attributeAsQName(expandedName: EName): QName
Definition Classes
TaxonomyElem -> ScopedElemLike -> ScopedElemApi
Inherited from
TaxonomyElem
final override def attributeAsQNameOption(expandedName: EName): Option[QName]
Definition Classes
TaxonomyElem -> ScopedElemLike -> ScopedElemApi
Inherited from
TaxonomyElem
final override def attributeAsResolvedQName(expandedName: EName): EName
Definition Classes
TaxonomyElem -> ScopedElemLike -> ScopedElemApi
Inherited from
TaxonomyElem
final override def attributeAsResolvedQNameOption(expandedName: EName): Option[EName]
Definition Classes
TaxonomyElem -> ScopedElemLike -> ScopedElemApi
Inherited from
TaxonomyElem
override def attributeOption(expandedName: EName): Option[String]
Definition Classes
TaxonomyElem -> ClarkElemLike -> ClarkElemApi
Inherited from
TaxonomyElem
final def attributes: IndexedSeq[(QName, String)]
Inherited from
TaxonomyElem

Returns the Base Set key. This may fail with an exception if the taxonomy is not schema-valid.

Returns the Base Set key. This may fail with an exception if the taxonomy is not schema-valid.

If the taxonomy is not known to be schema-valid, it may be impossible to create a Base Set key.

Inherited from
XLinkArc
final def baseUri: URI
Inherited from
TaxonomyElem
final def baseUriOption: Option[URI]
Inherited from
TaxonomyElem
final def children: IndexedSeq[TaxonomyNode]
Inherited from
TaxonomyElem
final def docUri: URI
Inherited from
TaxonomyElem
final def elr: String

Returns the extended link role of the surrounding extended link element. This may fail with an exception if the taxonomy is not schema-valid.

Returns the extended link role of the surrounding extended link element. This may fail with an exception if the taxonomy is not schema-valid.

If the taxonomy is not known to be schema-valid, use the following code instead:

backingElem.parentOption.flatMap(_.attributeOption(ENames.XLinkRoleEName))
Inherited from
ChildXLink
final override def equals(obj: Any): Boolean
Definition Classes
Inherited from
TaxonomyElem
def filterChildElems(p: ThisElem => Boolean): IndexedSeq[ThisElem]
Inherited from
ElemLike
def filterChildElemsOfType[B <: ThisElem](subType: ClassTag[B])(p: B => Boolean): IndexedSeq[B]
Inherited from
SubtypeAwareElemLike
def filterElems(p: ThisElem => Boolean): IndexedSeq[ThisElem]
Inherited from
ElemLike
def filterElemsOfType[B <: ThisElem](subType: ClassTag[B])(p: B => Boolean): IndexedSeq[B]
Inherited from
SubtypeAwareElemLike
def filterElemsOrSelf(p: ThisElem => Boolean): IndexedSeq[ThisElem]
Inherited from
ElemLike
def filterElemsOrSelfOfType[B <: ThisElem](subType: ClassTag[B])(p: B => Boolean): IndexedSeq[B]
Inherited from
SubtypeAwareElemLike
final def findAllChildElems: IndexedSeq[TaxonomyElem]

Returns all child elements, and returns them extremely fast. This is important for fast querying, at the expense of more expensive recursive creation.

Returns all child elements, and returns them extremely fast. This is important for fast querying, at the expense of more expensive recursive creation.

Inherited from
TaxonomyElem
def findAllChildElemsOfType[B <: ThisElem](subType: ClassTag[B]): IndexedSeq[B]
Inherited from
SubtypeAwareElemLike
override def findAllChildElemsWithPathEntries: IndexedSeq[(ThisElem, Entry)]

Returns all child elements paired with their path entries.

Returns all child elements paired with their path entries.

This method is final, so more efficient implementations for sub-types are not supported. This implementation is only efficient if finding all child elements as well as computing their resolved names is efficient. That is not the case for DOM wrappers or Scala XML Elem wrappers (due to their expensive Scope computations). On the other hand, those wrapper element implementations are convenient, but not intended for heavy use in production. Hence, this method should typically be fast enough.

Definition Classes
ClarkElemLike -> IsNavigable -> IsNavigableApi
Inherited from
ClarkElemLike
def findAllElems: IndexedSeq[ThisElem]
Inherited from
ElemLike
def findAllElemsOfType[B <: ThisElem](subType: ClassTag[B]): IndexedSeq[B]
Inherited from
SubtypeAwareElemLike
def findAllElemsOrSelf: IndexedSeq[ThisElem]
Inherited from
ElemLike
def findAllElemsOrSelfOfType[B <: ThisElem](subType: ClassTag[B]): IndexedSeq[B]
Inherited from
SubtypeAwareElemLike
override def findAttributeByLocalName(localName: String): Option[String]
Definition Classes
TaxonomyElem -> ClarkElemLike -> ClarkElemApi
Inherited from
TaxonomyElem
def findChildElem(p: ThisElem => Boolean): Option[ThisElem]
Inherited from
ElemLike
override 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.

This method is final, so more efficient implementations for sub-types are not supported. This implementation is only efficient if finding all child elements as well as computing their resolved names is efficient. That is not the case for DOM wrappers or Scala XML Elem wrappers (due to their expensive Scope computations). On the other hand, those wrapper element implementations are convenient, but not intended for heavy use in production. Hence, this method should typically be fast enough.

Definition Classes
ClarkElemLike -> IsNavigable -> IsNavigableApi
Inherited from
ClarkElemLike
def findChildElemOfType[B <: ThisElem](subType: ClassTag[B])(p: B => Boolean): Option[B]
Inherited from
SubtypeAwareElemLike
def findElem(p: ThisElem => Boolean): Option[ThisElem]
Inherited from
ElemLike
def findElemOfType[B <: ThisElem](subType: ClassTag[B])(p: B => Boolean): Option[B]
Inherited from
SubtypeAwareElemLike
def findElemOrSelf(p: ThisElem => Boolean): Option[ThisElem]
Inherited from
ElemLike
def findElemOrSelfByPath(path: Path): Option[ThisElem]
Inherited from
IsNavigable
def findElemOrSelfOfType[B <: ThisElem](subType: ClassTag[B])(p: B => Boolean): Option[B]
Inherited from
SubtypeAwareElemLike
def findReverseAncestryOrSelfByPath(path: Path): Option[IndexedSeq[ThisElem]]
Inherited from
IsNavigable
def findTopmostElems(p: ThisElem => Boolean): IndexedSeq[ThisElem]
Inherited from
ElemLike
def findTopmostElemsOfType[B <: ThisElem](subType: ClassTag[B])(p: B => Boolean): IndexedSeq[B]
Inherited from
SubtypeAwareElemLike
def findTopmostElemsOrSelf(p: ThisElem => Boolean): IndexedSeq[ThisElem]
Inherited from
ElemLike
def findTopmostElemsOrSelfOfType[B <: ThisElem](subType: ClassTag[B])(p: B => Boolean): IndexedSeq[B]
Inherited from
SubtypeAwareElemLike
final def from: String

Returns the XLink "from". This may fail with an exception if the taxonomy is not schema-valid.

Returns the XLink "from". This may fail with an exception if the taxonomy is not schema-valid.

If the taxonomy is not known to be schema-valid, use the following code instead:

attributeOption(ENames.XLinkFromEName)
Inherited from
XLinkArc
def getChildElem(p: ThisElem => Boolean): ThisElem
Inherited from
ElemLike
def getChildElemByPathEntry(entry: Entry): ThisElem
Inherited from
IsNavigable
def getChildElemOfType[B <: ThisElem](subType: ClassTag[B])(p: B => Boolean): B
Inherited from
SubtypeAwareElemLike
def getElemOrSelfByPath(path: Path): ThisElem
Inherited from
IsNavigable
def getReverseAncestryOrSelfByPath(path: Path): IndexedSeq[ThisElem]
Inherited from
IsNavigable
final override def hashCode: Int
Definition Classes
Inherited from
TaxonomyElem
final def idOption: Option[String]
Inherited from
TaxonomyElem
final def key: XmlFragmentKey

Returns backingElem.key, or its equivalent.

Returns backingElem.key, or its equivalent.

Inherited from
TaxonomyElem
final override def localName: String
Definition Classes
TaxonomyElem -> ClarkElemLike -> ClarkElemApi
Inherited from
TaxonomyElem
final def nodeKind: NodeKind
Inherited from
Elem
final override def normalizedText: String
Definition Classes
TaxonomyElem -> ClarkElemLike -> ClarkElemApi
Inherited from
TaxonomyElem
final def order: BigDecimal

Returns the "order" decimal attribute (defaulting to 1). This may fail with an exception if the taxonomy is not schema-valid.

Returns the "order" decimal attribute (defaulting to 1). This may fail with an exception if the taxonomy is not schema-valid.

Inherited from
XLinkArc
final def path: Path

Returns key.path, or its equivalent backingElem.path.

Returns key.path, or its equivalent backingElem.path.

Inherited from
TaxonomyElem
final def priority: Int

Returns the "priority" integer attribute (defaulting to 0). This may fail with an exception if the taxonomy is not schema-valid.

Returns the "priority" integer attribute (defaulting to 0). This may fail with an exception if the taxonomy is not schema-valid.

Inherited from
XLinkArc
final def qname: QName
Inherited from
TaxonomyElem
final def resolvedAttributes: IndexedSeq[(EName, String)]
Inherited from
TaxonomyElem
final def resolvedName: EName
Inherited from
TaxonomyElem
final def scope: Scope
Inherited from
TaxonomyElem
final override def text: String
Definition Classes
TaxonomyElem -> ClarkElemApi
Inherited from
TaxonomyElem
final override def textAsQName: QName
Definition Classes
TaxonomyElem -> ScopedElemLike -> ScopedElemApi
Inherited from
TaxonomyElem
final override def textAsResolvedQName: EName
Definition Classes
TaxonomyElem -> ScopedElemLike -> ScopedElemApi
Inherited from
TaxonomyElem
final def thisElem: ThisElem
Inherited from
TaxonomyElem
final def to: String

Returns the XLink "to". This may fail with an exception if the taxonomy is not schema-valid.

Returns the XLink "to". This may fail with an exception if the taxonomy is not schema-valid.

If the taxonomy is not known to be schema-valid, use the following code instead:

attributeOption(ENames.XLinkToEName)
Inherited from
XLinkArc
final override def trimmedText: String
Definition Classes
TaxonomyElem -> ClarkElemLike -> ClarkElemApi
Inherited from
TaxonomyElem
final def underlyingParentElem: Elem

Returns the underlying parent element. This may fail with an exception if the taxonomy is not schema-valid.

Returns the underlying parent element. This may fail with an exception if the taxonomy is not schema-valid.

If the taxonomy is not known to be schema-valid, use the following code instead:

backingElem.parentOption
Inherited from
ChildXLink
final def use: Use

Returns the "use" attribute (defaulting to "optional"). This may fail with an exception if the taxonomy is not schema-valid.

Returns the "use" attribute (defaulting to "optional"). This may fail with an exception if the taxonomy is not schema-valid.

Inherited from
XLinkArc
final def xlinkAttributes: Map[EName, String]
Inherited from
XLinkElem
final def xlinkType: String
Inherited from
XLinkArc