eu.cdevreeze.tqa.instancevalidation

Type members

Classlikes

final case class DefaultValueUsedInInstanceError(dimension: EName) extends ValidationException
final class DimensionDomain(val dimension: EName, val dimensionDomainElr: String, val members: Map[EName, Member])

Dimension domain, optimized for dimensional instance validation.

Dimension domain, optimized for dimensional instance validation.

Authors

Chris de Vreeze

Companion
object
Companion
class
final case class DimensionalContext(dimensionalSegment: DimensionalSegment, dimensionalScenario: DimensionalScenario)

Dimensional context. This type is optimized for dimensional instance validation.

Dimensional context. This type is optimized for dimensional instance validation.

Authors

Chris de Vreeze

Companion
object
Companion
class
sealed abstract class DimensionalContextElement(val explicitDimensionMemberSeq: IndexedSeq[(EName, EName)], val typedDimensionMemberSeq: IndexedSeq[(EName, TypedDimensionMember)])

Dimensional context element, so either a dimensional segment or dimensional scenario. This type and its sub-types are optimized for dimensional instance validation.

Dimensional context element, so either a dimensional segment or dimensional scenario. This type and its sub-types are optimized for dimensional instance validation.

Authors

Chris de Vreeze

final case class DimensionalScenario(explicitDimensionMemberSeq: IndexedSeq[(EName, EName)], typedDimensionMemberSeq: IndexedSeq[(EName, TypedDimensionMember)]) extends DimensionalContextElement
final case class DimensionalSegment(explicitDimensionMemberSeq: IndexedSeq[(EName, EName)], typedDimensionMemberSeq: IndexedSeq[(EName, TypedDimensionMember)]) extends DimensionalContextElement

Dimensional instance validator. It wraps a taxonomy as TaxonomyApi instance.

Dimensional instance validator. It wraps a taxonomy as TaxonomyApi instance.

Instances of this class are expensive to create, and should be created only once per DTS and then retained in memory.

This class is most useful if the taxonomy from which it is instantiated is known to be XBRL Core and Dimensions valid.

This class does not offer any schema validation queries, so typed dimension validation queries miss the schema validation part for typed dimension members.

Authors

Chris de Vreeze

Companion
object
Companion
class
final case class ExplicitMemberNotExplicitDimensionError(ename: EName) extends ValidationException
final case class ExplicitMemberUndefinedQNameError(ename: EName) extends ValidationException
final case class IllegalTypedDimensionContentError(ename: EName) extends ValidationException
final class TypedDimensionMember(val backingElem: Elem)

Typed dimension member, which on the one hand knows its ancestry, and on the other hand can be compared for equality.

Typed dimension member, which on the one hand knows its ancestry, and on the other hand can be compared for equality.

Authors

Chris de Vreeze

final case class TypedMemberNotTypedDimensionError(ename: EName) extends ValidationException
sealed trait ValidationException extends RuntimeException

Exception encountered during validation. Error xbrldie:PrimaryItemDimensionallyInvalidError does not count as an exception here, but is treated as a normal Boolean validation result. Error xbrldie:IllegalTypedDimensionContentError is absent due to the lack of schema validation (for typed dimension members) in this context.

Exception encountered during validation. Error xbrldie:PrimaryItemDimensionallyInvalidError does not count as an exception here, but is treated as a normal Boolean validation result. Error xbrldie:IllegalTypedDimensionContentError is absent due to the lack of schema validation (for typed dimension members) in this context.

Authors

Chris de Vreeze