co.cask.wrangler.api.RecipePipeline Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wrangler-api Show documentation

Wrangler API Libaray.

There is a newer version: 3.2.2

/*
 * Copyright © 2016 Cask Data, Inc.
 *
 * 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 co.cask.wrangler.api;

import co.cask.cdap.api.data.schema.Schema;
import co.cask.wrangler.api.annotations.PublicEvolving;

import java.io.Serializable;
import java.util.List;

/**
 * {@link RecipePipeline} executes array of {@link Executor} in the order they are specified.
 */
@PublicEvolving
public interface RecipePipeline extends Serializable {
  /**
   * Initializes the wrangle pipeline using the directives.
   *
   * @param directives Wrangle directives.
   * @param context
   */
  void initialize(RecipeParser directives, ExecutorContext context) throws RecipeException;

  /**
   * Executes the pipeline on the input.
   *
   * @param input List of Input record of type I.
   * @param schema Schema to which the output should be mapped.
   * @return Parsed output list of record of type O
   */
  List execute(List input, Schema schema) throws RecipeException;

  /**
   * Executes the pipeline on the input.
   *
   * @param input List of input record of type I.
   * @return Parsed output list of record of type I
   */
  List execute(List input) throws RecipeException;

  /**
   * Returns records that are errored out.
   *
   * @return records that have errored out.
   */
  List errors();

  /**
   * Destroys the pipeline.
   */
  void destroy();
}