Package

eu.cdevreeze.tqa.extension.formula

model

Permalink

package model

Model of formula linkbase content, as free from XML as possible. The model is not XPath-aware, other than keeping XPath expressions as strings. It is not XLink-aware, but replaces relationships by a case class hierarchy.

The model is hierarchical, regarding filters to be properties of variable sets and fact variables, and regarding variables and parameters to be properties of variable sets.

The model may contain less information than the XML-backed DOM and relationship classes for formulas.

This model is not dependent on the (formula) DOM, relationship and query API packages. The reverse is also true. In other words, this model package can be used in isolation.

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

Type Members

  1. final case class AncestorFilter(ancestorNameOrExpr: ENameValueOrExpr) extends TupleFilter with Product with Serializable

    Permalink
  2. final case class AndFilter(subFilters: IndexedSeq[BooleanFilterSubFilter]) extends BooleanFilter with Product with Serializable

    Permalink
  3. final case class AspectCoverFilter(aspects: Set[Aspect], dimensionNamesOrExprs: IndexedSeq[ENameValueOrExpr], excludeDimensionNamesOrExprs: IndexedSeq[ENameValueOrExpr]) extends Filter with Product with Serializable

    Permalink
  4. sealed trait AspectRule extends AnyRef

    Permalink

    Formula aspect rule.

  5. final case class AspectRuleGroup(sourceOption: Option[EName], aspectRules: IndexedSeq[AspectRule]) extends Product with Serializable

    Permalink

    Combination of aspect rules, corresponding to a formula:aspects element.

  6. trait Assertion extends AnyRef

    Permalink

    Assertion, such as a value assertion.

  7. sealed abstract class BooleanFilter extends Filter

    Permalink
  8. final case class BooleanFilterSubFilter(commonAttributes: CommonRelationshipAttributes, complement: Boolean, cover: Boolean, subFilter: Filter) extends NestedRelationship[Filter] with Product with Serializable

    Permalink

    Boolean filter (nested) relationship.

  9. final case class CommonRelationshipAttributes(elr: String, order: BigDecimal, priority: Int, use: Use) extends Product with Serializable

    Permalink

    Common relationship attributes, such as ELR, order, priority and use.

  10. final case class ConceptAspectRule(sourceOption: Option[EName], conceptNameOrExprOption: Option[ENameValueOrExpr]) extends AspectRule with Product with Serializable

    Permalink
  11. final case class ConceptBalanceFilter(balance: String) extends ConceptFilter with Product with Serializable

    Permalink
  12. final case class ConceptCustomAttributeFilter(attrNameOrExpr: ENameValueOrExpr, attrValueExprOption: Option[ScopedXPathString]) extends ConceptFilter with Product with Serializable

    Permalink
  13. final case class ConceptDataTypeFilter(typeNameOrExpr: ENameValueOrExpr, strict: Boolean) extends ConceptFilter with Product with Serializable

    Permalink
  14. sealed trait ConceptFilter extends Filter

    Permalink
  15. final case class ConceptNameFilter(conceptNamesOrExprs: IndexedSeq[ENameValueOrExpr]) extends ConceptFilter with Product with Serializable

    Permalink
  16. final case class ConceptPeriodTypeFilter(periodType: String) extends ConceptFilter with Product with Serializable

    Permalink
  17. final case class ConceptRelationFilter(sourceNameOrExpr: ENameValueOrExpr, linkroleOrExpr: StringValueOrExpr, linknameOrExprOption: Option[ENameValueOrExpr], arcroleOrExpr: StringValueOrExpr, arcnameOrExprOption: Option[ENameValueOrExpr], axis: Axis, generationsOption: Option[Int], exprOption: Option[ScopedXPathString]) extends Filter with Product with Serializable

    Permalink
  18. final case class ConceptSubstitutionGroupFilter(substitutionGroupNameOrExpr: ENameValueOrExpr, strict: Boolean) extends ConceptFilter with Product with Serializable

    Permalink
  19. sealed abstract class DimensionAspectRule extends AspectRule

    Permalink
  20. sealed abstract class DimensionFilter extends Filter

    Permalink
  21. final case class DimensionFilterMember(memberNameOrExpr: ENameValueOrExpr, linkroleOption: Option[String], arcroleOption: Option[String], axisOption: Option[String]) extends Product with Serializable

    Permalink

    Dimension filter member "specification".

  22. final case class DivideBy(sourceOption: Option[EName], measureExprOption: Option[ScopedXPathString]) extends Product with Serializable

    Permalink

    Divide-by, in a unit aspect rule.

  23. sealed trait EntityFilter extends Filter

    Permalink
  24. final case class EntityIdentifierAspectRule(sourceOption: Option[EName], schemeExprOption: Option[ScopedXPathString], identifierValueExprOption: Option[ScopedXPathString]) extends AspectRule with Product with Serializable

    Permalink
  25. final case class ExistenceAssertion(implicitFiltering: Boolean, aspectModel: AspectModel, testExprOption: Option[ScopedXPathString], variableSetFilters: IndexedSeq[VariableSetFilter], variableSetPreconditions: IndexedSeq[VariableSetPrecondition], variableSetVariablesOrParameters: IndexedSeq[VariableSetVariableOrParameter]) extends VariableSetAssertion with Product with Serializable

    Permalink
  26. final case class ExplicitDimensionAspectRule(sourceOption: Option[EName], dimension: EName, memberNameOrExprOption: Option[ENameValueOrExpr]) extends DimensionAspectRule with Product with Serializable

    Permalink
  27. final case class ExplicitDimensionFilter(dimensionNameOrExpr: ENameValueOrExpr, members: IndexedSeq[DimensionFilterMember]) extends DimensionFilter with Product with Serializable

    Permalink
  28. final case class FactVariable(bindAsSequence: Boolean, fallbackValueExprOption: Option[ScopedXPathString], matchesOption: Option[Boolean], nilsOption: Option[Boolean], variableFilters: IndexedSeq[VariableFilter]) extends Variable with Product with Serializable

    Permalink
  29. sealed trait Filter extends AnyRef

    Permalink

    Filter.

    Filter. The filter does not know its ELR.

  30. final case class Formula(implicitFiltering: Boolean, aspectModel: AspectModel, sourceOption: Option[EName], valueExpr: ScopedXPathString, aspectRuleGroups: IndexedSeq[AspectRuleGroup], precisionValueOrExprOption: Option[ScopedXPathString], decimalsValueOrExprOption: Option[ScopedXPathString], variableSetFilters: IndexedSeq[VariableSetFilter], variableSetPreconditions: IndexedSeq[VariableSetPrecondition], variableSetVariablesOrParameters: IndexedSeq[VariableSetVariableOrParameter]) extends VariableSet with Product with Serializable

    Permalink
  31. final case class GeneralFilter(exprOption: Option[ScopedXPathString]) extends Filter with Product with Serializable

    Permalink
  32. final case class GeneralMeasuresFilter(expr: ScopedXPathString) extends UnitFilter with Product with Serializable

    Permalink
  33. final case class GeneralVariable(bindAsSequence: Boolean, selectExpr: ScopedXPathString) extends Variable with Product with Serializable

    Permalink
  34. final case class IdentifierFilter(identifierValueExpr: ScopedXPathString) extends EntityFilter with Product with Serializable

    Permalink
  35. final case class InstantDurationFilter(variable: EName, boundary: String) extends PeriodAspectFilter with Product with Serializable

    Permalink
  36. final case class LocationFilter(variable: EName, locationExpr: ScopedXPathString) extends TupleFilter with Product with Serializable

    Permalink
  37. final case class MatchConceptFilter(variable: EName, matchAny: Boolean) extends MatchFilter with Product with Serializable

    Permalink
  38. final case class MatchDimensionFilter(dimension: EName, variable: EName, matchAny: Boolean) extends MatchFilter with Product with Serializable

    Permalink
  39. final case class MatchEntityIdentifierFilter(variable: EName, matchAny: Boolean) extends MatchFilter with Product with Serializable

    Permalink
  40. sealed abstract class MatchFilter extends Filter

    Permalink
  41. final case class MatchLocationFilter(variable: EName, matchAny: Boolean) extends MatchFilter with Product with Serializable

    Permalink
  42. final case class MatchNonXDTScenarioFilter(variable: EName, matchAny: Boolean) extends MatchFilter with Product with Serializable

    Permalink
  43. final case class MatchNonXDTSegmentFilter(variable: EName, matchAny: Boolean) extends MatchFilter with Product with Serializable

    Permalink
  44. final case class MatchPeriodFilter(variable: EName, matchAny: Boolean) extends MatchFilter with Product with Serializable

    Permalink
  45. final case class MatchScenarioFilter(variable: EName, matchAny: Boolean) extends MatchFilter with Product with Serializable

    Permalink
  46. final case class MatchSegmentFilter(variable: EName, matchAny: Boolean) extends MatchFilter with Product with Serializable

    Permalink
  47. final case class MatchUnitFilter(variable: EName, matchAny: Boolean) extends MatchFilter with Product with Serializable

    Permalink
  48. final case class MultiplyBy(sourceOption: Option[EName], measureExprOption: Option[ScopedXPathString]) extends Product with Serializable

    Permalink

    Multiply-by, in a unit aspect rule.

  49. trait NestedRelationship[Target] extends AnyRef

    Permalink

    A "nested relationship" in a formula context.

    A "nested relationship" in a formula context. It contains the relationship target, and not the source. It also contains relationship attributes such as order, priority and use. It also contains the ELR of the parent extended link.

  50. sealed trait OccAspectRule extends AspectRule

    Permalink
  51. final case class OccEmptyAspectRule(sourceOption: Option[EName], occ: Occ) extends OccAspectRule with Product with Serializable

    Permalink
  52. final case class OccFragmentsAspectRule(sourceOption: Option[EName], occ: Occ) extends OccAspectRule with Product with Serializable

    Permalink
  53. final case class OccXPathAspectRule(sourceOption: Option[EName], occ: Occ, selectExprOption: Option[ScopedXPathString]) extends OccAspectRule with Product with Serializable

    Permalink
  54. final case class OrFilter(subFilters: IndexedSeq[BooleanFilterSubFilter]) extends BooleanFilter with Product with Serializable

    Permalink
  55. final case class Parameter(name: EName, selectExprOption: Option[ScopedXPathString], requiredOption: Option[Boolean], asOption: Option[EName]) extends VariableOrParameter with Product with Serializable

    Permalink
  56. final case class ParentFilter(parentNameOrExpr: ENameValueOrExpr) extends TupleFilter with Product with Serializable

    Permalink
  57. sealed trait PeriodAspectFilter extends Filter

    Permalink
  58. final case class PeriodAspectRule(sourceOption: Option[EName], periods: IndexedSeq[Period]) extends AspectRule with Product with Serializable

    Permalink
  59. final case class PeriodEndFilter(dateExpr: ScopedXPathString, timeExprOption: Option[ScopedXPathString]) extends PeriodAspectFilter with Product with Serializable

    Permalink
  60. final case class PeriodFilter(expr: ScopedXPathString) extends PeriodAspectFilter with Product with Serializable

    Permalink
  61. final case class PeriodInstantFilter(dateExpr: ScopedXPathString, timeExprOption: Option[ScopedXPathString]) extends PeriodAspectFilter with Product with Serializable

    Permalink
  62. final case class PeriodStartFilter(dateExpr: ScopedXPathString, timeExprOption: Option[ScopedXPathString]) extends PeriodAspectFilter with Product with Serializable

    Permalink
  63. final case class PrecisionFilter(minimumExpr: ScopedXPathString) extends ValueFilter with Product with Serializable

    Permalink
  64. final case class Precondition(testExpr: ScopedXPathString) extends Product with Serializable

    Permalink

    Precondition.

  65. final case class RegexpIdentifierFilter(identifierValuePattern: String) extends EntityFilter with Product with Serializable

    Permalink
  66. final case class RegexpSchemeFilter(schemePattern: String) extends EntityFilter with Product with Serializable

    Permalink
  67. final case class RelativeFilter(variable: EName) extends Filter with Product with Serializable

    Permalink
  68. final case class ScenarioFilter(exprOption: Option[ScopedXPathString]) extends SegmentScenarioFilter with Product with Serializable

    Permalink
  69. final case class SegmentFilter(exprOption: Option[ScopedXPathString]) extends SegmentScenarioFilter with Product with Serializable

    Permalink
  70. sealed abstract class SegmentScenarioFilter extends Filter

    Permalink
  71. final case class SiblingFilter(variable: EName) extends TupleFilter with Product with Serializable

    Permalink
  72. final case class SingleMeasureFilter(measureNameOrExpr: ENameValueOrExpr) extends UnitFilter with Product with Serializable

    Permalink
  73. final case class SpecificIdentifierFilter(schemeExpr: ScopedXPathString, identifierValueExpr: ScopedXPathString) extends EntityFilter with Product with Serializable

    Permalink
  74. final case class SpecificSchemeFilter(schemeExpr: ScopedXPathString) extends EntityFilter with Product with Serializable

    Permalink
  75. sealed trait TupleFilter extends Filter

    Permalink
  76. final case class TypedDimensionAspectRule(sourceOption: Option[EName], dimension: EName, memberExprOption: Option[ScopedXPathString]) extends DimensionAspectRule with Product with Serializable

    Permalink
  77. final case class TypedDimensionFilter(dimensionNameOrExpr: ENameValueOrExpr, memberExprOption: Option[ScopedXPathString]) extends DimensionFilter with Product with Serializable

    Permalink
  78. final case class UnitAspectRule(sourceOption: Option[EName], multiplyBy: IndexedSeq[MultiplyBy], divideBy: IndexedSeq[DivideBy], augmentOption: Option[Boolean]) extends AspectRule with Product with Serializable

    Permalink
  79. sealed trait UnitFilter extends Filter

    Permalink
  80. final case class ValueAssertion(implicitFiltering: Boolean, aspectModel: AspectModel, testExpr: ScopedXPathString, variableSetFilters: IndexedSeq[VariableSetFilter], variableSetPreconditions: IndexedSeq[VariableSetPrecondition], variableSetVariablesOrParameters: IndexedSeq[VariableSetVariableOrParameter]) extends VariableSetAssertion with Product with Serializable

    Permalink
  81. sealed trait ValueFilter extends Filter

    Permalink
  82. sealed trait Variable extends VariableOrParameter

    Permalink
  83. final case class VariableFilter(commonAttributes: CommonRelationshipAttributes, complement: Boolean, cover: Boolean, filter: Filter) extends NestedRelationship[Filter] with Product with Serializable

    Permalink

    A variable filter (nested) relationship, without the fact variable.

  84. sealed trait VariableOrParameter extends AnyRef

    Permalink

    Variable or parameter.

  85. sealed trait VariableSet extends AnyRef

    Permalink

    Variable set, such as a value assertion or formula.

    Variable set, such as a value assertion or formula. The variable set does not know its ELR.

  86. sealed trait VariableSetAssertion extends VariableSet with Assertion

    Permalink
  87. final case class VariableSetFilter(commonAttributes: CommonRelationshipAttributes, complement: Boolean, filter: Filter) extends NestedRelationship[Filter] with Product with Serializable

    Permalink

    A variable set filter (nested) relationship, without the variable set.

  88. final case class VariableSetPrecondition(commonAttributes: CommonRelationshipAttributes, precondition: Precondition) extends NestedRelationship[Precondition] with Product with Serializable

    Permalink

    A variable set precondition (nested) relationship, without the variable set.

  89. final case class VariableSetVariableOrParameter(commonAttributes: CommonRelationshipAttributes, name: EName, variableOrParameter: VariableOrParameter) extends NestedRelationship[VariableOrParameter] with Product with Serializable

    Permalink

    A variable set variable-or-parameter (nested) relationship, without the variable set.

Value Members

  1. object DimensionFilterMember extends Serializable

    Permalink
  2. object ForeverFilter extends PeriodAspectFilter with Product with Serializable

    Permalink
  3. object NilFilter extends ValueFilter with Product with Serializable

    Permalink
  4. object PeriodAspectRule extends Serializable

    Permalink

Inherited from AnyRef

Inherited from Any

Ungrouped