Package oracle.rules.sdk2.ruleset

Class Aggregate

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<Aggregate>

oracle.rules.sdk2.ruleset.Aggregate

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>, UnnamedComponent, ExpressionContext, ScopedVariable, VariableScope

public class Aggregate
extends UnnamedRuleComponent<Aggregate>
implements ScopedVariable, ExpressionContext

An Aggregate is an advanced expression that is obliged to be enclosed in a built-in or user-defined aggregate function.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class oracle.rules.sdk2.dictionary.DictionaryComponent

DictionaryComponent.Diff<T extends DictionaryComponent>, DictionaryComponent.DiffSummary, DictionaryComponent.DiffType

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface oracle.rules.sdk2.ruleset.VariableScope

VariableScope.ExprLocation

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AVG
static final String	COLLECTION
static final String	COUNT
static final String	MAX
static final String	MIN
static final String	SUM

Fields inherited from class oracle.rules.sdk2.ruleset.RuleComponent

BUILTIN

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

PROP_ACCESS, PROP_ACTION_SELECTED, PROP_ACTION_TABLE, PROP_ACTIVE, PROP_ACTUAL_TEST_OUTPUT_TABLE, PROP_ADHOC_TEST_VALIDATION, 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_AUTO_SYNC, 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_DATA_MODEL, PROP_DATA_SOURCE, PROP_DECISION_FUNCTION, PROP_DECISION_FUNCTION_ID, PROP_DECISION_FUNCTION_INPUT_TABLE, PROP_DECISION_FUNCTION_OUTPUT_TABLE, PROP_DECISION_FUNCTION_RULESET_TABLE, PROP_DECISION_FUNCTION_TABLE, PROP_DECISION_MODEL, PROP_DESCRIPTION, PROP_DF_FACT, PROP_DF_FACT_ID, PROP_DICT_LOADING_EXTENSION, PROP_DICTIONARY_LINK_TABLE, PROP_DIMENSION_NODE_TABLE, PROP_DIMENSION_TABLE, PROP_DISALLOW_ERROR_SUPPRESSION, PROP_DRAFT, PROP_DSL_ID, PROP_DSL_PARAMETER_TABLE, PROP_DSL_TABLE, PROP_DSL_VALUE, 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_EXPECTED_TEST_OUTPUT_TABLE, PROP_EXPRESSION, PROP_EXPRESSION_TABLE, PROP_FACT_PATH, PROP_FACT_PATH_IDS, PROP_FACT_TABLE, PROP_FACT_TYPE, PROP_FACT_TYPE_ID, PROP_FACT_TYPE_IDS, PROP_FACT_TYPE_TABLE, PROP_FACT_TYPES, 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_GLOBAL_ALIAS, PROP_ID, PROP_INCLUDE_CHAINED_EXPR, 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_LINK_PATH, 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_NO_RULE_FIRED_IS_ERROR, 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_PARAM, PROP_PARAM_EXPRESSION, 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_PHRASE_SUGGESTION_FORM, PROP_PREFERENCES, PROP_PREFIX_LINKED_NAMES, PROP_PRIORITY, PROP_PRIVATE_BUCKET_SET, PROP_PROPERTIES, PROP_PROPERTY, PROP_PROPERTY_ID, PROP_PROPERTY_TABLE, PROP_PROPERTY_VALUE_TABLE, PROP_QUALIFIER_PATTERN, PROP_READABLE, PROP_REF_ID, PROP_REPORT_BYUSE_NAMES, PROP_REPORT_PATTERNS, PROP_RESOLVED_TARGET, PROP_RESOLVED_VALUE, PROP_RESOURCE_BUNDLE, PROP_RESTRICT_AUTO_SUGGESTIONS, PROP_RETURN_TYPE, PROP_RIGHT, PROP_RIGHT_SEPARATOR, PROP_RULE_EXEC_ALGORITHM, 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_SYNC_MARK, PROP_SYSTEM, PROP_TARGET, PROP_TARGET_PACKAGE, PROP_TEST_CASE_TABLE, PROP_TEST_FORM, PROP_TEST_INPUT_TABLE, PROP_TEST_MODEL, PROP_TEST_RESULT_TABLE, PROP_TEST_SUITE_TABLE, PROP_TEST_TEMPLATE_TABLE, PROP_TIMESTAMP, PROP_TOKEN_UNDER_CURSOR, PROP_TRANSLATED_ALIAS, PROP_TRANSLATED_DESCRIPTION, PROP_TRANSLATED_GLOBAL_ALIAS, PROP_TRANSLATED_PARAMETER_LIST, PROP_TRANSLATED_QUALIFIER_PATTERN, PROP_TRANSLATED_VALUE, PROP_TRANSLATED_VARIABLE, PROP_TREE, PROP_TREE_MODE, PROP_TYPE, PROP_TYPE_ID, PROP_TYPE_IDS, PROP_TYPES, PROP_UNIQUE_RULESETS, PROP_UNSAVED_TRANSLATED_ALIAS, PROP_UNSAVED_TRANSLATED_DESCRIPTION, PROP_UNSAVED_TRANSLATED_GLOBAL_ALIAS, PROP_UNSAVED_TRANSLATED_QUALIFIER_PATTERN, PROP_UNSAVED_TRANSLATED_VALUE, PROP_UPDATE_NUMBER, PROP_UPDATE_TIME, PROP_VALIDATION, PROP_VALIDATION_UPDATE_NUMBER, PROP_VALUE, PROP_VALUES, PROP_VARIABLE, PROP_VARIABLE_TABLE, PROP_VERBAL_RULE_TABLE, PROP_VERSION, PROP_VERTICAL_ORIENTATION, PROP_VISIBILITY_FILTER, PROP_VISIBILITY_FILTER_ENABLED, PROP_VISIBLE, PROP_WEB_SERVICE, PROP_WRITABLE, PROP_XML_NAME

