Package

eu.cdevreeze.tqa

instancevalidation

Permalink

package instancevalidation

Instance validators, wrapping some taxonomy object. These validators are aware of XBRL instances and how to (dimensionally) validate them.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. instancevalidation
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final case class DefaultValueUsedInInstanceError(dimension: EName) extends RuntimeException with ValidationException with Product with Serializable

    Permalink
  2. final class DimensionDomain extends AnyRef

    Permalink

    Dimension domain, optimized for dimensional instance validation.

  3. final case class DimensionalContext(dimensionalSegment: DimensionalSegment, dimensionalScenario: DimensionalScenario) extends Product with Serializable

    Permalink

    Dimensional context.

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

  4. sealed abstract class DimensionalContextElement extends AnyRef

    Permalink

    Dimensional context element, so either a dimensional segment or dimensional scenario.

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

  5. final case class DimensionalScenario(explicitDimensionMemberSeq: IndexedSeq[(EName, EName)], typedDimensionMemberSeq: IndexedSeq[(EName, TypedDimensionMember)]) extends DimensionalContextElement with Product with Serializable

    Permalink
  6. final case class DimensionalSegment(explicitDimensionMemberSeq: IndexedSeq[(EName, EName)], typedDimensionMemberSeq: IndexedSeq[(EName, TypedDimensionMember)]) extends DimensionalContextElement with Product with Serializable

    Permalink
  7. final class DimensionalValidator extends AnyRef

    Permalink

    Dimensional instance validator.

    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.

  8. final case class ExplicitMemberNotExplicitDimensionError(ename: EName) extends RuntimeException with ValidationException with Product with Serializable

    Permalink
  9. final case class ExplicitMemberUndefinedQNameError(ename: EName) extends RuntimeException with ValidationException with Product with Serializable

    Permalink
  10. final case class IllegalTypedDimensionContentError(ename: EName) extends RuntimeException with ValidationException with Product with Serializable

    Permalink
  11. final class TypedDimensionMember extends AnyRef

    Permalink

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

  12. final case class TypedMemberNotTypedDimensionError(ename: EName) extends RuntimeException with ValidationException with Product with Serializable

    Permalink
  13. sealed trait ValidationException extends RuntimeException

    Permalink

    Exception encountered during validation.

    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.

Value Members

  1. object DimensionDomain

    Permalink
  2. object DimensionalContext extends Serializable

    Permalink
  3. object DimensionalValidator

    Permalink
  4. object RepeatedDimensionInInstanceError extends RuntimeException with ValidationException with Product with Serializable

    Permalink

Inherited from AnyRef

Inherited from Any

Ungrouped