Package oracle.rules.sdk2.ruleset

Class SimpleTest

java.lang.Object
oracle.rules.sdk2.dictionary.DictionaryObject
oracle.rules.sdk2.dictionary.DictionaryComponent<T>
oracle.rules.sdk2.ruleset.RuleComponent<T>
oracle.rules.sdk2.ruleset.UnnamedRuleComponent<T>
oracle.rules.sdk2.ruleset.FactBinding<SimpleTest>
oracle.rules.sdk2.ruleset.SimpleTest
All Implemented Interfaces:
Serializable, Cloneable, Map<String,Object>, UnnamedComponent, ExpressionContext, ScopedVariable, VariableScope, VerbalRuleComponent
public class SimpleTest extends FactBinding<SimpleTest> implements ScopedVariable, ExpressionContext, VerbalRuleComponent
A SimpleTest has one of the following Forms:
  • FORM_SIMPLE - a == 1
  • FORM_EXPRESSION - isNull(x)
  • FORM_VARIABLE_DEFINITION - x = 1
  • FORM_NESTED - (...)
  • FORM_NESTED_NOT - not(...)
  • FORM_NESTED_AND - and(...)
  • FORM_NESTED_OR - or(...)
  • FORM_IS_A - po is a purchase order
  • FORM_SOME_FACT - there is a purchase order where
  • FORM_SOME_CASE - there is a case where
  • FORM_NO_FACT - there is no purchase order where
  • FORM_NO_CASE - there is no case where
  • FORM_AGGREGATE - total salary is the sum of Emp.salary [where ...]

A SimpleTest has the following properties:

  • form - as in the table list above
  • expressionTable - list of expressions used in the test, typically a left and a right side expression (FORM_SIMPLE), value of a variable (FORM_VARIABLE_DEFINITION), input to aggregation function (FORM_AGGREGATE)
  • operatorID - a boolean builtin such as "==" or a boolean function or method ID (FORM_SIMPLE), or an aggregation function (FORM_AGGREGATE)
  • connective - "and" or "or" between this and following SimpleTest
  • variable (FORM_VARIABLE_DEFINITION, FORM_IS_A, FORM_AGGREGATE)
  • simpleTestTable - for nested tests (FORM_NESTED, FORM_NESTED_NOT, FORM_NESTED_AND, FORM_NESTED_OR, FORM_SOME_FACT, FORM_SOME_CASE, FORM_NO_FACT, FORM_NO_CASE, FORM_AGGREGATE). Nested IS_A tests are hidden in the case of outer forms FORM_AGGREGATE, FORM_SOME_FACT, FORM_NO_FACT
  • factType, factPath (FORM_IS_A)

All forms use the Connective property to specify whether this test is connected to the next test in the containing table by "And" or "Or", except when the containing table is for a test of form FORM_NESTED_AND or FORM_NESTED_OR. In these cases, the connective is given by the containing form. FORM_SIMPLE consists of 3 additional properties describing the immediate simple test:

  • ExpressionTable containing 2 or more expressions,
  • Operator,
  • RightSeparator
FORM_VARIABLE_DEFINITION consists of 2 additional properties:
  • Variable, the name of the variable
  • ExpressionTable containing 1 expression, the value of the variable
The variable name is in scope in following ANDed tests, and in following ANDed patterns (if AND-connected)

> Nested forms use only:

  • Operator ("", "not"). These are redundant and are for backward compatibility. FORM_NESTED may have either operator, but FORM_NESTED_NOT has only "not".
  • SimpleTestTable.

For Example: 

 Order.total > 500 AND...

"Order.total" is the left expression (expression[0]), ">=" is the comparison operator, "500" is the right expression (expression[1]), "AND" is the connective.

On output, valid choices for the context of the SimpleTest can be obtained by calling getLeft().getValueOptions(), or getOperatorOptions(), etc.

Simple Tests may be grouped by use of the SimpleTestTable contained in each SimpleTest and setting of the Form property to FORM_NESTED, FORM_NESTED_NOT, FORM_NESTED_AND, ...

