org.apache.brooklyn.enricher.stock

Class CustomAggregatingEnricher<S,T>

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.objs.AbstractEntityAdjunct

org.apache.brooklyn.core.enricher.AbstractEnricher

org.apache.brooklyn.enricher.stock.AbstractAggregatingEnricher<S,T>

org.apache.brooklyn.enricher.stock.CustomAggregatingEnricher<S,T>

Type Parameters:

T -

All Implemented Interfaces:

Rebindable, BrooklynObject, Configurable, EntityAdjunct, Identifiable, Enricher, SensorEventListener<S>, BrooklynObjectInternal

Deprecated.

since 0.7.0; use Enrichers.builder()

@Deprecated
public class CustomAggregatingEnricher<S,T>
extends AbstractAggregatingEnricher<S,T>
implements SensorEventListener<S>

Subscribes to events from producers with a sensor of type T, aggregates them with the provided closure and emits the result on the target sensor V.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct

AbstractEntityAdjunct.AdjunctTagSupport, AbstractEntityAdjunct.BasicSubscriptionSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

BrooklynObject.RelationSupport<T extends BrooklynObject>, BrooklynObject.SubscriptionSupport, BrooklynObject.TagSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.Configurable

Configurable.ConfigurationSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

BrooklynObjectInternal.ConfigurationSupportInternal, BrooklynObjectInternal.RelationSupportInternal<T extends BrooklynObject>, BrooklynObjectInternal.SubscriptionSupportInternal

Field Summary

Fields inherited from class org.apache.brooklyn.core.enricher.AbstractEnricher

SUPPRESS_DUPLICATES

Fields inherited from interface org.apache.brooklyn.api.sensor.SensorEventListener

NOOP

Constructor Summary

Constructors

Constructor and Description
CustomAggregatingEnricher(AttributeSensor<? extends S> source, AttributeSensor<T> target, com.google.common.base.Function<java.util.Collection<S>,T> aggregator) Deprecated.
CustomAggregatingEnricher(AttributeSensor<? extends S> source, AttributeSensor<T> target, com.google.common.base.Function<java.util.Collection<S>,T> aggregator, S defaultValue) Deprecated.
CustomAggregatingEnricher(AttributeSensor<S> source, AttributeSensor<T> target, groovy.lang.Closure<?> aggregator) Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.
CustomAggregatingEnricher(AttributeSensor<S> source, AttributeSensor<T> target, groovy.lang.Closure<?> aggregator, S defaultValueForUnreportedSensors) Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.
CustomAggregatingEnricher(java.util.Map<java.lang.String,?> flags, AttributeSensor<? extends S> source, AttributeSensor<T> target, groovy.lang.Closure<?> aggregator) Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.
CustomAggregatingEnricher(java.util.Map<java.lang.String,?> flags, AttributeSensor<? extends S> source, AttributeSensor<T> target, groovy.lang.Closure<?> aggregator, S defaultValueForUnreportedSensors) Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.
CustomAggregatingEnricher(java.util.Map<java.lang.String,?> flags, AttributeSensor<? extends S> source, AttributeSensor<T> target, com.google.common.base.Function<java.util.Collection<S>,T> aggregator) Deprecated.
CustomAggregatingEnricher(java.util.Map<java.lang.String,?> flags, AttributeSensor<? extends S> source, AttributeSensor<T> target, com.google.common.base.Function<java.util.Collection<S>,T> aggregator, S defaultIniitalValueForUnreportedSensors) Deprecated. The valid keys for the flags are: - producers: a collection of entities to be aggregated - allMembers: indicates that should track members of the entity that the aggregator is associated with, to aggregate across all those members.

Method Summary

