org.apache.brooklyn.policy.enricher.DeltaEnricher Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of brooklyn-policy Show documentation

General policies and enrichers for managing entities

There is a newer version: 1.1.0

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.brooklyn.policy.enricher;

import static org.apache.brooklyn.util.JavaGroovyEquivalents.elvis;

import org.apache.brooklyn.api.catalog.Catalog;
import org.apache.brooklyn.api.entity.Entity;
import org.apache.brooklyn.api.sensor.AttributeSensor;
import org.apache.brooklyn.api.sensor.EnricherSpec;
import org.apache.brooklyn.api.sensor.Sensor;
import org.apache.brooklyn.api.sensor.SensorEvent;
import org.apache.brooklyn.enricher.stock.AbstractTransformingEnricher;
import org.apache.brooklyn.util.core.flags.TypeCoercions;

/**
 * Converts an absolute sensor into a delta sensor (i.e. the diff between the current and previous value)
 */
@Catalog(name="Delta", description="Converts an absolute sensor into a delta sensor "
        + "(i.e. the diff between the current and previous value)")
public class DeltaEnricher extends AbstractTransformingEnricher {
    Number last = 0;

    public DeltaEnricher() { // for EnricherSpec and rebinding
    }
    
    /**
     * @deprecated since 0.12.0; use {@link EnricherSpec}
     */
    @Deprecated
    public DeltaEnricher(Entity producer, Sensor source, AttributeSensor target) {
        super(producer, source, target);
    }
    
    @Override
    public void onEvent(SensorEvent event) {
        Number current = elvis(event.getValue(), 0);
        double newVal = current.doubleValue() - last.doubleValue();
        entity.sensors().set((AttributeSensor)target, TypeCoercions.coerce(newVal, target.getTypeToken()));
        last = current;
    }
}