oracle.rules.sdk2.ruleset
Class Pattern

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

All Implemented Interfaces:

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

public class Pattern
extends UnnamedRuleComponent

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:

Serialized Form

Nested Class Summary

class	Pattern.FactPathProperty
class	Pattern.VariableProperty

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

static java.lang.String	CONNECTIVE_AND
static java.lang.String	CONNECTIVE_OR
static java.lang.String	FORM_FACT_PATH
static java.lang.String	FORM_FACT_TYPE Use with Pattern Form.
static java.lang.String	FORM_NESTED_TABLE
static java.lang.String	OPERATOR_AGGREGATE
static java.lang.String	OPERATOR_FOREACH Use with Pattern Operator.
static java.lang.String	OPERATOR_NONE
static java.lang.String	OPERATOR_SOME
static java.lang.String	TEST_FORM_ADVANCED TEST_FORM_ADVANCED Specifies the use of boolean Expression located in Expression property.
static java.lang.String	TEST_FORM_NOTEST Specifies test form.
static java.lang.String	TEST_FORM_SIMPLE TEST_FORM_SIMPLE Specifies the use of SimpleTest, located in SimpleTestTable.

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

void	desurround()
AggregateTable	getAggregateTable() Get the the Aggregate subtable when Operator is OPERATOR_AGGREGATE.
TableProperty<Aggregate>	getAggregteTableProperty() Get AggregateTable Property.
java.lang.String	getAlias() Even though we extend UnnamedComponent, we need the variable name to translate expressions from persistent format (`ID`) to user format (name)
java.lang.String	getAlias(boolean translate) Get alias of DictionaryComponent.
java.lang.String	getConnective() Get connective (and/or) which combines this Pattern with the following Pattern, if any.
java.lang.String[]	getConnectiveOptions()
TranslatedProperty	getConnectiveProperty() Get Connective Property.
int	getConnectiveSelected()
Expression	getExpression()
DictionaryProperty<Expression>	getExpressionProperty() Get Expression Property.
java.lang.String	getFactPath() Get the fact path.
DOID[]	getFactPathIDs() Get the IDs of the fact path.
java.lang.String[]	getFactPathOptions() get possible fact paths to choose from
Pattern.FactPathProperty	getFactPathProperty() Get FactPath Property.
java.lang.String	getFactType() Get the alias of the fact type.
DOID	getFactTypeID() Get the ID of the fact type.
java.lang.String[]	getFactTypeOptions() get possible fact types to choose from
AliasRefProperty	getFactTypeProperty() Get FactType Property.
int	getFactTypeSelected() get index of fact type selected from option list
java.lang.String	getForm() Get Form describing whether this Pattern simple fact type or a subtable of fact types.
java.lang.String[]	getFormOptions()
TranslatedProperty	getFormProperty() Get Form Property.
int	getFormSelected()
PatternTable	getNestedTable() Get the the Pattern subtable when Form is FORM_NESTED_TABLE.
TableProperty<Pattern>	getNestedTableProperty() Get NestedTable Property.
java.lang.String	getOperator() Get Pattern operator.
java.lang.String[]	getOperatorOptions()
TranslatedProperty	getOperatorProperty() Get Operator Property.
int	getOperatorSelected()
Expression	getSimpleTestLeft(int i) Shorthand for getSimpleTestTable.getSimpleTest(i).getLeft()
java.lang.String	getSimpleTestOperator(int i) Shorthand for getSimpleTestTable.getSimpleTest(i).getOperator()
Expression	getSimpleTestRight(int i) Shorthand for getSimpleTestTable.getSimpleTest(i).getRight()
SimpleTestTable	getSimpleTestTable() Get the table of tests for this Pattern.
TableProperty<SimpleTest>	getSimpleTestTableProperty() Get SimpleTestTable Property.
static java.lang.String[]	getSurroundingFormOptions(java.util.List<Pattern> patterns)
java.lang.String	getTestForm() get type of test associated with the Pattern.
java.lang.String[]	getTestFormOptions()
TranslatedProperty	getTestFormProperty() Get TestForm Property.
int	getTestFormSelected()
java.lang.String	getVariable()
java.lang.String	getVariable(boolean translate)
Pattern.VariableProperty	getVariableProperty() Get Variable Property.
boolean	hasFactType() Does the pattern have a fact type?
boolean	isVisible()
void	setConnective(java.lang.String connective) Set connective (and/or) which combines this Pattern with the following Pattern, if any.
void	setFactPath(java.lang.String factPath) Set the fact path.
void	setFactPathIDs(DOID[] factPathIDs) Set the IDs of the fact path.
void	setFactType(java.lang.String factType) Set the alias of the fact type.
void	setFactTypeID(DOID factTypeID) Set the ID of the fact type.
void	setForm(java.lang.String form) Set Form to Pattern.FORM_FACT_TYPE, Pattern.FORM_FACT_PATH, or Pattern.FORM_NESTED_TABLE.
void	setOperator(java.lang.String operator) Set Pattern operator.
void	setTestForm(java.lang.String testForm) set type of test associated with the Pattern.
void	setVariable(java.lang.String variable)
Pattern	surround()
static Pattern	surround(java.util.List<Pattern> patterns)
Pattern	surround(java.lang.String form)
static Pattern	surround(java.lang.String form, java.util.List<Pattern> patterns)

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, getAllReferences, getCustom, getDependents, getDescription, getDescription, getDescriptionProperty, getDiff, getDiffProperties, getDiffs, getFullyQualifiedAlias, getFullyQualifiedName, getIndex, getIndex, getName, getNameProperty, getNext, getObjectPath, getOptions, getPrevious, getProperties, getProperty, getReferences, 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, getAEReferences, 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