Modifier and Type	Method and Description
T	getAggregate() Deprecated.
static <N extends java.lang.Number> CustomAggregatingEnricher<N,java.lang.Double>	newAveragingEnricher(AttributeSensor<N> source, AttributeSensor<java.lang.Double> target) Deprecated.
static <N extends java.lang.Number> CustomAggregatingEnricher<N,java.lang.Double>	newAveragingEnricher(java.util.Map<java.lang.String,?> flags, AttributeSensor<? extends N> source, AttributeSensor<java.lang.Double> target, N defaultValueForUnreportedSensors, java.lang.Double valueToReportIfNoSensors) Deprecated. since 0.7.0; use Enrichers.builder()
static <S,T> CustomAggregatingEnricher<S,T>	newEnricher(AttributeSensor<S> source, AttributeSensor<T> target, groovy.lang.Closure<?> aggregator) Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.
static <S,T> CustomAggregatingEnricher<S,T>	newEnricher(AttributeSensor<S> source, AttributeSensor<T> target, groovy.lang.Closure<?> aggregator, S defaultVal) Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.
static <S,T> CustomAggregatingEnricher<S,T>	newEnricher(AttributeSensor<S> source, AttributeSensor<T> target, com.google.common.base.Function<java.util.Collection<S>,T> aggregator) Deprecated.
static <S,T> CustomAggregatingEnricher<S,T>	newEnricher(AttributeSensor<S> source, AttributeSensor<T> target, com.google.common.base.Function<java.util.Collection<S>,T> aggregator, S defaultVal) Deprecated.
static <S,T> CustomAggregatingEnricher<S,T>	newEnricher(java.util.Map<java.lang.String,?> flags, AttributeSensor<S> source, AttributeSensor<T> target, groovy.lang.Closure<?> aggregator) Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.
static <S,T> CustomAggregatingEnricher<S,T>	newEnricher(java.util.Map<java.lang.String,?> flags, AttributeSensor<S> source, AttributeSensor<T> target, groovy.lang.Closure<?> aggregator, S defaultVal) Deprecated. since 0.7.0; use Enrichers.builder()
static <S,T> CustomAggregatingEnricher<S,T>	newEnricher(java.util.Map<java.lang.String,?> flags, AttributeSensor<S> source, AttributeSensor<T> target, com.google.common.base.Function<java.util.Collection<S>,T> aggregator) Deprecated.
static <S,T> CustomAggregatingEnricher<S,T>	newEnricher(java.util.Map<java.lang.String,?> flags, AttributeSensor<S> source, AttributeSensor<T> target, com.google.common.base.Function<java.util.Collection<S>,T> aggregator, S defaultVal) Deprecated. since 0.7.0; use Enrichers.builder()
static <N extends java.lang.Number> CustomAggregatingEnricher<N,N>	newSummingEnricher(AttributeSensor<N> source, AttributeSensor<N> target) Deprecated.
static <N extends java.lang.Number,T extends java.lang.Number> CustomAggregatingEnricher<N,T>	newSummingEnricher(java.util.Map<java.lang.String,?> flags, AttributeSensor<N> source, AttributeSensor<T> target, N defaultValueForUnreportedSensors, T valueToReportIfNoSensors) Deprecated. since 0.7.0; use Enrichers.builder()
void	onUpdated() Deprecated. Called whenever the values for the set of producers changes (e.g.

Methods inherited from class org.apache.brooklyn.enricher.stock.AbstractAggregatingEnricher

addProducer, onEvent, removeProducer, setEntity

Methods inherited from class org.apache.brooklyn.core.enricher.AbstractEnricher

getEnricherType, getRebindSupport, relations

Methods inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct

config, configure, destroy, getAdjunctType, getConfig, getDisplayName, getEntity, getUniqueTag, isDestroyed, isRunning, setConfig, setDisplayName, subscribe, subscribeToChildren, subscribeToMembers, subscriptions, tags, toString, unsubscribe, unsubscribe

Methods inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject

getCatalogItemId, getId, getManagementContext, init, rebind, setCatalogItemId, setManagementContext

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.brooklyn.api.sensor.SensorEventListener

onEvent

Methods inherited from interface org.apache.brooklyn.api.sensor.Enricher

getId

Methods inherited from interface org.apache.brooklyn.api.objs.EntityAdjunct

getUniqueTag, isDestroyed, isRunning

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

getCatalogItemId, getDisplayName, subscriptions, tags

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable

config, getConfig, setConfig

Methods inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

setCatalogItemId

Constructor Detail

CustomAggregatingEnricher

public CustomAggregatingEnricher(java.util.Map<java.lang.String,?> flags,
                                 AttributeSensor<? extends S> source,
                                 AttributeSensor<T> target,
                                 com.google.common.base.Function<java.util.Collection<S>,T> aggregator,
                                 S defaultIniitalValueForUnreportedSensors)

Deprecated.

The valid keys for the flags are: - producers: a collection of entities to be aggregated - allMembers: indicates that should track members of the entity that the aggregator is associated with, to aggregate across all those members. - filter: a Predicate indicating which entities to include (support for Closure is deprecated)

Parameters:

flags -

source -

target -

aggregator - Aggregates a collection of values, to return a single value for the target sensor

defaultIniitalValueForUnreportedSensors - Default value to populate the collection given to aggregator, where sensors are null or not present initially, defaults to null (note however that subsequent null reports will put an explicit null)

CustomAggregatingEnricher

public CustomAggregatingEnricher(java.util.Map<java.lang.String,?> flags,
                                 AttributeSensor<? extends S> source,
                                 AttributeSensor<T> target,
                                 com.google.common.base.Function<java.util.Collection<S>,T> aggregator)

Deprecated.

CustomAggregatingEnricher

public CustomAggregatingEnricher(AttributeSensor<? extends S> source,
                                 AttributeSensor<T> target,
                                 com.google.common.base.Function<java.util.Collection<S>,T> aggregator,
                                 S defaultValue)

Deprecated.

CustomAggregatingEnricher

public CustomAggregatingEnricher(AttributeSensor<? extends S> source,
                                 AttributeSensor<T> target,
                                 com.google.common.base.Function<java.util.Collection<S>,T> aggregator)

Deprecated.

CustomAggregatingEnricher

@Deprecated
public CustomAggregatingEnricher(java.util.Map<java.lang.String,?> flags,
                                             AttributeSensor<? extends S> source,
                                             AttributeSensor<T> target,
                                             groovy.lang.Closure<?> aggregator,
                                             S defaultValueForUnreportedSensors)

Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.

Parameters:

flags -

source -

target -

aggregator - Should take a collection of values and return a single, aggregate value

defaultValueForUnreportedSensors -

See Also:

CustomAggregatingEnricher(Map, AttributeSensor, AttributeSensor, Function, Object)

CustomAggregatingEnricher

@Deprecated
public CustomAggregatingEnricher(java.util.Map<java.lang.String,?> flags,
                                             AttributeSensor<? extends S> source,
                                             AttributeSensor<T> target,
                                             groovy.lang.Closure<?> aggregator)

Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.

CustomAggregatingEnricher

@Deprecated
public CustomAggregatingEnricher(AttributeSensor<S> source,
                                             AttributeSensor<T> target,
                                             groovy.lang.Closure<?> aggregator,
                                             S defaultValueForUnreportedSensors)

Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.

CustomAggregatingEnricher

@Deprecated
public CustomAggregatingEnricher(AttributeSensor<S> source,
                                             AttributeSensor<T> target,
                                             groovy.lang.Closure<?> aggregator)

Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.

Method Detail

onUpdated

public void onUpdated()

Deprecated.

Description copied from class: AbstractAggregatingEnricher

Called whenever the values for the set of producers changes (e.g. on an event, or on a member added/removed). Defaults to no-op

getAggregate

public T getAggregate()

Deprecated.

newEnricher

@Deprecated
public static <S,T> CustomAggregatingEnricher<S,T> newEnricher(java.util.Map<java.lang.String,?> flags,
                                                                           AttributeSensor<S> source,
                                                                           AttributeSensor<T> target,
                                                                           groovy.lang.Closure<?> aggregator,
                                                                           S defaultVal)

Deprecated. since 0.7.0; use Enrichers.builder()

Instead, consider calling:

 
 Enrichers.Builder builder = Enrichers.builder()
         .aggregating(source)
         .publishing(target)
         .computing(GroovyJavaMethods.<Collection<S>, T>functionFromClosure((Closure<T>)aggregator))
         .defaultValueForUnreportedSensors(defaultValueForUnreportedSensors);
 
 if (Boolean.TRUE.equals(allMembers)) builder.fromMembers();
 if (filter != null) builder.entityFilter(filter);
 if (hardCodedProducers != null) builder.fromHardcodedProducers(hardCodedProducers);
 
 addEnricher(builder.build());
 
 

newEnricher

@Deprecated
public static <S,T> CustomAggregatingEnricher<S,T> newEnricher(java.util.Map<java.lang.String,?> flags,
                                                                           AttributeSensor<S> source,
                                                                           AttributeSensor<T> target,
                                                                           groovy.lang.Closure<?> aggregator)

Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.

newEnricher

@Deprecated
public static <S,T> CustomAggregatingEnricher<S,T> newEnricher(AttributeSensor<S> source,
                                                                           AttributeSensor<T> target,
                                                                           groovy.lang.Closure<?> aggregator,
                                                                           S defaultVal)

Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.

newEnricher

@Deprecated
public static <S,T> CustomAggregatingEnricher<S,T> newEnricher(AttributeSensor<S> source,
                                                                           AttributeSensor<T> target,
                                                                           groovy.lang.Closure<?> aggregator)

Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.

newEnricher

@Deprecated
public static <S,T> CustomAggregatingEnricher<S,T> newEnricher(java.util.Map<java.lang.String,?> flags,
                                                                           AttributeSensor<S> source,
                                                                           AttributeSensor<T> target,
                                                                           com.google.common.base.Function<java.util.Collection<S>,T> aggregator,
                                                                           S defaultVal)

Deprecated. since 0.7.0; use Enrichers.builder()

Instead, consider calling:

 
 Enrichers.Builder builder = Enrichers.builder()
         .aggregating(source)
         .publishing(target)
         .computing(aggregator)
         .defaultValueForUnreportedSensors(defaultVal);
 
 if (Boolean.TRUE.equals(allMembers)) builder.fromMembers();
 if (filter != null) builder.entityFilter(filter);
 if (hardCodedProducers != null) builder.fromHardcodedProducers(hardCodedProducers);
 
 addEnricher(builder.build());
 
 

newEnricher

public static <S,T> CustomAggregatingEnricher<S,T> newEnricher(java.util.Map<java.lang.String,?> flags,
                                                               AttributeSensor<S> source,
                                                               AttributeSensor<T> target,
                                                               com.google.common.base.Function<java.util.Collection<S>,T> aggregator)

Deprecated.

newEnricher

public static <S,T> CustomAggregatingEnricher<S,T> newEnricher(AttributeSensor<S> source,
                                                               AttributeSensor<T> target,
                                                               com.google.common.base.Function<java.util.Collection<S>,T> aggregator,
                                                               S defaultVal)

Deprecated.

newEnricher

public static <S,T> CustomAggregatingEnricher<S,T> newEnricher(AttributeSensor<S> source,
                                                               AttributeSensor<T> target,
                                                               com.google.common.base.Function<java.util.Collection<S>,T> aggregator)

Deprecated.

newSummingEnricher

@Deprecated
public static <N extends java.lang.Number,T extends java.lang.Number> CustomAggregatingEnricher<N,T> newSummingEnricher(java.util.Map<java.lang.String,?> flags,
                                                                                                                                    AttributeSensor<N> source,
                                                                                                                                    AttributeSensor<T> target,
                                                                                                                                    N defaultValueForUnreportedSensors,
                                                                                                                                    T valueToReportIfNoSensors)

Deprecated. since 0.7.0; use Enrichers.builder()

creates an enricher which sums over all children/members, defaulting to excluding sensors which have not published anything (or published null), and null if there are no sensors; this behaviour can be customised, both default value for sensors, and what to report if no sensors Instead, consider calling:

 
 Enrichers.Builder builder = Enrichers.builder()
         .aggregating(source)
         .publishing(target)
         .computingSum()
         .defaultValueForUnreportedSensors(defaultValueForUnreportedSensors)
         .valueToReportIfNoSensors(valueToReportIfNoSensors);
 
 if (Boolean.TRUE.equals(allMembers)) builder.fromMembers();
 if (filter != null) builder.entityFilter(filter);
 if (hardCodedProducers != null) builder.fromHardcodedProducers(hardCodedProducers);
 
 addEnricher(builder.build());
 
 

newSummingEnricher

public static <N extends java.lang.Number> CustomAggregatingEnricher<N,N> newSummingEnricher(AttributeSensor<N> source,
                                                                                             AttributeSensor<N> target)

Deprecated.

See Also:

#newSummingEnricher(Map, AttributeSensor, AttributeSensor, Number, Number)}

newAveragingEnricher

@Deprecated
public static <N extends java.lang.Number> CustomAggregatingEnricher<N,java.lang.Double> newAveragingEnricher(java.util.Map<java.lang.String,?> flags,
                                                                                                                          AttributeSensor<? extends N> source,
                                                                                                                          AttributeSensor<java.lang.Double> target,
                                                                                                                          N defaultValueForUnreportedSensors,
                                                                                                                          java.lang.Double valueToReportIfNoSensors)

Deprecated. since 0.7.0; use Enrichers.builder()

creates an enricher which averages over all children/members, defaulting to excluding sensors which have not published anything (or published null), and null if there are no sensors; this behaviour can be customised, both default value for sensors, and what to report if no sensors Instead, consider calling:

 
 Enrichers.Builder builder = Enrichers.builder()
         .aggregating(source)
         .publishing(target)
         .computingAverage()
         .defaultValueForUnreportedSensors(defaultValueForUnreportedSensors)
         .valueToReportIfNoSensors(valueToReportIfNoSensors);
 
 if (Boolean.TRUE.equals(allMembers)) builder.fromMembers();
 if (filter != null) builder.entityFilter(filter);
 if (hardCodedProducers != null) builder.fromHardcodedProducers(hardCodedProducers);
 
 addEnricher(builder.build());
 
 

newAveragingEnricher

public static <N extends java.lang.Number> CustomAggregatingEnricher<N,java.lang.Double> newAveragingEnricher(AttributeSensor<N> source,
                                                                                                              AttributeSensor<java.lang.Double> target)

Deprecated.

See Also:

newAveragingEnricher(Map, AttributeSensor, AttributeSensor, Number, Double)