Package oracle.rules.sdk2.ruleset

Class Pattern

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<Pattern>
oracle.rules.sdk2.ruleset.Pattern
All Implemented Interfaces:
Serializable, Cloneable, Map<String,Object>, UnnamedComponent, ExpressionContext, ScopedVariable, VariableScope
public class Pattern extends FactBinding<Pattern> implements ScopedVariable, ExpressionContext
Note: As of OBR 12, Patterns are used in simple mode have no tests.

A Pattern is used to structure rule conditions. A Pattern has a form property, one of

  • FORM_NESTED_TABLE - this Pattern represents a block of Patterns. Only the nestedTable, a PatternTable, testForm, expression, simpleTestTable, connective, and operator properties of the Pattern should be used.
  • FORM_FACT_TYPE - this Pattern declares a variable that matches fact types in working memory. Only the variable, factType, testForm, expression, simpleTestTable, and connective properties of the Pattern should be used. This form is the default.
  • FORM_FACT_PATH - this Pattern declares variable that matches a path of joins through 0 or more List<Child> properties. It is used in Tree Mode rules to suppress display of these join SimpleTests. Property usage is as for FORM_FACT_TYPE with the additional factPath property, and the restriction that factType should not be settable except for the root Pattern.
A brief overview of Pattern properties:
  • testForm - one of TEST_FORM_SIMPLE, TEST_FORM_ADVANCED, TEST_FORM_NOTEST
  • simpleTestTable - used when testForm is TEST_FORM_SIMPLE
  • expression - used when testForm is TEST_FORM_ADVANCED, contains a boolean expression
  • factType - a visible fact type
  • factPath - a path, e.g. PurchaseOrder/item
  • variable - name of variable. Defaults to factType or factPath
  • operator - one of OPERATOR_FOREACH (the default), OPERATOR_SOME, OPERATOR_NONE, or OPERATOR_AGGREGATE
  • connective - one of CONNECTIVE_AND (the default), CONNECTIVE_OR. If a pattern follows this Pattern in a PatternTable, then it is logically connected using AND or OR.
