io.annot8.api.pipelines.Pipeline 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.Processor;
import io.annot8.api.components.Resource;
import io.annot8.api.components.Source;
import io.annot8.api.components.responses.ProcessorResponse;
import io.annot8.api.components.responses.SourceResponse;
import io.annot8.api.context.Context;
import io.annot8.api.data.Item;
import io.annot8.api.data.ItemFactory;
import java.io.Closeable;
import java.util.Collection;

public interface Pipeline extends Closeable {

  String getName();

  String getDescription();

  Context getContext();

  Collection getSources();

  Collection getProcessors();

  ErrorConfiguration getErrorConfiguration();

  SourceResponse read(ItemFactory itemFactory);

  ProcessorResponse process(Item item);

  interface Builder {

    Builder from(PipelineDescriptor pipelineDescriptor);

    Builder withName(String name);

    Builder withDescription(String description);

    Builder withSource(Source source);

    Builder withProcessor(Processor processor);

    Builder withResource(Resource resource);

    Builder withContext(Context context);

    Builder withErrorConfiguration(ErrorConfiguration errorConfiguration);

    Pipeline build();
  }
}