|
Oracle Fusion Middleware Java API Reference for Oracle Business Rules 11g Release 1 (11.1.1.6.2) E10663-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.rules.sdk2.dictionary.DictionaryObject
oracle.rules.sdk2.dictionary.DictionaryComponent
oracle.rules.sdk2.ruleset.RuleComponent
oracle.rules.sdk2.ruleset.UnnamedRuleComponent
oracle.rules.sdk2.ruleset.Expression
public class 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.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class oracle.rules.sdk2.dictionary.DictionaryComponent |
---|
DictionaryComponent.Diff, DictionaryComponent.DiffType |
Nested classes/interfaces inherited from interface java.util.Map |
---|
java.util.Map.Entry<K,V> |
Field Summary |
---|
Method Summary | |
---|---|
java.lang.String |
append(java.lang.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". |
int[][] |
balanced() Matches up operators which come in pairs, such as ( ), then returns an array of ordered pairs of the matches. |
java.lang.String |
evaluateConstant() if the expression can be evaluated at design time, returns its literal value. |
java.util.List<DOID> |
getAEReferences() Get DOIDs referenced by this Object and descendants. |
java.util.List<DOID> |
getAllReferences() Get all DOIDs referenced by this Object and descendants. |
java.lang.String[] |
getAutoPatternPropertyOptions() get the list of auto pattern properties. |
java.lang.String |
getConstant() Deprecated. use Expression.getImmutableVariable() |
java.lang.String[] |
getConstantOptions() Deprecated. use Expression.getImmutableVariableOptions() |
SettableProperty<java.lang.Boolean> |
getConstantProperty() Get Constant Property. |
int |
getConstantSelected() Deprecated. use Expression.getImmutableVariableSelected() |
java.lang.String |
getConstructor() |
java.lang.String[] |
getConstructorOptions() |
ChoosableProperty |
getConstructorProperty() Get Constructor Property. |
int |
getConstructorSelected() |
int |
getCursorPosition() |
java.util.List<ModelComponent> |
getDependentModelComponents() |
java.lang.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. |
SettableProperty<java.lang.String> |
getDTActionParameterNameProperty() Get DTActionParameterName Property. |
java.lang.String |
getFunction() |
java.lang.String[] |
getFunctionOptions() |
ChoosableProperty |
getFunctionProperty() Get Function Property. |
int |
getFunctionSelected() |
java.lang.String |
getImmutableVariable() |
java.lang.String[] |
getImmutableVariableOptions() Get immutable variables (e.g. final variables, pattern variables) |
ChoosableProperty |
getImmutableVariableProperty() Get ImmutableVariable Property. |
int |
getImmutableVariableSelected() |
java.lang.String |
getMutableVariable() |
java.lang.String[] |
getMutableVariableOptions() Get variables that could be assignment targets E.g. non-final globals, pattern properties |
ChoosableProperty |
getMutableVariableProperty() Get MutableVariable Property. |
int |
getMutableVariableSelected() |
java.lang.String |
getOperator() |
java.lang.String[] |
getOperatorOptions() |
ChoosableProperty |
getOperatorProperty() Get Operator Property. |
int |
getOperatorSelected() |
java.lang.String |
getParameterAlias() |
DOID |
getParameterID() |
java.lang.String |
getParameterName() |
DOID[] |
getParameterTypeIDs() Get possibly overloaded parameter types |
java.lang.String[] |
getParameterTypes() Get possibly overloaded parameter types |
java.util.List<DOID> |
getReferences() Get all DOIDs referenced by this Component and IDTable properties, but does not include contained dictonary components. |
ExprParser.Token |
getResultToken() |
boolean |
getShowConstants() Get Show constants in ValueOptions |
boolean |
getShowFunctions() Get Show functions and methods in ValueOptions |
boolean |
getShowVariables() Get Show variables in ValueOptions |
Token |
getTokenUnderCursor() If the cursor is in a token or white space preceeding the token, returns a description of the token. |
java.lang.String |
getValue() returns the String value of the Expression |
java.lang.String[] |
getValueOptions() get some options for an expression value appropriate in this context |
ChoosableProperty |
getValueProperty() Get Value Property. |
int |
getValueSelected() |
java.lang.String |
getVariable() Deprecated. Use Expression.getMutableVariable() |
java.lang.String[] |
getVariableOptions() Deprecated. Use Expression.getMutableVariableOptions() |
int |
getVariableSelected() Deprecated. Use Expression.getMutableVariableSelected() |
java.lang.String |
insert(int offset, java.lang.String str) Insert the given string at the given position of the Value. |
boolean |
isConstant() |
boolean |
isCustomizable() is this expression customizable? |
boolean |
isParameterRequired() true if, according to the data model, this Expression must be supplied |
java.lang.String |
replace(int start, int end, java.lang.String str) Insert the given string at the given position of the Value String. |
boolean |
same(Expression expr) Is this expression the same as expr? |
void |
setConstant(boolean flag) |
void |
setConstant(java.lang.String constant) Deprecated. use Expression.setImmutableVariable(java.lang.String) |
void |
setConstructor(java.lang.String constructor) |
void |
setCursorPosition(int cursorPosition) |
void |
setCustomizable(boolean flag) set whether this expression is customizable |
void |
setDTActionParameterName(java.lang.String name) set this expression as a decision table action parameter with the given name |
void |
setFunction(java.lang.String function) |
void |
setImmutableVariable(java.lang.String constant) |
void |
setLiteralValue(java.lang.String literalValue) Shorthand for setConstant(true); setValue(literalValue); |
void |
setMutableVariable(java.lang.String variable) |
void |
setOperator(java.lang.String operator) |
void |
setParameterRequired(boolean parameterRequired) Deprecated. No replacement. A no-op. |
void |
setShowConstants(boolean showConstants) Set Show constants in ValueOptions |
void |
setShowConstructorsWithFunctions(boolean b) Include Constructors in the Function options list |
void |
setShowFunctions(boolean showFunctions) Set Show functions and methods in ValueOptions |
void |
setShowVariables(boolean showVariables) Set Show variables in ValueOptions |
void |
setValue(java.lang.String value) |
void |
setVariable(java.lang.String variable) Deprecated. Use Expression.setMutableVariable(java.lang.String) |
int[] |
unbalanced() Matches up operators which come in pairs, such as ( ), then returns an array of integers indicating unmatched grouping operators. |
Methods inherited from class oracle.rules.sdk2.ruleset.UnnamedRuleComponent |
---|
init, isAliasDistinct, isNameDistinct |
Methods inherited from class oracle.rules.sdk2.ruleset.RuleComponent |
---|
get, getParent, getParentTable, parentAction, parentActionContext, parentFunction, parentPattern, parentRule, parentRuleCommon, parentRuleSheet, parentVariable, RHSRuleVariables |
Methods inherited from class oracle.rules.sdk2.dictionary.DictionaryComponent |
---|
clear, containsKey, containsValue, entrySet, get, getAlias, getAlias, getAliasProperty, getCustom, getDependents, getDescription, getDescriptionProperty, getDiff, getDiffProperties, getDiffs, getFullyQualifiedAlias, getFullyQualifiedName, getIndex, getIndex, getName, getNameProperty, getNext, getObjectPath, getOptions, getPrevious, getProperties, getProperty, getSelected, hasDiff, isEmpty, isFullyQualifiedName, keySet, put, putAll, remove, setAlias, setCustom, setDescription, setName, size, validate, validate, values |
Methods inherited from class oracle.rules.sdk2.dictionary.DictionaryObject |
---|
equals, exists, getCombinedDataModel, getContainedIDs, getContainedIDs, getDataModel, getDictionary, getID, getIndent, getLevel, getObjectType, getParentByClass, getParentComponent, getParentComponentTable, getParentObject, getRuleSet, getState, getWarnings, hashCode, isModified, validate |
Methods inherited from class java.lang.Object |
---|
equals, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface oracle.rules.sdk2.dictionary.UnnamedComponent |
---|
getAlias, getName, getPropertyNames, setAlias, setName |
Methods inherited from interface java.util.Map |
---|
equals, hashCode |
Method Detail |
---|
public ChoosableProperty getValueProperty()
public java.lang.String getValue()
public void setValue(java.lang.String value)
public java.lang.String[] getValueOptions()
public int getValueSelected()
public SettableProperty<java.lang.Boolean> getConstantProperty()
public boolean isConstant()
public void setConstant(boolean flag)
public SettableProperty<java.lang.String> getDTActionParameterNameProperty()
public java.lang.String getDTActionParameterName()
DTAction
, DTActionNode
public void setDTActionParameterName(java.lang.String name)
name
-public ChoosableProperty getImmutableVariableProperty()
@Deprecated
public java.lang.String getConstant()
Expression.getImmutableVariable()
public java.lang.String getImmutableVariable()
@Deprecated
public void setConstant(java.lang.String constant)
Expression.setImmutableVariable(java.lang.String)
public void setImmutableVariable(java.lang.String constant)
@Deprecated
public java.lang.String[] getConstantOptions()
Expression.getImmutableVariableOptions()
public java.lang.String[] getImmutableVariableOptions()
@Deprecated
public int getConstantSelected()
Expression.getImmutableVariableSelected()
public int getImmutableVariableSelected()
public ChoosableProperty getOperatorProperty()
public java.lang.String getOperator()
public void setOperator(java.lang.String operator)
public java.lang.String[] getOperatorOptions()
public int getOperatorSelected()
public ChoosableProperty getMutableVariableProperty()
@Deprecated
public java.lang.String getVariable()
Expression.getMutableVariable()
public java.lang.String getMutableVariable()
@Deprecated
public void setVariable(java.lang.String variable)
Expression.setMutableVariable(java.lang.String)
public void setMutableVariable(java.lang.String variable)
@Deprecated
public java.lang.String[] getVariableOptions()
Expression.getMutableVariableOptions()
public java.lang.String[] getMutableVariableOptions()
@Deprecated
public int getVariableSelected()
Expression.getMutableVariableSelected()
public int getMutableVariableSelected()
public ChoosableProperty getFunctionProperty()
public java.lang.String getFunction()
public void setFunction(java.lang.String function)
public java.lang.String[] getFunctionOptions()
public int getFunctionSelected()
public ChoosableProperty getConstructorProperty()
public java.lang.String getConstructor()
public void setConstructor(java.lang.String constructor)
public java.lang.String[] getConstructorOptions()
public int getConstructorSelected()
public ExprParser.Token getResultToken()
public java.lang.String getParameterName()
public java.lang.String getParameterAlias()
public DOID getParameterID()
public java.lang.String[] getParameterTypes()
public DOID[] getParameterTypeIDs()
public boolean isParameterRequired()
public void setLiteralValue(java.lang.String literalValue)
setConstant(true); setValue(literalValue);
public boolean isCustomizable()
public void setCustomizable(boolean flag)
flag
- booleanpublic boolean getShowFunctions()
public void setShowFunctions(boolean showFunctions)
public boolean getShowConstants()
public void setShowConstants(boolean showConstants)
public boolean getShowVariables()
public void setShowVariables(boolean showVariables)
public boolean same(Expression expr)
expr
-public java.lang.String[] getAutoPatternPropertyOptions()
Expression.getValueOptions()
). If any of these auto pattern property options are selected, set it using Expression.setValue(java.lang.String)
This method should be used in addition to Expression.getValueOptions()
when this Expression is contained in a Rule or a RuleSheet that is not showing patterns.public java.util.List<DOID> getReferences()
DictionaryObject
getReferences
in class DictionaryComponent
public java.util.List<DOID> getAEReferences()
DictionaryObject
getAEReferences
in class DictionaryComponent
public java.util.List<DOID> getAllReferences()
DictionaryObject
getAllReferences
in class DictionaryComponent
public java.util.List<ModelComponent> getDependentModelComponents()
public int[][] balanced()
public int[] unbalanced()
public void setShowConstructorsWithFunctions(boolean b)
public java.lang.String append(java.lang.String str)
str
- the String to appendpublic java.lang.String insert(int offset, java.lang.String str)
0 <= offset <= getExpression.length()
offset
- where to insert the text, 0 basedstr
- the text to insertpublic java.lang.String replace(int start, int end, java.lang.String str)
0 <= start <= end <= getExpression.length()
start
- beginning index of substring to replace, 0 basedend
- ending index of substring to replace, 0 basedstr
- the text to insertpublic int getCursorPosition()
public void setCursorPosition(int cursorPosition)
public Token getTokenUnderCursor()
public java.lang.String evaluateConstant()
@Deprecated
public void setParameterRequired(boolean parameterRequired)
|
Oracle Fusion Middleware Java API Reference for Oracle Business Rules 11g Release 1 (11.1.1.6.2) E10663-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |