org.apache.brooklyn.policy.enricher

Class TimeWeightedDeltaEnricher<T extends java.lang.Number>

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.AbstractTypeTransformingEnricher<T,java.lang.Double>

org.apache.brooklyn.policy.enricher.TimeWeightedDeltaEnricher<T>

All Implemented Interfaces:

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

public class TimeWeightedDeltaEnricher<T extends java.lang.Number>
extends AbstractTypeTransformingEnricher<T,java.lang.Double>

Converts an absolute sensor into a delta sensor (i.e. the diff between the current and previous value), presented as a units/timeUnit based on the event timing.

NB for time (e.g. "total milliseconds consumed") use TimeFractionDeltaEnricher

See also YamlTimeWeightedDeltaEnricher designed for use from YAML.

TODO this may end up being deprecated in favour of near-duplicate code in YAML-friendly YamlTimeWeightedDeltaEnricher, marking as @Beta in 0.7.0 timeframe

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 class org.apache.brooklyn.core.objs.AbstractEntityAdjunct

HIGHLIGHT_NAME_LAST_ACTION, HIGHLIGHT_NAME_LAST_CONFIRMATION, HIGHLIGHT_NAME_LAST_VIOLATION, HIGHLIGHT_NAME_TRIGGERS

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

NOOP

Constructor Summary

Constructors

Constructor and Description
TimeWeightedDeltaEnricher()
TimeWeightedDeltaEnricher(Entity producer, Sensor<T> source, Sensor<java.lang.Double> target, int unitMillis) Deprecated. since 0.12.0; use EnricherSpec
TimeWeightedDeltaEnricher(Entity producer, Sensor<T> source, Sensor<java.lang.Double> target, int unitMillis, <any> postProcessor) Deprecated. since 0.12.0; use EnricherSpec
TimeWeightedDeltaEnricher(Entity producer, Sensor<T> source, Sensor<java.lang.Double> target, int unitMillis, groovy.lang.Closure<java.lang.Double> postProcessor) Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted; also use EnricherSpec

Method Summary

Modifier and Type	Method and Description
static <T extends java.lang.Number> TimeWeightedDeltaEnricher<T>	getPerSecondDeltaEnricher(Entity producer, Sensor<T> source, Sensor<java.lang.Double> target) Deprecated. since 0.12.0; use EnricherSpec
void	init() Called by framework (in new-style instances where spec was used) after configuring etc, but before a reference to this instance is shared.
void	onEvent(SensorEvent<T> event) The SensorEvent handler method.
void	onEvent(SensorEvent<T> event, long eventTime)

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

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, getExecutionContext, getHighlights, getManagementContext, getUniqueTag, isDestroyed, isRunning, setDisplayName, setHighlights, subscriptions, tags, toString

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

addSearchPath, getCatalogItemId, getCatalogItemIdSearchPath, getId, rebind, setCatalogItemId, setCatalogItemIdAndSearchPath, setManagementContext, stackCatalogItemId

Methods inherited from class java.lang.Object

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

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

getId

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

getHighlights, getUniqueTag, isDestroyed, isRunning

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

getCatalogItemId, getCatalogItemIdSearchPath, getDisplayName, subscriptions, tags

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

config, getConfig

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

addSearchPath, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId

Constructor Detail

TimeWeightedDeltaEnricher

public TimeWeightedDeltaEnricher()

TimeWeightedDeltaEnricher

@Deprecated
public TimeWeightedDeltaEnricher(Entity producer,
                                             Sensor<T> source,
                                             Sensor<java.lang.Double> target,
                                             int unitMillis)

Deprecated. since 0.12.0; use EnricherSpec

TimeWeightedDeltaEnricher

@Deprecated
public TimeWeightedDeltaEnricher(Entity producer,
                                             Sensor<T> source,
                                             Sensor<java.lang.Double> target,
                                             int unitMillis,
                                             groovy.lang.Closure<java.lang.Double> postProcessor)

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

TimeWeightedDeltaEnricher

@Deprecated
public TimeWeightedDeltaEnricher(Entity producer,
                                             Sensor<T> source,
                                             Sensor<java.lang.Double> target,
                                             int unitMillis,
                                             <any> postProcessor)

Deprecated. since 0.12.0; use EnricherSpec

Method Detail

getPerSecondDeltaEnricher

@Deprecated
public static <T extends java.lang.Number> TimeWeightedDeltaEnricher<T> getPerSecondDeltaEnricher(Entity producer,
                                                                                                              Sensor<T> source,
                                                                                                              Sensor<java.lang.Double> target)

Deprecated. since 0.12.0; use EnricherSpec

init

public void init()

Description copied from class: AbstractBrooklynObject

Called by framework (in new-style instances where spec was used) after configuring etc, but before a reference to this instance is shared.

To preserve backwards compatibility for if the instance is constructed directly, one can call the code below, but that means it will be called after references to this policy have been shared with other entities.

 
 if (isLegacyConstruction()) {
     init();
 }
 
 

Overrides:

init in class AbstractBrooklynObject

onEvent

public void onEvent(SensorEvent<T> event)

Description copied from interface: SensorEventListener

The SensorEvent handler method.

onEvent

public void onEvent(SensorEvent<T> event,
                    long eventTime)