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: WhereClauseARSP:
Class Diagram: WhereClause

...

  • The AnalysisSet class is used to define subject populations (i.e., criteria for the selection of subjects for inclusion in an analysis), as described in the AnalysisSet section.
  • The DataSubset class is used to define criteria for the selection of data records for inclusion in an analysis, as described in the DataSubset section.
  • The Group class, through use of its two specializations, AnalysisGroup and DataGroup, is used to define the criteria for grouping subjects and data records (respectively) for analysis, as described in the DataGroupingFactor GroupingFactor section.

Each instance of the WhereClause class (or any of its specializations) defines either:

  • A simple condition based on the value or values for single dataset variable or
  • A compound expression that either:
    • combines selection criteria, which are defined in other instances of the WhereClause class (or 1 or its specializations) that represent simple conditions or other compound expressions, or
    • negates the selection criteria defined in another single instance of the WhereClause class (or 1 of its specializations) that represents a compound expression. Note that a compound expression should generally not be created to negate a single simple condition; another simple condition using the inverse comparator should be created instead (i.e., using "NE" vs. "EQ", "LT" vs. "GE", "GT" vs. "LE", or "NOTIN" vs. "IN").

...

In an instance of the WhereClause class (or 1 of its specializations) that defines a simple condition, the the condition attribute contains an instance of the WhereClauseCondition class in which:

  • 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). 
Example

Include Page
ARSP:condition: Single valueARSP:
condition: Single value

Example

Include Page
ARSP:condition: Multiple valuesARSP:
condition: Multiple values

Example

Include Page
ARSP:condition: Missing valueARSP:
condition: Missing value

In an instance of the WhereClause class (or 1 of its specializations) that defines a compound expression, the compoundExpression attribute contains an instance of the WhereClauseCompoundExpression class (or 1 of its specializations) in which:

  • 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 






SelectionGrouping
SubjectsanalysisSetsanalysisGroupings
DatadataSubsetsdataGroupings

...