com.arhscube.evenge

Class AggregatorContext

java.lang.Object

com.arhscube.evenge.AggregatorContext

All Implemented Interfaces:

org.apache.commons.jexl3.JexlContext, org.apache.commons.jexl3.JexlContext.NamespaceResolver

public class AggregatorContext
extends Object
implements org.apache.commons.jexl3.JexlContext.NamespaceResolver, org.apache.commons.jexl3.JexlContext

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AggregatorContext.AggregatorJEXLBuilder

Nested classes/interfaces inherited from interface org.apache.commons.jexl3.JexlContext

org.apache.commons.jexl3.JexlContext.AnnotationProcessor, org.apache.commons.jexl3.JexlContext.NamespaceFunctor, org.apache.commons.jexl3.JexlContext.NamespaceResolver, org.apache.commons.jexl3.JexlContext.ThreadLocal

Constructor Summary

Constructors

Constructor and Description
AggregatorContext() Constructor :-)
AggregatorContext(boolean debug)

Method Summary

Modifier and Type	Method and Description
void	addVariable(String variable, Object object)
protected Object	aggregate(String aggregator, String name, boolean canSplit, AggregatorContext.AggregatorJEXLBuilder expressionBuilder, Object orElse)
Set<String>	aggregators() all aggregators in this context
Object[]	asArray(String aggregator) return aggregated values As Array
Set<Object>	asSet(String aggregator) return aggregated values as Set
Object	avg(String aggregator) does sum/count for an aggregator, result is floating point (usually double)
void	cleanContext(String prefix) removes all elements from context starting
protected void	collect(String aggregator, String objectReference) Used by processor to collect object references
Boolean	contains(String aggregator, Object object) if Object was aggregated return true.
Integer	count(String aggregator) Count how many objects have been collected in an aggregator
void	endContext(String value) stops trace of context
void	endProcess()
Object	evaluate(String expression) Evaluate the expression against the context, additionally to the JEXL syntax you can use - sum - avg - count - join see methods with same name in this class for more information
Object	execute(String field, String formula)
Object	get(String s)
String	getLastProcessTrace()
String	getPackageStart()
boolean	has(String s)
boolean	isDebug()
Object	join(String separator, String aggregator) Joins all objects that have been collected in an aggregator into a string separated by separator
void	register(String namespace, Object o) Register an object (or a class) to a namespace.
Object	resolveNamespace(String s)
void	set(String s, Object o)
void	setPackageStart(String packageStart)
int	size()
void	startContext(String contextName) Trace context start
void	startProcess()
Object	sum(String aggregator) Sum all objects collected in an aggregator (may be problematic if JEXL cannot sum those objects with "+" operand)
Object	sum(String aggregator, Object orElse) Sum all objects collected in an aggregator (may be problematic if JEXL cannot sum those objects with "+" operand)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AggregatorContext

public AggregatorContext()

Constructor :-)

AggregatorContext

public AggregatorContext(boolean debug)

Method Detail

register

public void register(String namespace,
                     Object o)

Register an object (or a class) to a namespace. Future call to the evaluator function will benefit from all public methods as functions in that namespace

Parameters:

namespace - the string to prefix the functions

o - the object or class containing functions to register

execute

public Object execute(String field,
                      String formula)

evaluate

public Object evaluate(String expression)

Evaluate the expression against the context, additionally to the JEXL syntax you can use - sum - avg - count - join see methods with same name in this class for more information

Parameters:

expression - expression to evaluate

Returns:

evaluated expression

join

public Object join(String separator,
                   String aggregator)

Joins all objects that have been collected in an aggregator into a string separated by separator

Parameters:

separator - the String to use as separator

aggregator - the aggregator to join

Returns:

a String with all aggregator's element joined by sperator or else an empty string if aggregator not found

count

public Integer count(String aggregator)

Count how many objects have been collected in an aggregator

Parameters:

aggregator - the aggregator to count elements for

Returns:

the number of elements in aggregator or else 0

contains

public Boolean contains(String aggregator,
                        Object object)

if Object was aggregated return true.

Parameters:

aggregator - the aggregator to evaluate

object - the object to search reference for

Returns:

true if object exists in aggregator or else false

sum

public Object sum(String aggregator,
                  Object orElse)

Sum all objects collected in an aggregator (may be problematic if JEXL cannot sum those objects with "+" operand)

Parameters:

aggregator - the aggregator to evaluate

orElse - the default value to return in case not found or no elements in aggregator

Returns:

the total of all elements in element's type if not found or no elements

sum

public Object sum(String aggregator)

Sum all objects collected in an aggregator (may be problematic if JEXL cannot sum those objects with "+" operand)

Parameters:

aggregator - the aggregator

Returns:

the sum or null if not found or empty

avg

public Object avg(String aggregator)

does sum/count for an aggregator, result is floating point (usually double)

Parameters:

aggregator - the aggregator

Returns:

the average or 0.0d if not found or empty

asArray

public Object[] asArray(String aggregator)

return aggregated values As Array

Parameters:

aggregator - the aggregator

Returns:

an array (may be empty)

asSet

public Set<Object> asSet(String aggregator)

return aggregated values as Set

Parameters:

aggregator - the aggregator

Returns:

the distinct set of elements (may be empty)

aggregators

public Set<String> aggregators()

all aggregators in this context

Returns:

a list of aggregator names

aggregate

protected Object aggregate(String aggregator,
                           String name,
                           boolean canSplit,
                           AggregatorContext.AggregatorJEXLBuilder expressionBuilder,
                           Object orElse)

collect

protected void collect(String aggregator,
                       String objectReference)

Used by processor to collect object references

Parameters:

aggregator - aggregator's name to collect

objectReference - the reference to the element to collect

resolveNamespace

public Object resolveNamespace(String s)

Specified by:

resolveNamespace in interface org.apache.commons.jexl3.JexlContext.NamespaceResolver

get

public Object get(String s)

Specified by:

get in interface org.apache.commons.jexl3.JexlContext

set

public void set(String s,
                Object o)

Specified by:

set in interface org.apache.commons.jexl3.JexlContext

has

public boolean has(String s)

Specified by:

has in interface org.apache.commons.jexl3.JexlContext

cleanContext

public void cleanContext(String prefix)

removes all elements from context starting

Parameters:

prefix - the prefix of all aggregators to clean

startContext

public void startContext(String contextName)

Trace context start

Parameters:

contextName - the context name to trace

endContext

public void endContext(String value)

stops trace of context

Parameters:

value - the context name to stop

addVariable

public void addVariable(String variable,
                        Object object)

getLastProcessTrace

public String getLastProcessTrace()

startProcess

public void startProcess()

endProcess

public void endProcess()

isDebug

public boolean isDebug()

getPackageStart

public String getPackageStart()

setPackageStart

public void setPackageStart(String packageStart)

size

public int size()