org.deltafi.actionkit.action.load.LoadAction Maven / Gradle / Ivy

Go to download
/**
 *    DeltaFi - Data transformation and enrichment platform
 *
 *    Copyright 2022 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.load;

import org.deltafi.actionkit.action.parameters.ActionParameters;
import org.deltafi.common.types.ActionContext;
import org.deltafi.common.types.Content;
import org.deltafi.common.types.DeltaFile;
import org.deltafi.common.types.SourceInfo;
import org.jetbrains.annotations.NotNull;

import java.util.Map;

/**
 * Base class for a LOAD action that will not process multi-part content, but needs to extend
 * ActionParameters for configuration
 *
 * @see SimpleLoadAction
 * @see MultipartLoadAction
 * @see SimpleMultipartLoadAction
 */
public abstract class LoadAction extends LoadActionBase
 {
    public LoadAction(Class actionParametersClass, String description) {
        super(actionParametersClass, description);
    }

    @Override
    protected final LoadResultType execute(@NotNull DeltaFile deltaFile,
                                           @NotNull ActionContext context,
                                           @NotNull P params) {
        return load(context,
                params,
                deltaFile.getSourceInfo(),
                deltaFile.getLastProtocolLayerContent().get(0),
                deltaFile.getLastProtocolLayerMetadataAsMap());
    }

    /**
     * Implements the load execution function of a load action
     * @param context The action configuration context object for this action execution
     * @param params The parameter class that configures the behavior of this action execution
     * @param sourceInfo The source info for this action execution
     * @param content The content to be loaded by this action
     * @param metadata The metadata to be applied to this action
     * @return A result object containing results for the action execution.
     *         The result can be an ErrorResult, SplitResult, FilterResult, or LoadResult
     * @see LoadResult
     * @see org.deltafi.actionkit.action.error.ErrorResult
     * @see org.deltafi.actionkit.action.filter.FilterResult
     * @see SplitResult
     */
    public abstract LoadResultType load(@NotNull ActionContext context,
                                        @NotNull P params,
                                        @NotNull SourceInfo sourceInfo,
                                        @NotNull Content content,
                                        @NotNull Map metadata);
}