Package oracle.rules.sdk2.datamodel

Class DSL

java.lang.Object
oracle.rules.sdk2.dictionary.DictionaryObject
oracle.rules.sdk2.dictionary.DictionaryComponent<T>
oracle.rules.sdk2.datamodel.ModelComponent<T>
oracle.rules.sdk2.datamodel.UnnamedModelComponent<DSL>
oracle.rules.sdk2.datamodel.DSL
All Implemented Interfaces:
Serializable, Cloneable, Map<String,Object>, ActionContext, UnnamedComponent, AutoBindingContext, VariableScope
public class DSL extends UnnamedModelComponent<DSL> implements VariableScope, ActionContext, AutoBindingContext
Since:
12.1.2
Author:
ganradha
See Also:

  • Field Details

    • FORM_TEST

      public static final String FORM_TEST
      Indicates a Domain Mapping for Tests Only SimpleTestTable property is used.
      See Also:

    • FORM_ACTION

      public static final String FORM_ACTION
      Indicates a Domain Mapping for Actions Only ActionTable property is used.
      See Also:

  • Method Details

    • getStoredPropertyNames

      public String[] getStoredPropertyNames()
      Overrides:
      getStoredPropertyNames in class UnnamedModelComponent<DSL>
      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 UnnamedModelComponent<DSL>
      Returns:
      Array of property names available.

    • getValue

      public String getValue()
      Get DSL Definition Value
      Returns:
      DSL definition Value

    • setValue

      public void setValue(String value)
      Set DSL Definition Value
      Parameters:
      value - Definition Value

    • getTranslatedValue

      public String getTranslatedValue()
      Get translated DSL Definition Value.
      Returns:
      translated DSL Definition Value, or "" if no translation available

    • setTranslatedValue

      public void setTranslatedValue(String value)
      Set translated DSL Definition Value
      Parameters:
      value - Definition Value

    • getValue

      public String getValue(boolean translate)
      Get DSL Definition Value
      Parameters:
      translate - whether to get the translated value
      Returns:
      translated DSL Definition value, or value if translation does not exist

    • setValue

      public void setValue(String value, boolean translate)
      Set DSL Definition Value and optionally the translated Definition Value
      Parameters:
      value - New (translated) value.
      translate - whether to also set the translated value

    • isUnsavedTranslatedValue

      public boolean isUnsavedTranslatedValue()
      Is the translated Definition Value unsaved?
      Returns:
      true or false

    • getForm

      public String getForm()
      Get Form of DSL Mapping
      Returns:
      FORM_TEST or FORM_ACTION

    • setForm

      public void setForm(String form)
      Set Form of DSL Mapping
      Parameters:
      form - FORM_TEST or FORM_ACTION

    • getDSLParameterTable

      public DSLParameterTable getDSLParameterTable()
      Get the DSLParameterTable
      Returns:
      DSLParameterTable

    • getSimpleTestTable

      public SimpleTestTable getSimpleTestTable()
      Get SimpleTestTable for Mappings of form FORM_TEST
      Specified by:
      getSimpleTestTable in interface AutoBindingContext
      Returns:
      SimpleTestTable

    • getActionTable

      public ActionTable getActionTable()
      Get ActionTable for Mappings of form FORM_ACTION
      Returns:
      ActionTable

    • isTreeMode

      public boolean isTreeMode()
      is tree mode set?
      Specified by:
      isTreeMode in interface AutoBindingContext
      Returns:
      boolean

    • setTreeMode

      public void setTreeMode(boolean flag)
      Set Tree mode. This Property is only valid for Definitions with Mappings of form FORM_TEST Must call RuleDictionary.update(java.util.List<oracle.rules.sdk2.exception.SDKWarning>) after changing tree mode.
      Parameters:
      flag - boolean

    • isDraft

      public boolean isDraft()
      Is this DSL marked as a Draft?
      Returns:
      true if marked as a Draft, false otherwise

    • setDraft

      public void setDraft(boolean draft)
      Mark this DSL as a Draft
      Parameters:
      draft - boolean flag

    • getValueProperty

      public UserTranslatedProperty getValueProperty()

    • getFormProperty

      public TranslatedProperty getFormProperty()

    • getSimpleTestTableProperty

      public TableProperty getSimpleTestTableProperty()

    • getActionTableProperty

      public TableProperty getActionTableProperty()

    • getTreeModeProperty

      public SettableProperty<Boolean> getTreeModeProperty()

    • getDraftProperty

      public SettableProperty<Boolean> getDraftProperty()

    • getDSLParameterTableProperty

      public TableProperty getDSLParameterTableProperty()

    • getFormOptions

      public String[] getFormOptions()
      Gets the untranslated Form Options for this DSL Mapping For Translated Options use {@link oracle.rules.sdk2.datamodel.DSL#getFormProperty().getTranslatedOptions()}
      Returns:
      String[] Array of Strings representing the untranslated options

    • 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 UnnamedModelComponent<DSL>
      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

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

    • validate

      public void validate(List<SDKException> errors, List<SDKWarning> warnings, int modelChangeLowerBound, int ruleChangeLowerBound)
      Description copied from class: DictionaryObject
      Validate the RuleDictionary object. Append error and warning exceptions. Errors will cause RuleDictionary.update(java.util.List<oracle.rules.sdk2.exception.SDKWarning>) to throw an exception. A dictionary with warnings but no errors can be persisted.
      Overrides:
      validate in class DictionaryObject
      Parameters:
      errors - a List of error exceptions to append to.
      warnings - a List of warning exceptions to append to.
      modelChangeLowerBound - smallest ModelComponent.CreationUpdateNumber modified in thix tx.
      ruleChangeLowerBound - smallest RuleComponent.CreationUpdateNumber modified in thix tx. Rulesets and rules with UpdateNumber >= modelChangeLowerBound will be revalidated. a value of 0 will force revalidation of all rulesets. A value of Integer.MAX_VALUE will skip validation of all rulesets.

    • parseDefinition

      public Collection<String> parseDefinition(String definitionValue, boolean translate, List<SDKWarning> warnings)
      Parse parameter tokens in the definition Value and validate their usage. Parameter tokens in the definition Value should be enclosed within curly braces
      Returns:
      List of param tokens from the definitionValue

    • isParseable

      public boolean isParseable()
      Is the DSL Value parse-able or Not? The DSL is considered to be parse-able if a. There are no invalid usages of parameters in the Definition Value & Translated value (if any) b. All parameters used in the Definition Value are defined
      Returns:
      true if the above conditions are met, false otherwise

    • computeVerbalChoices

      public Collection<VerbalChoice> computeVerbalChoices(String pattern, Map<DOID,List<Choice>> inScopeTypeVariablesMap, Map<DOID,Expression> parameterExpressionMap)
      Compute the Verbal Choices derived from this DSL for the given in-scope variables and parameter Expressions
      Parameters:
      inScopeTypeVariablesMap - In Scope Variables aggregated by their Type
      parameterExpressionMap - Expressions for computing the DSL Parameter Values
      Returns:
      VerbalChoices

    • inScopeVariables

      public List<ScopedVariable> inScopeVariables(boolean includeAggregates, VariableScope.ExprLocation loc)
      Regardless of the location of the Expression requesting in scope variables, for both SimpleTest and Action mappings, DSL Parameters would provide bindings that would be in scope. Though only params of FORM_VARIABLE would be used to determine in scope DSLs, all the parameters are in the scope of this DSL Mapping.
      Specified by:
      inScopeVariables in interface VariableScope

    • getReturnExpressionTableSize

      public int getReturnExpressionTableSize()
      Specified by:
      getReturnExpressionTableSize in interface ActionContext
      Returns:
      Size of Return Expression Table

    • genRLBindVars

      public void genRLBindVars()
      Specified by:
      genRLBindVars in interface ActionContext

    • getRoot

      public FactBinding getRoot()
      Return the first test, creating if needed
      Specified by:
      getRoot in interface AutoBindingContext
      Returns:
      FactBinding

    • getRL

      public boolean getRL(StringBuilder sb, Map<Object,Object> properties, ExpressionTable expressionTable)
      Internal Use Only