oracle.rules.sdk2.ruleset
Class Expression

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>, UnnamedComponent

Direct Known Subclasses:

Dimension

public class Expression
extends UnnamedRuleComponent

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:

Serialized Form

Nested Class Summary

class

Expression.ExpressionValueProperty

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

Fields inherited from class oracle.rules.sdk2.dictionary.DictionaryComponent

PROP_ACCESS, PROP_ACTION_SELECTED, PROP_ACTION_TABLE, PROP_ACTIVE, PROP_ADVANCED_MODE, PROP_AGGREGATE, PROP_AGGREGATE_TABLE, PROP_ALIAS, PROP_ALLOW_GAPS, PROP_ALWAYS_SELECTED, PROP_ARRAY, PROP_ARRAY_COMPONENT_TYPE, PROP_ARRAY_COMPONENT_TYPE_ID, PROP_ARRAY_FACT_TYPE_TABLE, PROP_AUTO_CONFLICT_RESOLUTION, PROP_AUTO_PATTERN_PROPERTY, PROP_BODY, PROP_BUCKET_ID_TABLE, PROP_BUCKET_SET, PROP_BUCKET_SET_ID, PROP_BUCKET_SET_TABLE, PROP_BUCKET_TABLE, PROP_CALENDAR_FORM, PROP_CHECK_RULE_FLOW, PROP_CHILD_DIMENSION_NODES, PROP_CONFLICT, PROP_CONFLICT_POLICY, PROP_CONNECTIVE, PROP_CONSTANT, PROP_CONSTRUCTOR, PROP_CONSTRUCTOR_TABLE, PROP_CREATION_UPDATE_NUMBER, PROP_CURSOR_POSITION, PROP_CUSTOM_BINDING, PROP_CUSTOMIZABLE, PROP_CUSTOMIZABLE_TEMPLATE, PROP_DATA_MODEL, PROP_DATA_SOURCE, PROP_DECISION_FUNCTION, PROP_DECISION_FUNCTION_INPUT_TABLE, PROP_DECISION_FUNCTION_OUTPUT_TABLE, PROP_DECISION_FUNCTION_RULESET_TABLE, PROP_DECISION_FUNCTION_TABLE, PROP_DESCRIPTION, PROP_DICTIONARY_LINK_TABLE, PROP_DIMENSION_NODE_TABLE, PROP_DIMENSION_TABLE, PROP_DT_ACTION_NODE_TABLE, PROP_DT_ACTION_PARAMETER_NAME, PROP_DTACTION_TABLE, PROP_DTRULE_TABLE, PROP_EFFECTIVE_END_DATE, PROP_EFFECTIVE_START_DATE, PROP_ENUM, PROP_ENUM_BUCKET_SET, PROP_ENUM_BUCKET_SET_ID, PROP_ENUM_TYPE, PROP_EXCEPTION_IDS, PROP_EXCEPTIONS, PROP_EXCLUDED, PROP_EXPRESSION, PROP_EXPRESSION_TABLE, PROP_FACT_PATH, PROP_FACT_PATH_IDS, PROP_FACT_TYPE, PROP_FACT_TYPE_ID, PROP_FACT_TYPE_TABLE, PROP_FIELD_TABLE, PROP_FINAL, PROP_FORM, PROP_FORMAL_PARAMETER_TABLE, PROP_FUNCTION, PROP_FUNCTION_ID, PROP_FUNCTION_SIGNATURE, PROP_FUNCTION_TABLE, PROP_GENERATED_FROM, PROP_ID, PROP_INCLUDED, PROP_INTERFACE, PROP_INTERFACE_IDS, PROP_INTERFACES, PROP_IS_ABSTRACT, PROP_IS_CONSTANT, PROP_IS_ENUM, PROP_IS_FINAL, PROP_IS_JAXB2, PROP_IS_PRIMARY_KEY, PROP_IS_STATIC, PROP_IS_TOPLEVEL_VIEW_OBJECT, PROP_LEFT, PROP_LIFECYCLE, PROP_LIFECYCLE_DESCRIPTION, PROP_LIST, PROP_LIST_CONTENT_TYPE, PROP_LIST_CONTENT_TYPE_ID, PROP_LOCAL, PROP_LOGICAL, PROP_METHOD_TABLE, PROP_MODIFIERS, PROP_NAME, PROP_NAMESPACE, PROP_NESTED_TABLE, PROP_NO_CONFLICT, PROP_NODE_NAME, PROP_OPERATOR, PROP_OPERATOR_ID, PROP_ORDER_RULES_BY_BUCKET, PROP_OTHERWISE, PROP_OUTPUT_TYPES, PROP_OVERLOADED_PARAMETER_TABLE, PROP_OVERRIDDEN_BY, PROP_OVERRIDE, PROP_PACKAGE, PROP_PARAMETER_ALIAS, PROP_PARAMETER_ID, PROP_PARAMETER_LIST, PROP_PARAMETER_NAME, PROP_PARAMETER_REQUIRED, PROP_PARAMETER_TYPE_IDS, PROP_PARAMETER_TYPES, PROP_PARENT_DIMENSION_NODE, PROP_PATTERN_TABLE, PROP_PREFIX_LINKED_NAMES, PROP_PRIORITY, PROP_PRIVATE_BUCKET_SET, PROP_PROPERTIES, PROP_PROPERTY_TABLE, PROP_READABLE, PROP_REF_ID, PROP_REPORT_BYUSE_NAMES, PROP_REPORT_PATTERNS, PROP_RESOLVED_TARGET, PROP_RESOLVED_VALUE, PROP_RESOURCE_BUNDLE, PROP_RETURN_TYPE, PROP_RIGHT, PROP_RIGHT_SEPARATOR, PROP_RULE_FIRING_LIMIT, PROP_RULE_FIRING_LIMIT_ERROR, PROP_RULE_REPORT_TABLE, PROP_RULE_SET_TABLE, PROP_RULE_SHEET_TABLE, PROP_RULE_TABLE, PROP_RULESET, PROP_RUN_AFTER, PROP_RUN_BEFORE, PROP_SERVICE_CONFIGURATION, PROP_SERVICE_NAME, PROP_SERVICE_NAMESPACE, PROP_SHARED_BUCKET_SET, PROP_SHARED_BUCKET_SET_ID, PROP_SHOW_CONSTANTS, PROP_SHOW_FUNCTIONS, PROP_SHOW_VARIABLES, PROP_SIMPLE_TEST_TABLE, PROP_SOURCE, PROP_STATELESS, PROP_STATIC, PROP_SUPER_CLASS, PROP_SUPER_CLASS_ID, PROP_SUPPORT_XPATH, PROP_SUPPORTS_XPATH_ENABLED, PROP_SYSTEM, PROP_TARGET, PROP_TARGET_PACKAGE, PROP_TEST_FORM, PROP_TIMESTAMP, PROP_TOKEN_UNDER_CURSOR, PROP_TRANSLATED_ALIAS, PROP_TRANSLATED_DESCRIPTION, PROP_TRANSLATED_PARAMETER_LIST, PROP_TRANSLATED_VARIABLE, PROP_TREE, PROP_TREE_MODE, PROP_TYPE, PROP_TYPE_ID, PROP_TYPE_IDS, PROP_TYPES, PROP_UNSAVED_TRANSLATED_ALIAS, PROP_UNSAVED_TRANSLATED_DESCRIPTION, PROP_UPDATE_NUMBER, PROP_UPDATE_TIME, PROP_VALIDATION_UPDATE_NUMBER, PROP_VALUE, PROP_VALUES, PROP_VARIABLE, PROP_VARIABLE_TABLE, PROP_VERSION, PROP_VISIBILITY_FILTER, PROP_VISIBILITY_FILTER_ENABLED, PROP_VISIBLE, PROP_WEB_SERVICE, PROP_WRITABLE, PROP_XML_NAME

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 the DOIDs referenced by all directly or indirectly contained actions and expressions
java.util.List<DOID>	getAllReferences() Get the DOIDs referenced by this component or contained components
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() Get parameter alias
java.lang.String	getParameterAlias(boolean translate) Get possibly translated parameter alias
DOID	getParameterID()
java.lang.String	getParameterName()
DOID[]	getParameterTypeIDs() Get possibly overloaded parameter types
java.lang.String[]	getParameterTypes() Get possibly overloaded parameter types
java.lang.String[]	getParameterTypes(boolean translate) Get possibly translated and overloaded parameter types
java.util.List<DOID>	getReferences() Get the DOIDs referenced by this component (but not the contained 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	getValue(boolean translate) get optionally translated value short for getValueProperty().getValue(translate)
java.lang.String[]	getValueOptions() get some options for an expression value appropriate in this context
Expression.ExpressionValueProperty	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, getAlias, getAlias, getAliasProperty, getCustom, getDependents, getDescription, getDescription, getDescriptionProperty, getDiff, getDiffProperties, getDiffs, getFullyQualifiedAlias, getFullyQualifiedName, getIndex, getIndex, getName, getNameProperty, getNext, getObjectPath, getOptions, getPrevious, getProperties, getProperty, getSelected, getTranslatedAlias, getTranslatedAlias, getTranslatedDescription, hasDiff, init, isEmpty, isFullyQualifiedName, isSystemProperty, isUnsavedTranslatedAlias, isUnsavedTranslatedDescription, keySet, put, putAll, remove, setAlias, setAlias, setCustom, setDescription, setDescription, setName, setTranslatedAlias, setTranslatedDescription, 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, hashCode, 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

getValueProperty

public Expression.ExpressionValueProperty getValueProperty()

Get Value Property.

Returns:

ChoosableProperty

getValue

public java.lang.String getValue()

returns the String value of the Expression

setValue

public void setValue(java.lang.String value)

getValueOptions

public java.lang.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<java.lang.Boolean> getConstantProperty()

Get Constant Property.

Returns:

Boolean SettableProperty

isConstant

public boolean isConstant()

setConstant

public void setConstant(boolean flag)

getDTActionParameterNameProperty

public SettableProperty<java.lang.String> getDTActionParameterNameProperty()

Get DTActionParameterName Property.

Returns:

String SettableProperty

getDTActionParameterName

public 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.

Returns:

String name, or "" if this is not a DTAction parameter.

See Also:

DTAction, DTActionNode

setDTActionParameterName

public void setDTActionParameterName(java.lang.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 java.lang.String getConstant()

Deprecated. use Expression.getImmutableVariable()

getImmutableVariable

public java.lang.String getImmutableVariable()

setConstant

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

Deprecated. use Expression.setImmutableVariable(java.lang.String)

setImmutableVariable

public void setImmutableVariable(java.lang.String constant)

getConstantOptions

@Deprecated
public java.lang.String[] getConstantOptions()

Deprecated. use Expression.getImmutableVariableOptions()

getImmutableVariableOptions

public java.lang.String[] getImmutableVariableOptions()

Get immutable variables (e.g. final variables, pattern variables)

Returns:

array of terms

getConstantSelected

@Deprecated
public int getConstantSelected()

Deprecated. use Expression.getImmutableVariableSelected()

getImmutableVariableSelected

public int getImmutableVariableSelected()

getOperatorProperty

public ChoosableProperty getOperatorProperty()

Get Operator Property.

Returns:

ChoosableProperty

getOperator

public java.lang.String getOperator()

setOperator

public void setOperator(java.lang.String operator)

getOperatorOptions

public java.lang.String[] getOperatorOptions()

getOperatorSelected

public int getOperatorSelected()

getMutableVariableProperty

public ChoosableProperty getMutableVariableProperty()

Get MutableVariable Property.

Returns:

ChoosableProperty

getVariable

@Deprecated
public java.lang.String getVariable()

Deprecated. Use Expression.getMutableVariable()

getMutableVariable

public java.lang.String getMutableVariable()

setVariable

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

Deprecated. Use Expression.setMutableVariable(java.lang.String)

setMutableVariable

public void setMutableVariable(java.lang.String variable)

getVariableOptions

@Deprecated
public java.lang.String[] getVariableOptions()

Deprecated. Use Expression.getMutableVariableOptions()

getMutableVariableOptions

public java.lang.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 Expression.getMutableVariableSelected()

getMutableVariableSelected

public int getMutableVariableSelected()

getFunctionProperty

public ChoosableProperty getFunctionProperty()

Get Function Property.

Returns:

ChoosableProperty

getFunction

public java.lang.String getFunction()

setFunction

public void setFunction(java.lang.String function)

getFunctionOptions

public java.lang.String[] getFunctionOptions()

getFunctionSelected

public int getFunctionSelected()

getConstructorProperty

public ChoosableProperty getConstructorProperty()

Get Constructor Property.

Returns:

ChoosableProperty

getConstructor

public java.lang.String getConstructor()

setConstructor

public void setConstructor(java.lang.String constructor)

getConstructorOptions

public java.lang.String[] getConstructorOptions()

getConstructorSelected

public int getConstructorSelected()

getResultToken

public ExprParser.Token getResultToken()

getParameterName

public java.lang.String getParameterName()

getParameterAlias

public java.lang.String getParameterAlias()

Get parameter alias

Returns:

parameter alias

getParameterAlias

public java.lang.String getParameterAlias(boolean translate)

Get possibly translated parameter alias

Parameters:

translate -

Returns:

parameter alias

getParameterID

public DOID getParameterID()

getParameterTypes

public java.lang.String[] getParameterTypes()

Get possibly overloaded parameter types

Returns:

String[] of type aliases

getParameterTypes

public java.lang.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(java.lang.String literalValue)

Shorthand for setConstant(true); setValue(literalValue);

isCustomizable

public boolean isCustomizable()

is this expression customizable?

Returns:

boolean

setCustomizable

public void setCustomizable(boolean flag)

set whether this expression is customizable

Parameters:

flag - boolean

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

getAutoPatternPropertyOptions

public java.lang.String[] getAutoPatternPropertyOptions()

get the list of auto pattern properties. These are properties of the fact types in the data model. It does not include in-scope variables (use 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.

Returns:

array of String

getReferences

public java.util.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

Returns:

list of the DOIDS

getAEReferences

public java.util.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

Returns:

list of the DOIDS

getAllReferences

public java.util.List<DOID> getAllReferences()

Description copied from class: DictionaryComponent

Get the DOIDs referenced by this component or contained components

Overrides:

getAllReferences in class DictionaryComponent

Returns:

list of the DOIDS

getDependentModelComponents

public java.util.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 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". No exceptions are thrown.

Parameters:

str - the String to append

Returns:

the new String (also available by calling getValue()

insert

public java.lang.String insert(int offset,
                               java.lang.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 java.lang.String replace(int start,
                                int end,
                                java.lang.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 java.lang.String evaluateConstant()

if the expression can be evaluated at design time, returns its literal value. Else return null

Returns:

String literal value or null

setParameterRequired

@Deprecated
public void setParameterRequired(boolean parameterRequired)

Deprecated. No replacement. A no-op.

getValue

public java.lang.String getValue(boolean translate)

get optionally translated value short for getValueProperty().getValue(translate)

Parameters:

translate -

Returns:

optionally translated value