DimensionalValidator

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.

Linear Supertypes

AnyRef, Any

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val dimensionDefaults: Map[EName, EName]
val dimensionDomainsByElrAndDimension: Map[String, Map[EName, IndexedSeq[DimensionDomain]]]
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val hasHypercubeInheritanceOrSelf: Map[EName, Map[String, Set[EName]]]
val hasHypercubesByElrAndPrimary: Map[String, Map[EName, IndexedSeq[HasHypercubeRelationship]]]
def hashCode(): Int

Definition Classes
AnyRef → Any
val hypercubeDimensionsByElrAndHypercube: Map[String, Map[EName, IndexedSeq[HypercubeDimensionRelationship]]]
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val taxonomy: TaxonomyApi
def toString(): String

Definition Classes
AnyRef → Any
def validateDimensionalContext(dimensionalContext: DimensionalContext): Try[Unit]

Validates the dimensional context in isolation.
def validateDimensionally(concept: EName, dimensionalContext: DimensionalContext): Try[Boolean]

Validates the given concept and dimensional context dimensionally.
Validates the given concept and dimensional context dimensionally. Validation does not include schema validation for typed dimension members.
This method does not validate the dimensional context itself, isolated from the concept. That is, it does not call method validateDimensionalContext.
def validateDimensionally(itemFact: ItemFact, instance: XbrlInstance): Try[Boolean]

Validates the given item fact in the given XBRL instance dimensionally.
Validates the given item fact in the given XBRL instance dimensionally. It invokes the equally named validation method taking the fact's concept as first argument and its XBRL context converted to a DimensionalContext as second argument.
def validateDimensionallyAsIfForAllRelationship(dimensionalContext: DimensionalContext, hasHypercube: HasHypercubeRelationship): Try[Boolean]
def validateDimensionallyForElr(dimensionalContext: DimensionalContext, hasHypercubeElr: String, ownOrInheritedPrimaries: Set[EName]): Try[Boolean]
def validateDimensionallyForHasHypercube(dimensionalContext: DimensionalContext, hasHypercube: HasHypercubeRelationship): Try[Boolean]
def validateExplicitDimensionValue(dimension: EName, dimensionalContextElement: DimensionalContextElement, dimensionDomains: IndexedSeq[DimensionDomain]): Boolean

Validate a dimension value (possibly default) against the effective domain of the dimension
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 DimensionalValidator | package instancevalidation

final class DimensionalValidator extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val dimensionDefaults: Map[EName, EName]

val dimensionDomainsByElrAndDimension: Map[String, Map[EName, IndexedSeq[DimensionDomain]]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val hasHypercubeInheritanceOrSelf: Map[EName, Map[String, Set[EName]]]

val hasHypercubesByElrAndPrimary: Map[String, Map[EName, IndexedSeq[HasHypercubeRelationship]]]

def hashCode(): Int

val hypercubeDimensionsByElrAndHypercube: Map[String, Map[EName, IndexedSeq[HypercubeDimensionRelationship]]]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

val taxonomy: TaxonomyApi

def toString(): String

def validateDimensionalContext(dimensionalContext: DimensionalContext): Try[Unit]

def validateDimensionally(concept: EName, dimensionalContext: DimensionalContext): Try[Boolean]

def validateDimensionally(itemFact: ItemFact, instance: XbrlInstance): Try[Boolean]

def validateDimensionallyAsIfForAllRelationship(dimensionalContext: DimensionalContext, hasHypercube: HasHypercubeRelationship): Try[Boolean]

def validateDimensionallyForElr(dimensionalContext: DimensionalContext, hasHypercubeElr: String, ownOrInheritedPrimaries: Set[EName]): Try[Boolean]

def validateDimensionallyForHasHypercube(dimensionalContext: DimensionalContext, hasHypercube: HasHypercubeRelationship): Try[Boolean]

def validateExplicitDimensionValue(dimension: EName, dimensionalContextElement: DimensionalContextElement, dimensionDomains: IndexedSeq[DimensionDomain]): Boolean

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped