org.deltafi.actionkit.action.MetadataResult 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.Setter;
import org.deltafi.common.types.ActionContext;
import org.deltafi.common.types.ActionEventType;
import org.jetbrains.annotations.NotNull;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * A Result that may include changes to metadata
 */
@Getter
@Setter
@EqualsAndHashCode(callSuper = true)
public abstract class MetadataResult> extends Result {
    @Getter
    protected Map metadata = new HashMap<>();
    protected List deleteMetadataKeys = new ArrayList<>();

    public MetadataResult(@NotNull ActionContext context, @NotNull ActionEventType actionEventType) {
        super(context, actionEventType);
    }

    /**
     * Add metadata by key and value Strings
     * @param key Metadata key to add
     * @param value Metadata value to add
     */
    public void addMetadata(@NotNull String key, @NotNull String value) {
        metadata.put(key, value);
    }

    /**
     * Add metadata by map
     * @param map Key-value pairs to add to metadata
     */
    @SuppressWarnings("unused")
    public void addMetadata(Map map) {
        if (map != null) {
            metadata.putAll(map);
        }
    }

    /**
     * Add metadata by key/value map, prefixing each key with a fixed string
     * @param map String pairs to add to metadata
     * @param prefix String to prepend to each key before adding to metadata
     */
    @SuppressWarnings("unused")
    public void addMetadata(Map map, String prefix) {
        if (map != null) {
            final String usePrefix = prefix != null ? prefix : "";
            map.forEach((key, value) -> metadata.put(usePrefix + key, value));
        }
    }

    @SuppressWarnings("unused")
    public void deleteMetadataKey(@NotNull String key) {
        deleteMetadataKeys.add(key);
    }
}