Top Description Inners Fields Constructors Methods
net.sf.ehcache.search.aggregator

public Class Average

extends Object
implements AggregatorInstance<Double>
Class Inheritance
All Implemented Interfaces
net.sf.ehcache.search.aggregator.AggregatorInstance
Imports
net.sf.ehcache.search.Attribute
Compute the average (arithmetic mean) as a double
Author
teck

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv abstract static class
Average.Engine

Abstract super-class for all average calculating engines.

Field Summary

Modifier and TypeField and Description
private final Attribute<?>
attribute

private Average.Engine
engine

Constructor Summary

AccessConstructor and Description
public
Average(Attribute<?> attribute)

Method Summary

Modifier and TypeMethod and Description
public void
accept(Object
a single input value
input)

Implements net.sf.ehcache.search.aggregator.AggregatorInstance.accept.

Add the given value to the aggregator function

Note

Null values are ignored and not included in the computation

public Number
aggregateResult()

Implements net.sf.ehcache.search.aggregator.AggregatorInstance.aggregateResult.

Retrieve the final result

Note

null is returned if there was no input supplied to this function

public Average
createClone()

Implements net.sf.ehcache.search.aggregator.AggregatorInstance.createClone.

Create a clone of this aggregator, detaching from its result
public Attribute<T>
getAttribute()

Implements net.sf.ehcache.search.aggregator.AggregatorInstance.getAttribute.

Get the attribute to pass to aggregator
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

attributeback to summary
private final Attribute<?> attribute
engineback to summary
private Average.Engine engine

Constructor Detail

Averageback to summary
public Average(Attribute<?> attribute)

Method Detail

acceptback to summary
public void accept(Object input) throws AggregatorException

Implements net.sf.ehcache.search.aggregator.AggregatorInstance.accept.

Doc from net.sf.ehcache.search.aggregator.AggregatorInstance.accept.

Add the given value to the aggregator function

Note

Null values are ignored and not included in the computation

Parameters
input:Object

a single input value

Exceptions
AggregatorException:
if the function cannot be computed, possibly due to unsupported types
aggregateResultback to summary
public Number aggregateResult()

Implements net.sf.ehcache.search.aggregator.AggregatorInstance.aggregateResult.

Doc from net.sf.ehcache.search.aggregator.AggregatorInstance.aggregateResult.

Retrieve the final result

Note

null is returned if there was no input supplied to this function

Returns:Number

aggregate result

createCloneback to summary
public Average createClone()

Implements net.sf.ehcache.search.aggregator.AggregatorInstance.createClone.

Doc from net.sf.ehcache.search.aggregator.AggregatorInstance.createClone.

Create a clone of this aggregator, detaching from its result

getAttributeback to summary
public Attribute<T> getAttribute()

Implements net.sf.ehcache.search.aggregator.AggregatorInstance.getAttribute.

Doc from net.sf.ehcache.search.aggregator.AggregatorInstance.getAttribute.

Get the attribute to pass to aggregator

Returns:Attribute<T>

attribute to aggregate (null if no attribute is applicable to function)

net.sf.ehcache.search.aggregator back to summary

pack-priv abstract Class Average.Engine

extends Object
Class Inheritance
Known Direct Subclasses
net.sf.ehcache.search.aggregator.Average.Engine.IntegerEngine, net.sf.ehcache.search.aggregator.Average.Engine.LongEngine, net.sf.ehcache.search.aggregator.Average.Engine.FloatEngine, net.sf.ehcache.search.aggregator.Average.Engine.DoubleEngine
Abstract super-class for all average calculating engines.

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class
Average.Engine.DoubleEngine

A double based averaging engine.

pack-priv static class
Average.Engine.FloatEngine

A float based averaging engine.

pack-priv static class
Average.Engine.IntegerEngine

An int based averaging engine.

pack-priv static class
Average.Engine.LongEngine

A long based averaging engine.

Constructor Summary

AccessConstructor and Description
pack-priv
Engine()

Method Summary

Modifier and TypeMethod and Description
pack-priv abstract void
accept(Number
data value
input)

Update the engine with the given value.

pack-priv static Average.Engine

Returns:

type specific engine
create(Number
initial value
value)

Create a type specific engine using the given initial value.

pack-priv abstract Number

Returns:

engine result
result()

Get the (current) result of this engine.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Engineback to summary
pack-priv Engine()

Method Detail

acceptback to summary
pack-priv abstract void accept(Number input) throws AggregatorException

Update the engine with the given value.

Parameters
input:Number

data value

createback to summary
pack-priv static Average.Engine create(Number value)

Create a type specific engine using the given initial value.

Parameters
value:Number

initial value

Returns:Average.Engine

type specific engine

resultback to summary
pack-priv abstract Number result()

Get the (current) result of this engine.

Returns:Number

engine result

net.sf.ehcache.search.aggregator back to summary

pack-priv Class Average.Engine.DoubleEngine

extends Engine
Class Inheritance
A double based averaging engine.

Field Summary

Modifier and TypeField and Description
private int
count

private double
sum

Constructor Summary

AccessConstructor and Description
pack-priv
DoubleEngine(double
initial value
value)

Creates a new instance starting with an initial value

Method Summary

Modifier and TypeMethod and Description
pack-priv void
accept(Number
data value
input)

Implements abstract net.sf.ehcache.search.aggregator.Average.Engine.accept.

Update the engine with the given value.
pack-priv Number
result()

Implements abstract net.sf.ehcache.search.aggregator.Average.Engine.result.

Get the (current) result of this engine.
Inherited from net.sf.ehcache.search.aggregator.Average.Engine:
create

Field Detail

countback to summary
private int count
sumback to summary
private double sum

Constructor Detail