For Example: 

 Producing tests that are grouped in this way:
 not ( T1 && (T2 || T3)
 would require five SimpleTests:
 - SimpleTest with FORM_NESTED_NOT
 The embedded SimpleTestTable would contain
 two SimpleTests:
 - the first one with FORM_SIMPLE for T1
 Connective: &&
 - the second with FORM_NESTED
 the embedded SimpleTestTable would contain:
 two SimpleTests:
 - the first  for T2 with connective: ||
 - the second for T3

between and in

Most builtin simple tests are binary. The have 2 entries in the expression table, and convenience methods getLeft()and getRight()may be used as shorthand for 
 getExpressionTable().get(0)
 getExpressionTable().get(1)
respectively. The builtins "between" and "in" take 3 or more arguments. The first is the left side expression. The second, third, and possibly more are the right side expressions. Use getRightSeparator() to determine how to display the right side arguments. If this method returns "", there is only one right side expression. E.g. consider a SimpleTest with
  • Form: FORM_SIMPLE
  • Operator: "between"
  • ExpressionTable: "somebody.age", 20, 30
  • RightSeparator: "and"
This should be rendered as 
 sombody.age between 20 and 30
Note the "in" operator can have more than 3 expressions in its expression table. The SDK will create the first 3 expressions; the UI is responsible for adding more expressions and removing unwanted expressions. For example, the UI might show the following simple test: 
 item.color in "red", "blue" [+] [-]
The user can click on the [+] to add another color to the test 
 item.color in "red", "blue", "black" [+] [-]
The UI must call getExpressionTable().add() to add a new expression for "black". When the user clicks [-], the UI calls getExpressionTable().remove(getExpressionTable().size()-1)
See Also:

  • Field Details

  • Method Details

    • hasFactType

      public boolean hasFactType()
      Specified by:
      hasFactType in class FactBinding<SimpleTest>

    • getMatchOp

      public String getMatchOp(Expression e)
      Description copied from interface: ExpressionContext
      A child calls this method in the parent to see if the data type is appropriate for the context of the parent. Example, in the expression x == y, the Expression y asks its parent the type of x and the operator used between the two
      Specified by:
      getMatchOp in interface ExpressionContext

    • getMatchTypeIDs

      public DOID[] getMatchTypeIDs(Expression e)
      type of left determines type of right. if left has no type and right does, type of right determines type of left
      Specified by:
      getMatchTypeIDs in interface ExpressionContext

    • isValueRequired

      public boolean isValueRequired(Expression e)
      Description copied from interface: ExpressionContext
      A child calls this method in the parent to see if it must have a value != ""
      Specified by:
      isValueRequired in interface ExpressionContext

    • validate

      public void validate(List<SDKException> errors, List<SDKWarning> warnings)
      Description copied from class: DictionaryComponent
      Validate and append errors and warnings.
      Overrides:
      validate in class FactBinding<SimpleTest>
      Parameters:
      errors - a List of error exceptions to append to.
      warnings - a List of warning exceptions to append to.
      See Also:

    • getPropertyNames

      public String[] getPropertyNames()
      Specified by:
      getPropertyNames in interface UnnamedComponent
      Overrides:
      getPropertyNames in class FactBinding<SimpleTest>
      Returns:
      Array of property names available.

    • getStoredPropertyNames

      public String[] getStoredPropertyNames()
      Overrides:
      getStoredPropertyNames in class FactBinding<SimpleTest>
      Returns:
      Array of property names which are persisted in the order in which they appear in the schema.

    • isDraft

      public boolean isDraft()
      Description copied from interface: VerbalRuleComponent
      Is this Component a Draft?
      Specified by:
      isDraft in interface VerbalRuleComponent
      Returns:
      true if the component is a Draft, false otherwise

    • getFormProperty

      public TranslatedProperty getFormProperty()
      Get Form Property.
      Returns:
      TranslatedProperty

    • setForm

      public void setForm(String form)
      Set form of this test.
      Parameters:
      form - the untranslated form. Form can be set using a translated form string using getFormProperty().setTranslatedForm(translatedForm)

    • getForm

      public String getForm()
      Get untranslated form of this test. Translated form can be gotten from getFormProperty().getTranslatedValue()
      Returns:
      untranslated form

    • getFormOptions

      public String[] getFormOptions()
      Get untranslated options for the form of this test. Translated options can be gotten from getFormProperty().getTranslatedOptions()
      Returns:
      untranslated options

    • getFormSelected

      public int getFormSelected()

    • getOperatorProperty

      public SimpleTest.OperatorProperty getOperatorProperty()
      Get Operator Property.
      Returns:
      OperatorProperty

    • getOperator

      public String getOperator()

    • setOperator

      public void setOperator(String operator)

    • getOperatorID

      public DOID getOperatorID()

    • setOperatorID

      public void setOperatorID(DOID operator)

    • getOperatorOptions

      public String[] getOperatorOptions()

    • getOperatorSelected

      public int getOperatorSelected()

    • getExpressionTableProperty

      public TableProperty<Expression> getExpressionTableProperty()
      Get ExpressionTable Property.
      Returns:
      Expression TableProperty

    • getExpressionTable

      public ExpressionTable getExpressionTable()
      Get the expressions. In simple form, the expressions are related by the test operator. Entry 0 is the left hand side, entry 1 is the right hand side. Entry 2 and above may apply if getRightSeparator() returns other than "". Aggregate uses 1 expression. Rule test variables use 1 expression. The expression form uses 1 expression.
      Returns:
      expression table

    • getExpression

      public Expression getExpression()
      Short for getExpressionTable.get(0)
      Returns:
      first expression in the table

    • getLeft

      public Expression getLeft()
      Short for getExpressionTable().get(0)
      Returns:
      first expression in the table

    • getRight

      public Expression getRight()
      Short for getExpressionTable.get(1)
      Returns:
      second expression in the table

    • getConnectiveProperty

      public TranslatedProperty getConnectiveProperty()
      Get Connective Property.
      Returns:
      TranslatedProperty

    • getConnective

      public String getConnective()
      Get the connective (and/or) combining this pattern with the next in the table. Defaults to Util.CONNECTIVE_AND if not set

    • setConnective

      public void setConnective(String connective)
      Set the connective (and/or) combining this pattern with the next in the table. Defaults to Util.CONNECTIVE_AND if not set

    • getConnectiveOptions

      public String[] getConnectiveOptions()

    • getConnectiveSelected

      public int getConnectiveSelected()

    • getSimpleTestTableProperty

      public TableProperty<SimpleTest> getSimpleTestTableProperty()
      Get SimpleTestTable Property.
      Returns:
      SimpleTest TableProperty

    • getSimpleTestTable

      public SimpleTestTable getSimpleTestTable()
      Get the nested table of SimpleTests. This must contain at least one entry if the form is set to FORM_NESTED_TABLE

    • get

      public Object get(Object key)
      Description copied from class: DictionaryComponent
      Generic property getter.

      Please see the specific bean class for a list of properties.

      Specified by:
      get in interface Map<String,Object>
      Overrides:
      get in class FactBinding<SimpleTest>
      Parameters:
      key - a String containing the property name to be fetched.
      Returns:
      the value corresponding to the key: a String, String[], DictionaryComponent, DictionaryComponentTable, etc.

    • put

      public Object put(String key, Object value)
      Description copied from class: DictionaryComponent
      Generic property setter. Throws runtime exceptions for incorrect arguments. Please see the specific bean class for a list of properties, their types, and permissible values.

      A put() with either null key or null value throws a NullPointerException.

      A put() with a key that is not a String throws a ClassCastException

      A put() of a value that is not of the correct type for the key throws a ClassCastException.

      Bean properties which have no set() method are read only, and cannot be modified using the put(). Attempting to do so throws a runtime IllegalArgumentException. PROP_ID, and PROP_*_SELECTED are always read only.

      Specified by:
      put in interface Map<String,Object>
      Overrides:
      put in class FactBinding<SimpleTest>
      Parameters:
      key - the key of the property to set
      value - the value of the named property to set
      Returns:
      the previous value of the property

    • getRightSeparator

      public String getRightSeparator()

    • desurround

      public SimpleTest desurround()
      if this is a nested simple test, replace it with the nested simple tests. If not nested, do nothing. If the return value is not this SimpleTest, then this SimpleTest has been removed from the dictionary and should not be referenced again.
      Returns:
      the simple test replacing this one, or this if this is not nested, or null, if this is nested but empty

    • surround

      public static SimpleTest surround(List<SimpleTest> sts)

    • surround

      public static SimpleTest surround(String form, List<SimpleTest> sts)

    • surround

      public SimpleTest surround()

    • surround

      public SimpleTest surround(String form)

    • getSurroundingFormOptions

      public static String[] getSurroundingFormOptions(List<SimpleTest> sts)

    • getTranslatedSurroundingFormOptions

      public String[] getTranslatedSurroundingFormOptions()

    • isBuiltInOperator

      public boolean isBuiltInOperator()

    • isVisible

      public boolean isVisible()
      Should this test be rendered? Tree mode generates join tests that are hidden in tree mode. Forms SOME_FACT and NO_FACT render the fact type(s) along with the test, but store the fact type(s) as the first non-visible nested IS_A test(s)
      Returns:
      boolean flag

    • setVisible

      public void setVisible(boolean flag)
      Set whether this test should be rendered. Forms SOME_FACT and NO_FACT render the fact type(s) along with the test, but store the fact type(s) as the first hidden nested IS_A test(s). A SOME_FACT or NO_FACT test must have one or more non-visible nested IS_A tests to represent the fact type(s) selected.

    • getAEReferences

      public List<DOID> getAEReferences()
      Description copied from class: DictionaryComponent
      Get the DOIDs referenced by all directly or indirectly contained actions and expressions
      Overrides:
      getAEReferences in class DictionaryComponent<SimpleTest>
      Returns:
      list of the DOIDs

    • inScopeVariables

      public List<ScopedVariable> inScopeVariables(boolean includeAggregates, VariableScope.ExprLocation loc)
      Description copied from class: RuleComponent
      By default, pass the request to the container
      Specified by:
      inScopeVariables in interface VariableScope
      Overrides:
      inScopeVariables in class RuleComponent<SimpleTest>

    • getAlias

      public String getAlias()
      Even though we extend UnnamedComponent, we need the variable name to translate expressions from persistent format (`ID`) to user format (name)
      Specified by:
      getAlias in interface UnnamedComponent
      Overrides:
      getAlias in class DictionaryComponent<SimpleTest>
      Returns:
      the name of the fact bind variable

    • getAlias

      public String getAlias(boolean translate)
      Description copied from class: DictionaryComponent
      Get alias of DictionaryComponent.
      Specified by:
      getAlias in interface ScopedVariable
      Overrides:
      getAlias in class DictionaryComponent<SimpleTest>
      Parameters:
      translate - whether to get the translated alias
      Returns:
      translated alias of the dictionary component, or alias if translation does not exist

    • getVariableRL

      public Object getVariableRL()
      Specified by:
      getVariableRL in interface ScopedVariable
      Overrides:
      getVariableRL in class FactBinding<SimpleTest>

    • getFactTypeID

      public DOID getFactTypeID()
      Description copied from class: FactBinding
      Get the ID of the fact type.
      Specified by:
      getFactTypeID in interface ScopedVariable
      Overrides:
      getFactTypeID in class FactBinding<SimpleTest>

    • setVariableRL

      public void setVariableRL(int varNum)
      Specified by:
      setVariableRL in interface ScopedVariable
      Overrides:
      setVariableRL in class FactBinding<SimpleTest>

    • isAssignable

      public boolean isAssignable()
      Specified by:
      isAssignable in interface ScopedVariable

    • isNested

      public boolean isNested()
      is this test nested, e.g. (...) or not(...)
      Returns:
      boolean

    • getProperties

      public Collection<DictionaryProperty> getProperties(boolean storedOnly)
      Overrides:
      getProperties in class DictionaryComponent<SimpleTest>

    • getValueProperty

      public VerbalProperty getValueProperty()
      Description copied from interface: VerbalRuleComponent
      Get the Value Property.
      Specified by:
      getValueProperty in interface VerbalRuleComponent
      Returns:
      VerbalProperty

    • suggest

      public List<VerbalChoice> suggest(String pattern, boolean paged)
      Returns a list of VerbalChoices for the SimpleTest filtered by the pattern.
      Specified by:
      suggest in interface VerbalRuleComponent
      Parameters:
      pattern - to filter the Verbal choices by
      paged - true if choices are to be paged
      Returns:
      A list of filtered Verbal choices

    • setValue

      public void setValue(VerbalChoice value)
      Sets the Value of the RuleComponent
      Specified by:
      setValue in interface VerbalRuleComponent
      Parameters:
      value - VerbalChoice

    • getValue

      public VerbalChoice getValue()
      Description copied from interface: VerbalRuleComponent
      Gets the Value of the RuleComponent
      Specified by:
      getValue in interface VerbalRuleComponent
      Returns:
      VerbalChoice

    • suggestGenericChoices

      public List<VerbalChoice> suggestGenericChoices(String pattern)
      Description copied from interface: VerbalRuleComponent
      Get the list of Generic Verbal Choices based on this pattern. These choices would be used in case the pattern does not match any of the choices that are pre-computed or derived from DSLs.
      Specified by:
      suggestGenericChoices in interface VerbalRuleComponent
      Parameters:
      pattern - search pattern
      Returns:
      A list of generic Verbal Choices provided by this component