getName, getPropertyNames, setAlias, setName

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

FORM_FACT_TYPE

public static final java.lang.String FORM_FACT_TYPE

Use with Pattern Form. Default is FORM_FACT_TYPE. FORM_NESTED_TABLE is used for a pattern block.

See Also:

Constant Field Values

FORM_NESTED_TABLE

public static final java.lang.String FORM_NESTED_TABLE

See Also:

Constant Field Values

FORM_FACT_PATH

public static final java.lang.String FORM_FACT_PATH

See Also:

Constant Field Values

OPERATOR_FOREACH

public static final java.lang.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:

Constant Field Values

OPERATOR_SOME

public static final java.lang.String OPERATOR_SOME

See Also:

Constant Field Values

OPERATOR_NONE

public static final java.lang.String OPERATOR_NONE

See Also:

Constant Field Values

OPERATOR_AGGREGATE

public static final java.lang.String OPERATOR_AGGREGATE

See Also:

Constant Field Values

CONNECTIVE_AND

public static final java.lang.String CONNECTIVE_AND

See Also:

Constant Field Values

CONNECTIVE_OR

public static final java.lang.String CONNECTIVE_OR

See Also:

Constant Field Values

TEST_FORM_NOTEST

public static final java.lang.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:

Constant Field Values

TEST_FORM_SIMPLE

public static final java.lang.String TEST_FORM_SIMPLE

TEST_FORM_SIMPLE Specifies the use of SimpleTest, located in SimpleTestTable.

See Also:

Constant Field Values

TEST_FORM_ADVANCED

public static final java.lang.String TEST_FORM_ADVANCED

TEST_FORM_ADVANCED Specifies the use of boolean Expression located in Expression property.

See Also:

Constant Field Values

Method Detail

desurround

public void desurround()

surround

public static Pattern surround(java.util.List<Pattern> patterns)

surround

public static Pattern surround(java.lang.String form,
                               java.util.List<Pattern> patterns)

surround

public Pattern surround()

surround

public Pattern surround(java.lang.String form)

getSurroundingFormOptions

public static java.lang.String[] getSurroundingFormOptions(java.util.List<Pattern> patterns)

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:

java.lang.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:

java.lang.IndexOutOfBoundsException

getSimpleTestOperator

public java.lang.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:

java.lang.IndexOutOfBoundsException

getFormProperty

public TranslatedProperty getFormProperty()

Get Form Property.

Returns:

TranslatedProperty

getForm

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

Set Form to Pattern.FORM_FACT_TYPE, Pattern.FORM_FACT_PATH, or Pattern.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 Pattern.getNestedTable().

