org.deltafi.actionkit.action.Result Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deltafi-action-kit Show documentation

DeltaFi Action Kit - Action implementation SDK for DeltaFi actions

There is a newer version: 2.0-rc2

/*
 *    DeltaFi - Data transformation and enrichment platform
 *
 *    Copyright 2021-2023 DeltaFi Contributors 
 *
 *    Licensed 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.deltafi.actionkit.action;

import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.RequiredArgsConstructor;
import org.deltafi.common.types.ActionContext;
import org.deltafi.common.types.ActionEvent;
import org.deltafi.common.types.ActionEventType;
import org.deltafi.common.types.Metric;
import org.jetbrains.annotations.NotNull;

import java.time.OffsetDateTime;
import java.util.ArrayList;
import java.util.List;

/**
 * Base class for all action results.  Specializations of the Result class are provided for each action type.
 */
@RequiredArgsConstructor
@EqualsAndHashCode
@Getter
public abstract class Result> implements ResultType {
    protected final ActionContext context;
    protected final ActionEventType actionEventType;

    protected final ArrayList metrics = new ArrayList<>();

    /**
     * @return action event summary object based on the action context
     */
    public ActionEvent toEvent() {
        return ActionEvent.builder()
                .type(actionEventType)
                .action(context.getFlow() + "." + context.getName())
                .did(context.getDid())
                .start(context.getStartTime())
                .stop(OffsetDateTime.now())
                .metrics(getCustomMetrics())
                .build();
    }

    /**
     * Return a list of custom metrics
     * @return collection of Metric objects
     */
    public List getCustomMetrics() {
        return metrics;
    }

    /**
     * Add a custom metric to the result
     * @param metric Metric object to add to the list of custom metrics in the result
     * @return this instance of Result base class
     */
    public T add(@NotNull Metric metric) {
        metrics.add(metric);
        //noinspection unchecked
        return (T) this;
    }

}