For example, consider the following condition "no zebras are pink": 
 IF
   there is no case where {
     z is a Zebra and
       z.color == "pink"
 THEN
   ...
Code to construct this condition: 
 Pattern outer = rule.getRoot();
 outer.setForm(Pattern.FORM_NESTED_TABLE);
 outer.setOperator(Pattern.OPERATOR_NONE);
 Pattern nested = outer.getNestedTable().add();
 nested.setFactType("Zebra");
 nested.setVariable("z");
 nested.setTestForm(Pattern.TEST_FORM_SIMPLE);
 SimpleTest test = nested.getSimpleTestTable().add();
 test.getLeft().setValue("z.color");
 test.getRight().setLiteralValue("pink");

See Also:

  • Field Details

    • FORM_FACT_TYPE

      public static final String FORM_FACT_TYPE
      Use with Pattern Form. Default is FORM_FACT_TYPE. FORM_NESTED_TABLE is used for a pattern block.
      See Also:

    • FORM_NESTED_TABLE

      public static final String FORM_NESTED_TABLE
      See Also:

    • FORM_FACT_PATH

      public static final String FORM_FACT_PATH
      See Also:

    • OPERATOR_FOREACH

      public static final String OPERATOR_FOREACH
      Use with Pattern Operator. Default is OPERATOR_FOREACH. 
       OPERATOR_FOREACH corresponds to RL no pattern operator
 OPERATOR_SOME  corresponds to RL exists pattern operator
 OPERATOR_NONE corresponds to RL not pattern operator
 OPERATOR_AGGREGATE corresponds to RL aggregate operator
      See Also:

    • OPERATOR_SOME

      public static final String OPERATOR_SOME
      See Also:

    • OPERATOR_NONE

      public static final String OPERATOR_NONE
      See Also:

    • OPERATOR_AGGREGATE

      public static final String OPERATOR_AGGREGATE
      See Also:

    • CONNECTIVE_AND

      public static final String CONNECTIVE_AND
      See Also:

    • CONNECTIVE_OR

      public static final String CONNECTIVE_OR
      See Also:

    • TEST_FORM_NOTEST

      public static final String TEST_FORM_NOTEST
      Specifies test form. Default is TEST_FORM_SIMPLE. TEST_FORM_NOTEST indicates the Pattern does not have an associated test.
      See Also:

    • TEST_FORM_SIMPLE

      public static final String TEST_FORM_SIMPLE
      TEST_FORM_SIMPLE Specifies the use of SimpleTest, located in SimpleTestTable.
      See Also:

    • TEST_FORM_ADVANCED

      public static final String TEST_FORM_ADVANCED
      TEST_FORM_ADVANCED Specifies the use of boolean Expression located in Expression property.
      See Also:

  • Method Details

    • desurround

      public void desurround()

    • surround

      public static Pattern surround(List<Pattern> patterns)

    • surround

      public static Pattern surround(String form, List<Pattern> patterns)

    • surround

      public Pattern surround()

    • surround

      public Pattern surround(String form)

    • getSurroundingFormOptions

      public static String[] getSurroundingFormOptions(List<Pattern> patterns)

    • get

      public Object get(Object key)
      Generic property getter (override).

      Get fact type from ID.

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

    • 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<Pattern>
      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

    • getSimpleTestLeft

      public Expression getSimpleTestLeft(int i)
      Shorthand for getSimpleTestTable.getSimpleTest(i).getLeft()
      Parameters:
      i - ordinal of SimpleTest to retrieve from SimpleTestTable
      Returns:
      the Expression on the left side of the SimpleTest
      Throws:
      IndexOutOfBoundsException

    • getSimpleTestRight

      public Expression getSimpleTestRight(int i)
      Shorthand for getSimpleTestTable.getSimpleTest(i).getRight()
      Parameters:
      i - ordinal of SimpleTest to retrieve from SimpleTestTable
      Returns:
      the Expression on the right side of the SimpleTest
      Throws:
      IndexOutOfBoundsException

    • getSimpleTestOperator

      public String getSimpleTestOperator(int i)
      Shorthand for getSimpleTestTable.getSimpleTest(i).getOperator()
      Parameters:
      i - ordinal of SimpleTest to retrieve from SimpleTestTable
      Returns:
      the Operator of the SimpleTest
      Throws:
      IndexOutOfBoundsException

    • 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<Pattern>
      Parameters:
      errors - a List of error exceptions to append to.
      warnings - a List of warning exceptions to append to.
      See Also:

    • getStoredPropertyNames

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

    • getPropertyNames

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

    • getFormProperty

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

    • getForm

      public String getForm()
      Get Form describing whether this Pattern simple fact type or a subtable of fact types. See Pattern description or FORM_

    • setForm

      public void setForm(String form)
      Set Form to FORM_FACT_TYPE, FORM_FACT_PATH, or FORM_NESTED_TABLE. Note! For historical reasons, when you change to nested table, the fact type/path properties are copied to a newly created Pattern in the getNestedTable().

    • getFormOptions

      public String[] getFormOptions()

    • getFormSelected

      public int getFormSelected()

    • getTestFormProperty

      public TranslatedProperty getTestFormProperty()
      Get TestForm Property.
      Returns:
      TranslatedProperty

    • getTestForm

      public String getTestForm()
      get type of test associated with the Pattern. see Pattern description or TEST_FORM see TEST_FORM_ above

    • setTestForm

      public void setTestForm(String testForm)
      set type of test associated with the Pattern. see Pattern description or TEST_FORM see TEST_FORM_ above

    • getTestFormOptions

      public String[] getTestFormOptions()

    • getTestFormSelected

      public int getTestFormSelected()

    • getSimpleTestTableProperty

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

    • getSimpleTestTable

      public SimpleTestTable getSimpleTestTable()
      Get the table of tests for this Pattern. For use when hasFactType(). See SimpleTest

    • getExpressionProperty

      public DictionaryProperty<Expression> getExpressionProperty()
      Get Expression Property.
      Returns:
      Expression DictionaryProperty

    • getExpression

      public Expression getExpression()

    • getVariableProperty

      public FactBinding.VariableProperty getVariableProperty()
      Get Variable Property.
      Overrides:
      getVariableProperty in class FactBinding<Pattern>
      Returns:
      String SettableProperty

    • getVariable

      public String getVariable()
      Overrides:
      getVariable in class FactBinding<Pattern>

    • getVariable

      public String getVariable(boolean translate)
      Overrides:
      getVariable in class FactBinding<Pattern>

    • setVariable

      public void setVariable(String variable)
      Overrides:
      setVariable in class FactBinding<Pattern>

    • getOperatorProperty

      public SettableProperty<String> getOperatorProperty()
      Get Operator Property.
      Returns:
      String SettableProperty

    • getOperatorTransProperty

      public TranslatedProperty getOperatorTransProperty()
      Bug 33090834 Get Operator Translated Property.
      Returns:
      TranslatedProperty

    • getOperator

      public String getOperator()
      Get Pattern operator. See OPERATOR_FOREACH. Defaults to OPERATOR_FOREACH

    • setOperator

      public void setOperator(String operator)
      Set Pattern operator. See OPERATOR_FOREACH. Defaults to OPERATOR_FOREACH

    • getOperatorOptions

      public String[] getOperatorOptions()

    • getOperatorSelected

      public int getOperatorSelected()

    • getConnectiveProperty

      public SettableProperty<String> getConnectiveProperty()
      Get Connective Property.
      Returns:
      String SettableProperty

    • getConnective

      public String getConnective()
      Get connective (and/or) which combines this Pattern with the following Pattern, if any. See Util.CONNECTIVE_AND. Defaults to CONNECTIVE_AND.

    • setConnective

      public void setConnective(String connective)
      Set connective (and/or) which combines this Pattern with the following Pattern, if any. See Util.CONNECTIVE_AND. Defaults to CONNECTIVE_AND.

    • getConnectiveOptions

      public String[] getConnectiveOptions()

    • getConnectiveSelected

      public int getConnectiveSelected()

    • getNestedTableProperty

      public TableProperty<Pattern> getNestedTableProperty()
      Get NestedTable Property.
      Returns:
      Pattern TableProperty

    • getNestedTable

      public PatternTable getNestedTable()
      Get the the Pattern subtable when Form is FORM_NESTED_TABLE. Operators and conjunctions apply to the whole table. FactTypes are ignored in this form.

    • getAggregteTableProperty

      public TableProperty<Aggregate> getAggregteTableProperty()
      Get AggregateTable Property.
      Returns:
      Aggregate TableProperty

    • getAggregateTable

      public AggregateTable getAggregateTable()
      Get the the Aggregate subtable when Operator is OPERATOR_AGGREGATE.

    • 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<Pattern>
      Returns:
      the name of the pattern 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<Pattern>
      Parameters:
      translate - whether to get the translated alias
      Returns:
      translated alias of the dictionary component, or alias if translation does not exist

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

    • 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<Pattern>

    • isAssignable

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

    • isVisible

      public boolean isVisible()

    • hasFactType

      public boolean hasFactType()
      Does the pattern have a fact type? True iff form is FORM_FACT_TYPE or FORM_FACT_PATH
      Specified by:
      hasFactType in class FactBinding<Pattern>
      Returns:
      boolean