Method Summary

Modifier and Type	Method	Description
Object	get(Object key)	Generic property getter.
String	getAlias()	Get alias of DictionaryComponent.
String	getAlias(boolean translate)	Get alias of DictionaryComponent.
Expression	getExpression()	Get for checking syntax and creating option lists
DOID	getFactTypeID()
String	getFunction()
DOID	getFunctionID()
String[]	getFunctionOptions()
TranslatedProperty	getFunctionProperty()	Get Function Property.
int	getFunctionSelected()
Choice.Kind	getKind()
String	getMatchOp(Expression e)	A child calls this method in the parent to see if the data type is appropriate for the context of the parent.
DOID[]	getMatchTypeIDs(Expression e)	A child calls this method in the parent to see if the data type is appropriate for the context of the parent.
String[]	getPropertyNames()
String[]	getStoredPropertyNames()
String	getVariable()
Object	getVariableRL()	Get the RL for this ScopedVariable (not the same as _getRL)
List<ScopedVariable>	inScopeVariables(boolean includeAggregates, VariableScope.ExprLocation loc)	Return variables visible to the aggregate expression
boolean	isAssignable()
boolean	isValueRequired(Expression e)	A child calls this method in the parent to see if it must have a value !
Object	put(String key, Object value)	Generic property setter.
void	setFunction(String function)
void	setFunctionID(DOID functionID)
void	setVariable(String variable)
void	setVariableRL(int varNum)
void	setVariableRL(String name)
void	validate(List<SDKException> errors, List<SDKWarning> warnings)	Validate and append errors and warnings.

Methods inherited from class oracle.rules.sdk2.ruleset.UnnamedRuleComponent

getDiffMatchValue, init, isAliasDistinct, isNameDistinct

Methods inherited from class oracle.rules.sdk2.ruleset.RuleComponent

get, getParent, getParentTable, getParentVariableScope, inScopeVariables, parentAction, parentActionContext, parentAutoBindingContext, parentFunction, parentPattern, parentRule, parentRuleBase, parentRuleCommon, parentRuleSheet, parentTest, parentVariable, parentVerbalRule, RHSRuleVariables, toString, toString

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

_get, _put, clear, containsKey, containsValue, entrySet, forceSync, getAEReferences, getAlias, getAlias, getAliasProperty, getAllReferences, getContainedDiffs, getCustom, getDependents, getDescription, getDescription, getDescriptionProperty, getDiff, getDiffProperties, getDiffs, getExprParserReferences, getFullyQualifiedAlias, getFullyQualifiedName, getIndex, getIndex, getName, getNameProperty, getNext, getNext, getObjectPath, getOptions, getPrevious, getPrevious, getProperties, getProperty, getReferences, getSelected, getTranslatedAlias, getTranslatedAlias, getTranslatedDescription, hasConflict, hasDiff, init, isEmpty, isFullyQualifiedName, isModifiable, isSystemProperty, isUnsavedTranslatedAlias, isUnsavedTranslatedDescription, keySet, putAll, remove, removeDiff, setAlias, setAlias, setCustom, setDescription, setDescription, setName, setTranslatedAlias, setTranslatedDescription, size, validate, values

Methods inherited from class oracle.rules.sdk2.dictionary.DictionaryObject

_clearID, equals, exists, getAEReferenceCount, getCombinedDataModel, getContainedIDs, getContainedIDs, getDataModel, getDictionary, getID, getIndent, getObjectType, getParentByClass, getParentComponent, getParentComponentTable, getParentObject, getRuleSet, getState, getWarnings, hashCode, isModified, setID, validate, validate

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface oracle.rules.sdk2.ruleset.ScopedVariable

