Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Fixed diagram link and changed single quotes to double quotes for values in example condition expressions
Info
titleModel Documentation

Class: WhereClause

The WhereClause class is contains a set of attributes that are used to define data selection criteria that . These defined criteria are used for the selection and grouping of subjects and data for analysis. Excerpt IncludeARSP:Class Diagram: WhereClauseARSP:Class Diagram: WhereClauseThere are 3 specializations of the WhereClause class that  There are 4 "data selection classes" that contain the WhereClause class attributes:

  • There are 3 "identified WhereClause classes" that allow an identifier value

...

  • to be

...

  • associated with the defined selection

...

  • criteria (so that the defined criteria can be referenced in the definition of analyses):
    • The AnalysisSet class is used to define analysis sets or subject populations (i.e., criteria defined in the protocol or SAP for the selection of subjects for inclusion in
    an analysis
    • the main analyses), as described in the AnalysisSet section.
    • The DataSubset class is used to define other types of criteria for the selection of subjects or data records for inclusion in
    an analysis, through use of its two specializations, AnalysisGroup and DataGroup,
    • is used to define the criteria for grouping subjects
    and
    • or data records
    (respectively)
    • for analysis, as described in the
    DataGroupingFactor section.
  • The WhereClause class itself may used to define selection criteria being combined or negated in a compound expression (see below).

Excerpt Include
ARSP:ER Diagram: WhereClause
ARSP:ER Diagram: WhereClause

Each instance of the WhereClause class (or any of its specializations) defines eithera data selection class defines either (not both) of the following:

  • A simple condition based on the value or values for expressed as a single dataset variable compared to one or more values (e.g., ADAE.TRTEMFL = "Y", ADSL.AGE > 18, ADSL.TRT01A in ("Drug A", "Drug B")), which is represented in the condition attribute as an instance of the WhereClauseCondition class. See the WhereClauseCondition section for more information about defining simple conditions.
  • A compound expression that , represented in the compoundExpression attribute as an instance of the WhereClauseCompoundExpression class, which either:
    • combines uses the "AND" or "OR" logical operator to combine selection criteria , which are defined in 2 or more other data selection class instances of the WhereClause class (or its specializations) that represent simple conditions or other compound expressions, or, each of which represents a simple condition or another compound expression, or
    • uses the "NOT" logical operator to negate negates the selection criteria defined in another single instance of the WhereClause class (or 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").instance of a data selection class.

See the WhereClauseCompoundExpression section for more information about defining compound expressions.

Selection criteria can be recursive: an instance of a data selection class can be a compound expression that contains subclauses each defined as an instance of a data selection class that can be a compound expression, and so on. The WhereClause class therefore contains the level and order attributes, which are used to indicate the position of each instance of a data selection class relative to other related instances.In each instance of the WhereClause class,

  • 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 an identified WhereClause class (i.e., a class where an identifier value is assigned to the defined selection criteria)
    • Contains a value greater than 1 only in instances of the WhereClause class data selection classes that are used to define sub-conditions subconditions, or "subclauses", within a compound expression.
  • The order attribute contains an integer to order this instance of the WhereClause data selection class with respect to other other instance of the WhereClause instances of data selection classes at the same level.
  • 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
    • When the value of the level attribute is greater than 1 (i.e., this instance of the WhereClause data selection class defines one of the selection criteria subclauses being combined referenced in a compound expression), the the order attribute defines the order of this instance of the WhereClause data selection class with respect to the other selection criteria with which it is being combined (i.e., "1" for the first, "2" for the second, and so on).
    • When the value of the level attribute is "1":
      • In instances of either of the specializations of the Group class, the the order attribute is used to define the order of the group with respect to other groups in the grouping factor, as described in the GroupingFactor section.
      • In all other situations, the order attribute should have a value of "1".

In an instance of the WhereClause class that defines a simple condition, the condition attribute contains an instance of the WhereClauseCondition class in which:

...

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

...

Pagenav