ChoiceRule.Rd
Factory class for creating a choice rule.
StringEquals()
Creates a rule with the `StringEquals` operator.
ChoiceRule$StringEquals(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Constant value to compare `variable` against.
Rule: Rule with `StringEquals` operator.
StringEqualsPath()
Creates a rule with the `StringEqualsPath` operator.
ChoiceRule$StringEqualsPath(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Path to the value to compare `variable` against.
Rule: Rule with `StringEqualsPath` operator.
StringLessThan()
Creates a rule with the `StringLessThan` operator.
ChoiceRule$StringLessThan(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Constant value to compare `variable` against.
Rule: Rule with `StringLessThan` operator.
StringLessThanPath()
Creates a rule with the `StringLessThanPath` operator.
ChoiceRule$StringLessThanPath(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Path to the value to compare `variable` against.
Rule: Rule with `StringLessThanPath` operator.
StringGreaterThan()
Creates a rule with the `StringGreaterThan` operator.
ChoiceRule$StringGreaterThan(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Constant value to compare `variable` against.
Rule: Rule with `StringGreaterThan` operator.
StringGreaterThanPath()
Creates a rule with the `StringGreaterThanPath` operator.
ChoiceRule$StringGreaterThanPath(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Path to the value to compare `variable` against.
Rule: Rule with `StringGreaterThanPath` operator
StringLessThanEquals()
Creates a rule with the `StringLessThanEquals` operator.
ChoiceRule$StringLessThanEquals(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Constant value to compare `variable` against.
Rule: Rule with `StringLessThanEquals` operator.
StringLessThanEqualsPath()
Creates a rule with the `StringLessThanEqualsPath` operator.
ChoiceRule$StringLessThanEqualsPath(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Path to the value to compare `variable` against.
Rule: Rule with `StringLessThanEqualsPath` operator.
StringGreaterThanEquals()
Creates a rule with the `StringGreaterThanEquals` operator.
ChoiceRule$StringGreaterThanEquals(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Constant value to compare `variable` against.
Rule: Rule with `StringGreaterThanEquals` operator.
StringGreaterThanEqualsPath()
Creates a rule with the `StringGreaterThanEqualsPath` operator.
ChoiceRule$StringGreaterThanEqualsPath(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Path to the value to compare `variable` against.
Rule: Rule with `StringGreaterThanEqualsPath` operator.
NumericEquals()
Creates a rule with the `NumericEquals` operator.
ChoiceRule$NumericEquals(variable, value)
variable
(str): Path to the variable to compare.
value
(int): Constant value to compare `variable` against.
Rule: Rule with `NumericEquals` operator.
NumericEqualsPath()
Creates a rule with the `NumericEqualsPath` operator.
ChoiceRule$NumericEqualsPath(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Path to the value to compare `variable` against.
Rule: Rule with `NumericEqualsPath` operator.
NumericLessThan()
Creates a rule with the `NumericLessThan` operator.
ChoiceRule$NumericLessThan(variable, value)
variable
(str): Path to the variable to compare.
value
(int): Constant value to compare `variable` against.
Rule: Rule with `NumericLessThan` operator.
NumericLessThanPath()
Creates a rule with the `NumericLessThanPath` operator.
ChoiceRule$NumericLessThanPath(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Path to the value to compare `variable` against.
Rule: Rule with `NumericLessThanPath` operator.
NumericGreaterThan()
Creates a rule with the `NumericGreaterThan` operator.
ChoiceRule$NumericGreaterThan(variable, value)
variable
(str): Path to the variable to compare.
value
(int): Constant value to compare `variable` against.
Rule: Rule with `NumericGreaterThan` operator.
NumericGreaterThanPath()
Creates a rule with the `NumericGreaterThanPath` operator.
ChoiceRule$NumericGreaterThanPath(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Path to the value to compare `variable` against.
Rule: Rule with `NumericGreaterThanPath` operator.
NumericLessThanEquals()
Creates a rule with the `NumericLessThanEquals` operator.
ChoiceRule$NumericLessThanEquals(variable, value)
variable
(str): Path to the variable to compare.
value
(int): Constant value to compare `variable` against.
Rule: Rule with `NumericLessThanEquals` operator.
NumericLessThanEqualsPath()
Creates a rule with the `NumericLessThanEqualsPath` operator.
ChoiceRule$NumericLessThanEqualsPath(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Path to the value to compare `variable` against.
Rule: Rule with `NumericLessThanEqualsPath` operator
NumericGreaterThanEquals()
Creates a rule with the `NumericGreaterThanEquals` operator.
ChoiceRule$NumericGreaterThanEquals(variable, value)
variable
(str): Path to the variable to compare.
value
(int): Constant value to compare `variable` against.
Rule: Rule with `NumericGreaterThanEquals` operator.
NumericGreaterThanEqualsPath()
Creates a rule with the `NumericGreaterThanEqualsPath` operator.
ChoiceRule$NumericGreaterThanEqualsPath(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Path to the value to compare `variable` against.
Rule: Rule with `NumericGreaterThanEqualsPath` operator.
BooleanEquals()
Creates a rule with the `BooleanEquals` operator.
ChoiceRule$BooleanEquals(variable, value)
variable
(str): Path to the variable to compare.
value
(bool): Constant value to compare `variable` against.
Rule: Rule with `BooleanEquals` operator.
BooleanEqualsPath()
Creates a rule with the `BooleanEqualsPath` operator.
ChoiceRule$BooleanEqualsPath(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Path to the value to compare `variable` against.
Rule: Rule with `BooleanEqualsPath` operator.
TimestampEquals()
Creates a rule with the `TimestampEquals` operator.
ChoiceRule$TimestampEquals(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Constant value to compare `variable` against.
Rule: Rule with `TimestampEquals` operator.
TimestampEqualsPath()
Creates a rule with the `TimestampEqualsPath` operator.
ChoiceRule$TimestampEqualsPath(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Path to the value to compare `variable` against.
Rule: Rule with `TimestampEqualsPath` operator.
TimestampLessThan()
Creates a rule with the `TimestampLessThan` operator.
ChoiceRule$TimestampLessThan(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Constant value to compare `variable` against.
Rule: Rule with `TimestampLessThan` operator.
TimestampLessThanPath()
Creates a rule with the `TimestampLessThanPath` operator.
ChoiceRule$TimestampLessThanPath(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Path to the value to compare `variable` against.
Rule: Rule with `TimestampLessThanPath` operator.
TimestampGreaterThan()
Creates a rule with the `TimestampGreaterThan` operator.
ChoiceRule$TimestampGreaterThan(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Constant value to compare `variable` against.
Rule: Rule with `TimestampGreaterThan` operator.
TimestampGreaterThanPath()
Creates a rule with the `TimestampGreaterThanPath` operator.
ChoiceRule$TimestampGreaterThanPath(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Path to the value to compare `variable` against.
Rule: Rule with `TimestampGreaterThanPath` operator.
TimestampLessThanEquals()
Creates a rule with the `TimestampLessThanEquals` operator.
ChoiceRule$TimestampLessThanEquals(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Constant value to compare `variable` against.
Rule: Rule with `TimestampLessThanEquals` operator.
TimestampLessThanEqualsPath()
Creates a rule with the `TimestampLessThanEqualsPath` operator.
ChoiceRule$TimestampLessThanEqualsPath(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Path to the value to compare `variable` against.
Rule: Rule with `TimestampLessThanEqualsPath` operator.
TimestampGreaterThanEquals()
Creates a rule with the `TimestampGreaterThanEquals` operator.
ChoiceRule$TimestampGreaterThanEquals(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Constant value to compare `variable` against.
Rule: Rule with `TimestampGreaterThanEquals` operator.
TimestampGreaterThanEqualsPath()
Creates a rule with the `TimestampGreaterThanEqualsPath` operator.
ChoiceRule$TimestampGreaterThanEqualsPath(variable, value)
variable
(str): Path to the variable to compare.
value
(str): Path to the value to compare `variable` against.
Rule: Rule with `TimestampGreaterThanEqualsPath` operator.
IsNull()
Creates a rule with the `IsNull` operator.
ChoiceRule$IsNull(variable, value)
variable
(str): Path to the variable to compare.
value
(bool): Whether the value at `variable` is equal to the JSON literal null or not.
Rule: Rule with `IsNull` operator.
IsPresent()
Creates a rule with the `IsPresent` operator.
ChoiceRule$IsPresent(variable, value)
variable
(str): Path to the variable to compare.
value
(bool): Whether a field at `variable` exists in the input or not.
Rule: Rule with `IsPresent` operator.
IsString()
Creates a rule with the `IsString` operator.
ChoiceRule$IsString(variable, value)
variable
(str): Path to the variable to compare.
value
(bool): Whether the value at `variable` is a string or not.
Rule: Rule with `IsString` operator.
IsNumeric()
Creates a rule with the `IsNumeric` operator.
ChoiceRule$IsNumeric(variable, value)
variable
(str): Path to the variable to compare.
value
(bool): Whether the value at `variable` is a number or not.
Rule: Rule with `IsNumeric` operator.
IsTimestamp()
Creates a rule with the `IsTimestamp` operator.
ChoiceRule$IsTimestamp(variable, value)
variable
(str): Path to the variable to compare.
value
(bool): Whether the value at `variable` is a timestamp or not.
Rule: Rule with `IsTimestamp` operator.
IsBoolean()
Creates a rule with the `IsBoolean` operator.
ChoiceRule$IsBoolean(variable, value)
variable
(str): Path to the variable to compare.
value
(bool): Whether the value at `variable` is a boolean or not.
Rule: Rule with `IsBoolean` operator.
StringMatches()
Creates a rule with the `StringMatches` operator.
ChoiceRule$StringMatches(variable, value)
variable
(str): Path to the variable to compare.
value
(str): A string pattern that may contain one or more `*` characters to compare the value at `variable` to. The `*` character can be escaped using two backslashes. The comparison yields true if the variable matches the pattern, where `*` is a wildcard that matches zero or more characters.
Rule: Rule with `StringMatches` operator.
And()
Creates a compound rule with the `And` operator.
ChoiceRule$And(rules)
rules
(list(BaseRule)): List of rules to compound together.
CompoundRule: Compound rule with `And` operator.
Or()
Creates a compound rule with the `Or` operator.
ChoiceRule$Or(rules)
rules
(list(BaseRule)): List of rules to compound together.
CompoundRule: Compound rule with `Or` operator.
Not()
Creates a negation for a rule.
ChoiceRule$Not(rule)
rule
(BaseRule): Rule to Negate.
NotRule: Rule with `Not` operator.
clone()
The objects of this class are cloneable with this method.
ChoiceRule$clone(deep = FALSE)
deep
Whether to make a deep clone.