org.apache.brooklyn.enricher.stock

Class PercentageEnricher

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.PercentageEnricher

All Implemented Interfaces:

Rebindable, BrooklynObject, Configurable, EntityAdjunct, Identifiable, Enricher, SensorEventListener<java.lang.Number>, BrooklynObjectInternal

public class PercentageEnricher
extends AbstractEnricher
implements SensorEventListener<java.lang.Number>

Enricher that is configured with two numerical sensors; a current and a total. The Enricher subscribes to events from these sensors, and will emit the ratio of current to total as a target sensor.

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

Modifier and Type	Field and Description
static ConfigKey<Entity>	PRODUCER
static ConfigKey<AttributeSensor<? extends java.lang.Number>>	SOURCE_CURRENT_SENSOR
static ConfigKey<AttributeSensor<? extends java.lang.Number>>	SOURCE_TOTAL_SENSOR
static ConfigKey<AttributeSensor<java.lang.Double>>	TARGET_SENSOR

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
PercentageEnricher()

Method Summary

Modifier and Type	Method and Description
void	onEvent(SensorEvent<java.lang.Number> event) The SensorEvent handler method.
void	setEntity(EntityLocal entity)

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

Field Detail

SOURCE_CURRENT_SENSOR

public static final ConfigKey<AttributeSensor<? extends java.lang.Number>> SOURCE_CURRENT_SENSOR

SOURCE_TOTAL_SENSOR

public static final ConfigKey<AttributeSensor<? extends java.lang.Number>> SOURCE_TOTAL_SENSOR

TARGET_SENSOR

public static final ConfigKey<AttributeSensor<java.lang.Double>> TARGET_SENSOR

PRODUCER

public static final ConfigKey<Entity> PRODUCER

Constructor Detail

PercentageEnricher

public PercentageEnricher()

Method Detail

setEntity

public void setEntity(EntityLocal entity)

Overrides:

setEntity in class AbstractEnricher

onEvent

public void onEvent(SensorEvent<java.lang.Number> event)

Description copied from interface: SensorEventListener

The SensorEvent handler method.

Specified by:

onEvent in interface SensorEventListener<java.lang.Number>