Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The WhereClause class is used to define data selection criteria that are used for the selection and grouping of data for analysis.

Excerpt Include
ARSP:Class Diagram: WhereClause
ARSP:Class Diagram: WhereClause

...

  • The level attribute contains an integer that indicates the level at which the specified condition is being applied, with a value of "1" indicating the "top" level. The level attribute:
    • Has a value of "1" in any instance of a specialization of the WhereClause class where an identifier value is assigned. 
    • Contains a value greater than 1 only in instances of the WhereClause class that are used to define sub-conditions within a compound expression.
  • The order attribute contains an integer to order this instance of the WhereClause class with respect to other other instance of the WhereClause at the same level.
    • When the value of the level attribute is greater than 1 (i.e., this instance of the WhereClause class defines one of the selection criteria being combined in a compound expression), the order attribute defines the order of this instance of the WhereClause class with respect to the other selection criteria with which it is being combined.
    • When the value of the level attribute is "1":
      • In instances of either of the specializations of the Group class, the order attribute is used to define the order of the group with respect to other groups in the grouping factor.
      • In all other situations, the order attribute should have a value of "1".

...

  • Either:
    • The condition attribute contains the specification of a simple condition represented as an instance of the WhereClauseCondition class

...

Or

    • The compoundExpression attribute contains the specification of a compound expression represented as

...

  • The dataset attribute contains the name of the dataset in which the condition is being applied.
  • The variable attribute contains the name of the variable (within the specified dataset) to which the condition applies.
  • The comparator attribute contains a value from the ConditionComparatorEnum enumeration ("EQ" for "equal to", "LT" for less than, etc.) to indicate how values of the specified dataset variable are compared with the specified selection value(s).
  • The value attribute specifies the selection value, or values, for comparison with values in the specified dataset variable. If the value of the comparator attribute is:
    • "IN" or "NOTIN", there should be at least 2 values specified in the value attribute; otherwise there should be no more than 1 value specified in the value attribute.
    • "EQ" or "NE", the value attribute may contain no value to indicate a condition based on a missing value (i.e., "is missing" or "is not missing" respectively). 

...

...

  • The logicalOperator attribute contains a value from the ExpressionLogicalOperatorEnum enumeration:
    • "AND" or "OR" are used in compound expression that combine 2 or more simple conditions or other compound expressions.
    • "NOT" is used in compound expressions that negate another (single) compound expression.
  • The whereClauses attribute contains
  • The CompoundSetExpression specialization of the WhereClauseCompoundExpression class is used to define compound expressions in the AnalysisSet specialization of the WhereClause class. In the CompoundSetExpression class, the whereClauses attribute can only contain references to other instances of the AnalysisSet class that have already been defined and assigned an identifier.
  • The CompoundSubsetExpression specialization of the WhereClauseCompoundExpression class is used to define compound expressions in the DataSubset specialization of the WhereClause class, as described in the DataSubset section. In the CompoundSubsetExpression class, the whereClauses attribute can only contain references to other instances of the AnalysisSet class that have already been defined and assigned an identifier.
  • The CompoundGroupExpression specialization of the WhereClauseCompoundExpression class is used to define compound expressions in the Group specialization of the WhereClause class, as described in the GroupingFactor section. In the CompoundGroupExpression class, the whereClauses attribute can only contain references to other instances of the Group class that have already been defined and assigned an identifier.

Each 

...

Pagenav