Package oracle.rules.sdk2.ruleset

Class Expression

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<Expression>
oracle.rules.sdk2.ruleset.Expression
All Implemented Interfaces:
Serializable, Cloneable, Map<String,Object>, UnnamedComponent, VariableScope
public class Expression extends UnnamedRuleComponent<Expression>
An expression is a String containing one or more primary expression terms.

The validate() methods validate that the expression is syntactically and semantically correct for the context in which it is used.

The expression value is a string as the user sees it. The resolved value has aliases replaced with IDs in backquotes (e.g. `L}10`). The value and resolved value are synchronized (changing one changes the other). Most users never need to worry about the resolved value.

An expression may be designated as a constant. This affects the value options and makes string quotes optional on input.

See Also:

  • Constructor Details

  • Method Details

    • getValueProperty

      public Expression.ExpressionValueProperty getValueProperty()
      Get Value Property.
      Returns:
      ChoosableProperty

    • getValue

      public String getValue()
      returns the String value of the Expression

    • setValue

      public void setValue(String value)

    • getValueOptions

      public String[] getValueOptions()
      get some options for an expression value appropriate in this context
      Returns:
      array containing valid options for the value of this expression

    • getValueSelected

      public int getValueSelected()

    • getConstantProperty

      public SettableProperty<Boolean> getConstantProperty()
      Get Constant Property.
      Returns:
      Boolean SettableProperty

    • isConstant

      public boolean isConstant()

    • setConstant

      public void setConstant(boolean flag)

    • getDTActionParameterNameProperty

      public SettableProperty<String> getDTActionParameterNameProperty()
      Get DTActionParameterName Property.
      Returns:
      String SettableProperty

    • getDTActionParameterName

      public String getDTActionParameterName()
      get the name of the decision table action parameter associated with this expression Expressions are marked with this property in the Action of the DTAction and in the ExpressionTable of an associated DTActionNode to indicate the node supplies parameter values to the action.
      Returns:
      String name, or "" if this is not a DTAction parameter.
      See Also:

    • setDTActionParameterName

      public void setDTActionParameterName(String name)
      set this expression as a decision table action parameter with the given name
      Parameters:
      name -

    • getImmutableVariableProperty

      public ChoosableProperty getImmutableVariableProperty()
      Get ImmutableVariable Property.
      Returns:
      ChoosableProperty

    • getConstant

      @Deprecated public String getConstant()
      Deprecated.
      use getImmutableVariable()

    • getImmutableVariable

      public String getImmutableVariable()

    • setConstant

      @Deprecated public void setConstant(String constant)
      Deprecated.
      use setImmutableVariable(java.lang.String)

    • setImmutableVariable

      public void setImmutableVariable(String constant)

    • getConstantOptions

      @Deprecated public String[] getConstantOptions()
      Deprecated.
      use getImmutableVariableOptions()

    • getImmutableVariableOptions

      public String[] getImmutableVariableOptions()
      Get immutable variables (e.g. final variables, pattern variables)
      Returns:
      array of terms

    • getConstantSelected

      @Deprecated public int getConstantSelected()
      Deprecated.
      use getImmutableVariableSelected()

    • getImmutableVariableSelected

      public int getImmutableVariableSelected()

    • getOperatorProperty

      public ChoosableProperty getOperatorProperty()
      Get Operator Property.
      Returns:
      ChoosableProperty

    • getOperator

      public String getOperator()

    • setOperator

      public void setOperator(String operator)

    • getOperatorOptions

      public String[] getOperatorOptions()

    • getOperatorSelected

      public int getOperatorSelected()

    • getMutableVariableProperty

      public ChoosableProperty getMutableVariableProperty()
      Get MutableVariable Property.
      Returns:
      ChoosableProperty

    • getVariable

      @Deprecated public String getVariable()
      Deprecated.
      Use getMutableVariable()

    • getMutableVariable

      public String getMutableVariable()

    • setVariable

      @Deprecated public void setVariable(String variable)
      Deprecated.
      Use setMutableVariable(java.lang.String)

    • setMutableVariable

      public void setMutableVariable(String variable)

    • getVariableOptions

      @Deprecated public String[] getVariableOptions()
      Deprecated.
      Use getMutableVariableOptions()

    • getMutableVariableOptions

      public String[] getMutableVariableOptions()
      Get variables that could be assignment targets E.g. non-final globals, pattern properties
      Returns:
      array of terms

    • getVariableSelected

      @Deprecated public int getVariableSelected()
      Deprecated.
      Use getMutableVariableSelected()

    • getMutableVariableSelected

      public int getMutableVariableSelected()

    • getFunctionProperty

      public ChoosableProperty getFunctionProperty()
      Get Function Property.
      Returns:
      ChoosableProperty

    • getFunction

      public String getFunction()

    • setFunction

      public void setFunction(String function)

    • getFunctionOptions

      public String[] getFunctionOptions()

    • getFunctionSelected

      public int getFunctionSelected()

    • getConstructorProperty

      public ChoosableProperty getConstructorProperty()
      Get Constructor Property.
      Returns:
      ChoosableProperty

    • getConstructor

      public String getConstructor()

    • setConstructor

      public void setConstructor(String constructor)

    • getConstructorOptions

      public String[] getConstructorOptions()

    • getConstructorSelected

      public int getConstructorSelected()

    • getResultTypeID

      public DOID getResultTypeID()
      Get Result Type ID, reparsing the expression if needed.

    • getResultID

      public DOID getResultID()

    • getResultToken

      public ExprParser.Token getResultToken()

    • getExprParser

      public ExprParser getExprParser()
      Internal use Only.
      Returns:
      ExprParser

    • 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 DictionaryComponent<Expression>
      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 UnnamedRuleComponent<Expression>
      Returns:
      Array of property names available.

    • getStoredPropertyNames

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

    • getParameterName

      public String getParameterName()

    • getParameterAlias

      public String getParameterAlias()
      Get parameter alias
      Returns:
      parameter alias

    • getParameterAlias

      public String getParameterAlias(boolean translate)
      Get possibly translated parameter alias
      Parameters:
      translate -
      Returns:
      parameter alias

    • getParameterID

      public DOID getParameterID()

    • getParameterTypes

      public String[] getParameterTypes()
      Get possibly overloaded parameter types
      Returns:
      String[] of type aliases

    • getParameterTypes

      public String[] getParameterTypes(boolean translate)
      Get possibly translated and overloaded parameter types
      Parameters:
      translate -
      Returns:
      String[] of type aliases

    • getParameterTypeIDs

      public DOID[] getParameterTypeIDs()
      Get possibly overloaded parameter types
      Returns:
      DOID[] of type IDs

    • isParameterRequired

      public boolean isParameterRequired()
      true if, according to the data model, this Expression must be supplied

    • setLiteralValue

      public void setLiteralValue(String literalValue)
      Shorthand for setConstant(true); setValue(literalValue);

    • isCustomizable

      @Deprecated public boolean isCustomizable()
      Deprecated.
      no replacement

    • setCustomizable

      @Deprecated public void setCustomizable(boolean flag)
      Deprecated.
      no replacement

    • getShowFunctions

      public boolean getShowFunctions()
      Get Show functions and methods in ValueOptions

    • setShowFunctions

      public void setShowFunctions(boolean showFunctions)
      Set Show functions and methods in ValueOptions

    • getShowConstants

      public boolean getShowConstants()
      Get Show constants in ValueOptions

    • setShowConstants

      public void setShowConstants(boolean showConstants)
      Set Show constants in ValueOptions

    • getShowVariables

      public boolean getShowVariables()
      Get Show variables in ValueOptions

    • setShowVariables

      public void setShowVariables(boolean showVariables)
      Set Show variables in ValueOptions

    • same

      public boolean same(Expression expr)
      Is this expression the same as expr?
      Parameters:
      expr -
      Returns:
      whether this is the same expression as expr

    • 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 UnnamedRuleComponent<Expression>
      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 UnnamedRuleComponent<Expression>
      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

    • getRL

      public boolean getRL(StringBuilder sb, Map<Object,Object> properties)
      public getRL

    • getAutoPatternPropertyOptions

      @Deprecated public String[] getAutoPatternPropertyOptions()
      Deprecated.
      No replacement. A no-op.

    • getReferences

      public List<DOID> getReferences()
      Description copied from class: DictionaryComponent
      Get the DOIDs referenced by this component (but not the contained components)
      Overrides:
      getReferences in class DictionaryComponent<Expression>
      Returns:
      list of the DOIDs

    • 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<Expression>
      Returns:
      list of the DOIDs

    • getAllReferences

      public List<DOID> getAllReferences()
      Description copied from class: DictionaryComponent
      Get the DOIDs referenced by this component or contained components
      Overrides:
      getAllReferences in class DictionaryComponent<Expression>
      Returns:
      list of the DOIDs

    • getExprParserReferences

      public List<ExprParser> getExprParserReferences()
      Description copied from class: DictionaryComponent
      Get all ExprParsers that are directly or Indirectly referenced by this dictionary Object and its descendants
      Overrides:
      getExprParserReferences in class DictionaryComponent<Expression>
      Returns:
      Collection of Expression Parsers

    • getDependentModelComponents

      public List<ModelComponent> getDependentModelComponents()

    • balanced

      public int[][] balanced()
      Matches up operators which come in pairs, such as ( ), then returns an array of ordered pairs of the matches. The integer is the offset into the expression String. This allows applications to indicate to in the view which grouping operators are paired.
      Returns:
      an Array of ordered pairs (dimensions int [][2])of indexes into the expression String

    • unbalanced

      public int[] unbalanced()
      Matches up operators which come in pairs, such as ( ), then returns an array of integers indicating unmatched grouping operators. The integer is the offset into the expression String.
      Returns:
      an array of offsets into the expression String

    • setShowConstructorsWithFunctions

      public void setShowConstructorsWithFunctions(boolean b)
      Include Constructors in the Function options list

    • append

      public String append(String str)
      Append the given string to the end of the existing Value Behavior is the same as the append method of java.lang.StringBuffer, except that a null value of str inserts the String "null". No exceptions are thrown.
      Parameters:
      str - the String to append
      Returns:
      the new String (also available by calling getValue()

    • insert

      public String insert(int offset, String str)
      Insert the given string at the given position of the Value. Behavior is the same as the insert method of java.lang.StringBuffer, except that invalid values for start and end are adjusted to the closest valid values, and a null value of str inserts the String "null". No exceptions are thrown. 
        0 <= offset <= getExpression.length()
      Parameters:
      offset - where to insert the text, 0 based
      str - the text to insert
      Returns:
      the new String (also available by calling getValue()

    • replace

      public String replace(int start, int end, String str)
      Insert the given string at the given position of the Value String. Behavior is the same as the replace method of java.lang.StringBuffer, except that invalid values for start and end are adjusted to the closest valid values, and a null value of str inserts the String "null". No exceptions are thrown. 
        0 <= start <= end <= getExpression.length()
      Parameters:
      start - beginning index of substring to replace, 0 based
      end - ending index of substring to replace, 0 based
      str - the text to insert
      Returns:
      the new String (also available by calling getValue()

    • getCursorPosition

      public int getCursorPosition()

    • setCursorPosition

      public void setCursorPosition(int cursorPosition)

    • getTokenUnderCursor

      public Token getTokenUnderCursor()
      If the cursor is in a token or white space preceeding the token, returns a description of the token. If in whitespace following the last token, returns the last token. In cases where the Value is all spaces or comments, Token.getType() returns TYPE_ALL_SPACES.

    • evaluateConstant

      public String evaluateConstant()
      if the expression can be evaluated at design time, returns its literal value. Else return null
      Returns:
      String literal value or null

    • getExpressionContext

      public ExpressionContext getExpressionContext()
      Returns:
      ExpressionContext

    • setParameterRequired

      @Deprecated public void setParameterRequired(boolean parameterRequired)
      Deprecated.
      No replacement. A no-op.

    • getValue

      public String getValue(boolean translate)
      get optionally translated value short for getValueProperty().getValue(translate)
      Parameters:
      translate -
      Returns:
      optionally translated value

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

    • getDiffMatchValue

      public String getDiffMatchValue()
      Description copied from interface: UnnamedComponent
      value to use matching table entries, "" means use positional matching
      Specified by:
      getDiffMatchValue in interface UnnamedComponent
      Overrides:
      getDiffMatchValue in class UnnamedRuleComponent<Expression>
      Returns:
      the value to use for matching components in tables, default is name

    • getAliasedExpression

      public Expression getAliasedExpression()
      if this expression is a reference to a rule test variable, return the expression aliased by the variable. else return null.

    • isModifiable

      public boolean isModifiable()
      Overrides:
      isModifiable in class DictionaryComponent<Expression>