io.annot8.api.pipelines.PipelineDescriptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of annot8-api Show documentation
Core API interfaces for the Annot8 project
There is a newer version: 1.2
/* Annot8 (annot8.io) - Licensed under Apache-2.0. */
package io.annot8.api.pipelines;

import io.annot8.api.components.ProcessorDescriptor;
import io.annot8.api.components.SourceDescriptor;
import io.annot8.api.exceptions.IncompleteException;
import io.annot8.api.helpers.WithDescription;
import io.annot8.api.helpers.WithName;
import java.util.Collection;

/**
 * Describes a pipeline, which is a collection of ordered sources and processors.
 *
 * The ordering is implementation dependent (i.e. an implementation may return processors in the
 * order they were added, or in the order that makes sense based on their capabilities)
 */
public interface PipelineDescriptor extends WithName, WithDescription {
  /**
   * Return an ordered list of {@link SourceDescriptor}s describing the sources that will feed data
   * into the pipeline
   *
   * @return sources
   */
  Collection getSources();

  /**
   * Return an ordered list of {@link ProcessorDescriptor}s describing the processers that will
   * process data in the pipeline
   *
   * @return processors
   */
  Collection getProcessors();

  /**
   * Return the error configuration that will be used with this pipeline
   *
   * @return error configuration
   */
  ErrorConfiguration getErrorConfiguration();

  /** Builder interface for building new pipeline descriptors */
  interface Builder {
    /**
     * Add sources and processors from an existing pipeline descriptor to the one being built
     *
     * @param pipelineDescriptor descriptor to use as basis for the pipeline
     * @return builder
     */
    PipelineDescriptor.Builder from(PipelineDescriptor pipelineDescriptor);

    /**
     * Set the name of the pipeline
     *
     * @param name pipeline's name
     * @return builder
     */
    PipelineDescriptor.Builder withName(String name);

    /**
     * Set a description of the pipeline
     *
     * @param description pipeline's description
     * @return builder
     */
    PipelineDescriptor.Builder withDescription(String description);

    /**
     * Set an orderer to order components
     *
     * @param orderer pipeline orderer to use
     * @return builder
     */
    PipelineDescriptor.Builder withOrderer(PipelineOrderer orderer);

    /**
     * Add a source to the pipeline that is being built
     *
     * @param source source to add
     * @return builder
     */
    PipelineDescriptor.Builder withSource(SourceDescriptor source);

    /**
     * Add a processor to the pipeline that is being built
     *
     * @param processor processor to add
     * @return builder
     */
    PipelineDescriptor.Builder withProcessor(ProcessorDescriptor processor);

    /**
     * Set the error configuration for the pipeline
     *
     * @param errorConfiguration error configuration to use
     * @return builder
     */
    PipelineDescriptor.Builder withErrorConfiguration(ErrorConfiguration errorConfiguration);

    /**
     * Add multiple sources to the pipeline that is being built, in the order provided
     *
     * @param sources sources to add
     * @return builder
     */
    default PipelineDescriptor.Builder withSources(SourceDescriptor... sources) {
      for (SourceDescriptor source : sources) withSource(source);

      return this;
    }

    /**
     * Add multiple sources to the pipeline that is being built, in the order provided
     *
     * @param sources sources to add
     * @return builder
     */
    default PipelineDescriptor.Builder withSources(Collection sources) {
      sources.forEach(this::withSource);
      return this;
    }

    /**
     * Add multiple processors to the pipeline that is being built, in the order provided
     *
     * @param processors processors to add
     * @return builder
     */
    default PipelineDescriptor.Builder withProcessors(ProcessorDescriptor... processors) {
      for (ProcessorDescriptor processor : processors) withProcessor(processor);

      return this;
    }

    /**
     * Add multiple processors to the pipeline that is being built, in the order provided
     *
     * @param processors processors to add
     * @return builder
     */
    default PipelineDescriptor.Builder withProcessors(Collection processors) {
      processors.forEach(this::withProcessor);
      return this;
    }

    /**
     * Build the pipeline descriptor described by this builder
     *
     * @throws IncompleteException If the pipeline is missing components (i.e. doesn't have at least
     *     1 source and processor)
     * @return pipeline descriptor
     */
    PipelineDescriptor build() throws IncompleteException;
  }
}