getFormOptions

public java.lang.String[] getFormOptions()

getFormSelected

public int getFormSelected()

getFactTypeProperty

public AliasRefProperty getFactTypeProperty()

Get FactType Property.

Returns:

ChoosableProperty

getFactType

public java.lang.String getFactType()

Get the alias of the fact type. For use when Form is FORM_FACT_TYPE or FORM_FACT_PATH

setFactType

public void setFactType(java.lang.String factType)

Set the alias of the fact type. For use when Form is FORM_FACT_TYPE

getFactTypeID

public DOID getFactTypeID()

Get the ID of the fact type. For use when Form is FORM_FACT_TYPE

setFactTypeID

public void setFactTypeID(DOID factTypeID)

Set the ID of the fact type. For use when Form is FORM_FACT_TYPE or FORM_FACT_PATH

getFactTypeOptions

public java.lang.String[] getFactTypeOptions()

get possible fact types to choose from

Returns:

String[] of fact type aliases

getFactTypeSelected

public int getFactTypeSelected()

get index of fact type selected from option list

Returns:

index

getFactPathProperty

public Pattern.FactPathProperty getFactPathProperty()

Get FactPath Property.

Returns:

ChoosableProperty

getFactPath

public java.lang.String getFactPath()

Get the fact path. For use when Form is FORM_FACT_TYPE or FORM_FACT_PATH

setFactPath

public void setFactPath(java.lang.String factPath)

Set the fact path. For use when Form is FORM_FACT_PATH

getFactPathIDs

public DOID[] getFactPathIDs()

Get the IDs of the fact path. For use when Form is FORM_FACT_TYPE or FORM_FACT_PATH

setFactPathIDs

public void setFactPathIDs(DOID[] factPathIDs)

Set the IDs of the fact path. For use when Form is FORM_FACT_PATH

getFactPathOptions

public java.lang.String[] getFactPathOptions()

get possible fact paths to choose from

Returns:

String[] of fact paths

getTestFormProperty

public TranslatedProperty getTestFormProperty()

Get TestForm Property.

Returns:

TranslatedProperty

getTestForm

public java.lang.String getTestForm()

get type of test associated with the Pattern. see Pattern description or TEST_FORM see TEST_FORM_ above

setTestForm

public void setTestForm(java.lang.String testForm)

set type of test associated with the Pattern. see Pattern description or TEST_FORM see TEST_FORM_ above

getTestFormOptions

public java.lang.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 Pattern.hasFactType(). See SimpleTest

getExpressionProperty

public DictionaryProperty<Expression> getExpressionProperty()

Get Expression Property.

Returns:

Expression DictionaryProperty

getExpression

public Expression getExpression()

getVariableProperty

public Pattern.VariableProperty getVariableProperty()

Get Variable Property.

Returns:

String SettableProperty

getVariable

public java.lang.String getVariable()

getVariable

public java.lang.String getVariable(boolean translate)

setVariable

public void setVariable(java.lang.String variable)

getOperatorProperty

public TranslatedProperty getOperatorProperty()

Get Operator Property.

Returns:

String SettableProperty

getOperator

public java.lang.String getOperator()

Get Pattern operator. See Pattern.OPERATOR_FOREACH. Defaults to OPERATOR_FOREACH

setOperator

public void setOperator(java.lang.String operator)

Set Pattern operator. See Pattern.OPERATOR_FOREACH. Defaults to OPERATOR_FOREACH

getOperatorOptions

public java.lang.String[] getOperatorOptions()

getOperatorSelected

public int getOperatorSelected()

getConnectiveProperty

public TranslatedProperty getConnectiveProperty()

Get Connective Property.

Returns:

String SettableProperty

getConnective

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

Returns:

the name of the pattern bind variable

getAlias

public java.lang.String getAlias(boolean translate)

Description copied from class: DictionaryComponent

Get alias of DictionaryComponent.

Overrides:

getAlias in class DictionaryComponent

Parameters:

translate - whether to get the translated alias

Returns:

translated alias of the dictionary component, or alias if translation does not exist

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

Returns:

boolean