org.apache.brooklyn.enricher.stock

Class UpdatingMap<S,TKey,TVal>

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.UpdatingMap<S,TKey,TVal>

Type Parameters:

S - source sensor type

TKey - key type in target sensor map

TVal - value type in target sensor map

All Implemented Interfaces:

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

public class UpdatingMap<S,TKey,TVal>
extends AbstractEnricher
implements SensorEventListener<S>

Enricher which updates an entry in a sensor map (TARGET_SENSOR) based on the value of another sensor (SOURCE_SENSOR.

The key used defaults to the name of the source sensor but can be specified with KEY_IN_TARGET_SENSOR. The value placed in the map is the result of applying the function in COMPUTING to the sensor value, with default behaviour being to remove an entry if null is returned but this can be overriden by setting REMOVING_IF_RESULT_IS_NULL false. Entities.REMOVE and Entities.UNCHANGED are also respeced as return values for the computation (ignoring generics). Unlike most other enrichers, this defaults to AbstractEnricher.SUPPRESS_DUPLICATES being true

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<<any>>	COMPUTING
static ConfigKey<java.lang.Object>	KEY_IN_TARGET_SENSOR
static ConfigKey<Entity>	PRODUCER
static ConfigKey<java.lang.Boolean>	REMOVING_IF_RESULT_IS_NULL
static ConfigKey<Sensor<?>>	SOURCE_SENSOR
static ConfigKey<Sensor<?>>	TARGET_SENSOR

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

Method Summary

Modifier and Type	Method and Description
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<S> 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, 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

Field Detail

PRODUCER

public static final ConfigKey<Entity> PRODUCER

SOURCE_SENSOR

public static final ConfigKey<Sensor<?>> SOURCE_SENSOR

TARGET_SENSOR

public static final ConfigKey<Sensor<?>> TARGET_SENSOR

KEY_IN_TARGET_SENSOR

public static final ConfigKey<java.lang.Object> KEY_IN_TARGET_SENSOR

COMPUTING

public static final ConfigKey<<any>> COMPUTING

REMOVING_IF_RESULT_IS_NULL

public static final ConfigKey<java.lang.Boolean> REMOVING_IF_RESULT_IS_NULL

Constructor Detail

UpdatingMap

public UpdatingMap()

Method Detail

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

setEntity

public void setEntity(EntityLocal entity)

Overrides:

setEntity in class AbstractEnricher

onEvent

public void onEvent(SensorEvent<S> event)

Description copied from interface: SensorEventListener

The SensorEvent handler method.

Specified by:

onEvent in interface SensorEventListener<S>