org.pragmaticminds.crunch.events.GenericEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of crunch-api Show documentation
Programing Interfaces for other CRUNCH Projects.
The newest version!
/*
 * 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.pragmaticminds.crunch.events;

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
import lombok.ToString;
import org.pragmaticminds.crunch.api.values.dates.Value;

import javax.management.openmbean.InvalidKeyException;
import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;

/**
 * Represents an GenericEvent coming from a Machine, a Mixer or somewhere else.
 * Events are (effectively) immutable Data transfer Objects (DTO's) that can also be stored in the database
 * thus they are annotated with @{@link javax.persistence.Entity}.
 * They cannot be absolutely immutable due to JPA.
 * 
 * Events should only be created using a Builder {@link GenericEventBuilder}.
 *
 * An GenericEvent consists of
 *  - timestamp (of the events beginning)
 *  - eventName (Category of the GenericEvent like "machine.cycle", "mixer.cycle", ...).
 *  - parameters (additional parameters to the value).
 *
 * Nested Parameter Values are given as "flattened" json like schema, if you have eg, a submap
 * 
 *     "code" -> 1
 *     "parameters.param1" -> 3.1
 *     "parameters.param2" -> 44123123
 * 
 *
 * @author julian
 * @author kerstin
 * Created by julian on 12.11.17
 */
@ToString
@NoArgsConstructor
@EqualsAndHashCode
@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, setterVisibility = JsonAutoDetect.Visibility.NONE)
public class GenericEvent implements Event, Serializable {

    private Long timestamp;

    private String eventName;

    /**
     * Name of the events source.
     */
    private String eventSource;

    private HashMap parameters;


    public GenericEvent(long timestamp, String eventName, String source, Map parameters) {
        this.timestamp = timestamp;
        this.eventName = eventName;
        this.eventSource = source;
        this.parameters = parameters == null ? new HashMap<>() : new HashMap<>(parameters);
    }

    public GenericEvent(long timestamp, String eventName, String source) {
        this.timestamp = timestamp;
        this.eventName = eventName;
        this.eventSource = source;
        this.parameters = new HashMap<>();
    }

    public GenericEvent(GenericEvent other) {
        this.timestamp = other.timestamp;
        this.eventName = other.eventName;
        this.eventSource = other.eventSource;
        this.parameters = other.parameters;
    }

    public GenericEvent(UntypedEvent other) {
        this.eventName = other.getEventName();
        this.eventSource = other.getEventSource();
        this.timestamp = other.getTimestamp();
        this.parameters = new HashMap<>();
        other.getParameters().forEach((key, value)->
                this.parameters.put(key, Value.of(value))
        );
    }

    public Value getParameter(String parameter) {
        if (!parameters.containsKey(parameter)) {
            throw new InvalidKeyException("No parameter with name \"" + parameter + "\" present in the GenericEvent.");
        }
        return parameters.get(parameter);
    }

    /**
     * Setter used to set the soruce in the (already generated) event.
     *
     * @param eventSource source name.
     */
    public void setEventSource(String eventSource) {
        this.eventSource = eventSource;
    }

    public String getSource() {
        return this.eventSource;
    }

    public long getTimestamp() {
        return this.timestamp;
    }

    public String getEventName() {
        return eventName;
    }

    public void setEventName(String eventName) {
        this.eventName = eventName;
    }

    public Map getParameters() {
        return parameters;
    }

    public void setParameters(Map parameters) {
        this.parameters = parameters == null ? new HashMap<>() : new HashMap<>(parameters);
    }
}