DoubleEngineback to summary
pack-priv DoubleEngine(double value)

Creates a new instance starting with an initial value

Parameters
value:double

initial value

Method Detail

acceptback to summary
pack-priv void accept(Number input) throws AggregatorException

Implements abstract net.sf.ehcache.search.aggregator.Average.Engine.accept.

Doc from net.sf.ehcache.search.aggregator.Average.Engine.accept.

Update the engine with the given value.

Parameters
input:Number

data value

Annotations
@Override
resultback to summary
pack-priv Number result()

Implements abstract net.sf.ehcache.search.aggregator.Average.Engine.result.

Doc from net.sf.ehcache.search.aggregator.Average.Engine.result.

Get the (current) result of this engine.

Returns:Number

engine result

Annotations
@Override
net.sf.ehcache.search.aggregator back to summary

pack-priv Class Average.Engine.FloatEngine

extends Engine
Class Inheritance
A float based averaging engine.

Field Summary

Modifier and TypeField and Description
private int
count

private float
sum

Constructor Summary

AccessConstructor and Description
pack-priv
FloatEngine(float
initial value
value)

Creates a new instance starting with an initial value

Method Summary

Modifier and TypeMethod and Description
pack-priv void
accept(Number
data value
input)

Implements abstract net.sf.ehcache.search.aggregator.Average.Engine.accept.

Update the engine with the given value.
pack-priv Number
result()

Implements abstract net.sf.ehcache.search.aggregator.Average.Engine.result.

Get the (current) result of this engine.
Inherited from net.sf.ehcache.search.aggregator.Average.Engine:
create

Field Detail

countback to summary
private int count
sumback to summary
private float sum

Constructor Detail

FloatEngineback to summary
pack-priv FloatEngine(float value)

Creates a new instance starting with an initial value

Parameters
value:float

initial value

Method Detail

acceptback to summary
pack-priv void accept(Number input) throws AggregatorException

Implements abstract net.sf.ehcache.search.aggregator.Average.Engine.accept.

Doc from net.sf.ehcache.search.aggregator.Average.Engine.accept.

Update the engine with the given value.

Parameters
input:Number

data value

Annotations
@Override
resultback to summary
pack-priv Number result()

Implements abstract net.sf.ehcache.search.aggregator.Average.Engine.result.

Doc from net.sf.ehcache.search.aggregator.Average.Engine.result.

Get the (current) result of this engine.

Returns:Number

engine result

Annotations
@Override
net.sf.ehcache.search.aggregator back to summary

pack-priv Class Average.Engine.IntegerEngine

extends Engine
Class Inheritance
An int based averaging engine.

Field Summary

Modifier and TypeField and Description
private int
count

private long
sum

Constructor Summary

AccessConstructor and Description
pack-priv
IntegerEngine(int
initial value
value)

Creates a new instance starting with an initial value

Method Summary

Modifier and TypeMethod and Description
pack-priv void
accept(Number
data value
input)

Implements abstract net.sf.ehcache.search.aggregator.Average.Engine.accept.

Update the engine with the given value.
pack-priv Number
result()

Implements abstract net.sf.ehcache.search.aggregator.Average.Engine.result.

Get the (current) result of this engine.
Inherited from net.sf.ehcache.search.aggregator.Average.Engine:
create

Field Detail

countback to summary
private int count
sumback to summary
private long sum

Constructor Detail

IntegerEngineback to summary
pack-priv IntegerEngine(int value)

Creates a new instance starting with an initial value

Parameters
value:int

initial value

Method Detail

acceptback to summary
pack-priv void accept(Number input) throws AggregatorException

Implements abstract net.sf.ehcache.search.aggregator.Average.Engine.accept.

Doc from net.sf.ehcache.search.aggregator.Average.Engine.accept.

Update the engine with the given value.

Parameters
input:Number

data value

Annotations
@Override
resultback to summary
pack-priv Number result()

Implements abstract net.sf.ehcache.search.aggregator.Average.Engine.result.

Doc from net.sf.ehcache.search.aggregator.Average.Engine.result.

Get the (current) result of this engine.

Returns:Number

engine result

Annotations
@Override
net.sf.ehcache.search.aggregator back to summary

pack-priv Class Average.Engine.LongEngine

extends Engine
Class Inheritance
A long based averaging engine.

Field Summary

Modifier and TypeField and Description
private int
count

private long
sum

Constructor Summary

AccessConstructor and Description
pack-priv
LongEngine(long
initial value
value)

Creates a new instance starting with an initial value

Method Summary

Modifier and TypeMethod and Description
pack-priv void
accept(Number
data value
input)

Implements abstract net.sf.ehcache.search.aggregator.Average.Engine.accept.

Update the engine with the given value.
pack-priv Number
result()

Implements abstract net.sf.ehcache.search.aggregator.Average.Engine.result.

Get the (current) result of this engine.
Inherited from net.sf.ehcache.search.aggregator.Average.Engine:
create

Field Detail

countback to summary
private int count
sumback to summary
private long sum

Constructor Detail

LongEngineback to summary
pack-priv LongEngine(long value)

Creates a new instance starting with an initial value

Parameters
value:long

initial value

Method Detail

acceptback to summary
pack-priv void accept(Number input) throws AggregatorException

Implements abstract net.sf.ehcache.search.aggregator.Average.Engine.accept.

Doc from net.sf.ehcache.search.aggregator.Average.Engine.accept.

Update the engine with the given value.

Parameters
input:Number

data value

Annotations
@Override
resultback to summary
pack-priv Number result()

Implements abstract net.sf.ehcache.search.aggregator.Average.Engine.result.

Doc from net.sf.ehcache.search.aggregator.Average.Engine.result.

Get the (current) result of this engine.

Returns:Number

engine result

Annotations
@Override