getID

Methods inherited from interface oracle.rules.sdk2.dictionary.UnnamedComponent

getName, setAlias, setName

Field Details

COUNT

public static final String COUNT

See Also:

• Constant Field Values

AVG

public static final String AVG

See Also:

• Constant Field Values

MIN

public static final String MIN

See Also:

• Constant Field Values

MAX

public static final String MAX

See Also:

• Constant Field Values

SUM

public static final String SUM

See Also:

• Constant Field Values

COLLECTION

public static final String COLLECTION

See Also:

• Constant Field Values

Method Details

getVariableRL

public Object getVariableRL()

Get the RL for this ScopedVariable (not the same as _getRL)

Specified by:

getVariableRL in interface ScopedVariable

Returns:

String or ExprParser

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<Aggregate>

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<Aggregate>

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<Aggregate>

Parameters:

errors - a List of error exceptions to append to.

warnings - a List of warning exceptions to append to.

See Also:

• DictionaryObject.validate(List,List,int,int)

getPropertyNames

public String[] getPropertyNames()

Specified by:

getPropertyNames in interface UnnamedComponent

Overrides:

getPropertyNames in class UnnamedRuleComponent<Aggregate>

Returns:

Array of property names available.

getStoredPropertyNames

public String[] getStoredPropertyNames()

Overrides:

getStoredPropertyNames in class UnnamedRuleComponent<Aggregate>

Returns:

Array of property names which are persisted in the order in which they appear in the schema.

getFactTypeID

public DOID getFactTypeID()

Specified by:

getFactTypeID in interface ScopedVariable

getMatchOp

public String getMatchOp(Expression e)

Description copied from interface: ExpressionContext

A child calls this method in the parent to see if the data type is appropriate for the context of the parent. Example, in the expression x == y, the Expression y asks its parent the type of x and the operator used between the two

Specified by:

getMatchOp in interface ExpressionContext

getMatchTypeIDs

public DOID[] getMatchTypeIDs(Expression e)

Description copied from interface: ExpressionContext

A child calls this method in the parent to see if the data type is appropriate for the context of the parent. Example, in the expression x == y, the Expression y asks its parent the type of x and the operator used between the two

Specified by:

getMatchTypeIDs in interface ExpressionContext

isValueRequired

public boolean isValueRequired(Expression e)

Description copied from interface: ExpressionContext

A child calls this method in the parent to see if it must have a value != ""

Specified by:

isValueRequired in interface ExpressionContext

getExpression

public Expression getExpression()

Get for checking syntax and creating option lists

getFunctionProperty

public TranslatedProperty getFunctionProperty()

Get Function Property.

Returns:

TranslatedProperty

getFunction

public String getFunction()

setFunction

public void setFunction(String function)

getFunctionID

public DOID getFunctionID()

setFunctionID

public void setFunctionID(DOID functionID)

getFunctionOptions

public String[] getFunctionOptions()

getFunctionSelected

public int getFunctionSelected()

getVariable

public String getVariable()

setVariable

public void setVariable(String variable)

getAlias

public String getAlias()

Description copied from class: DictionaryComponent

Get alias of DictionaryComponent. Alias is set to its name by default.

Specified by:

getAlias in interface UnnamedComponent

Overrides:

getAlias in class DictionaryComponent<Aggregate>

Returns:

alias of the dictionary component

getAlias

public String getAlias(boolean translate)

Description copied from class: DictionaryComponent

Get alias of DictionaryComponent.

Specified by:

getAlias in interface ScopedVariable

Overrides:

getAlias in class DictionaryComponent<Aggregate>

Parameters:

translate - whether to get the translated alias

Returns:

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

inScopeVariables

public List<ScopedVariable> inScopeVariables(boolean includeAggregates,
 VariableScope.ExprLocation loc)

Return variables visible to the aggregate expression

Specified by:

inScopeVariables in interface VariableScope

Overrides:

inScopeVariables in class RuleComponent<Aggregate>

Parameters:

includeAggregates - should aggregate variables be included in result?

loc - VariableScope.ExprLocation

Returns:

list of in scope variables

setVariableRL

public void setVariableRL(String name)

Specified by:

setVariableRL in interface ScopedVariable

setVariableRL

public void setVariableRL(int varNum)

Specified by:

setVariableRL in interface ScopedVariable

isAssignable

public boolean isAssignable()

Specified by:

isAssignable in interface ScopedVariable

getKind

public Choice.Kind getKind()

Specified by:

getKind in interface ScopedVariable