io.annot8.api.components.Source 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.components;

import io.annot8.api.components.responses.SourceResponse;
import io.annot8.api.data.ItemFactory;

/**
 * Base processor interface from which all sources extend.
 *
 * Sources read data from somewhere (e.g. a file system, or a database) and produce items that
 * will be processed by other components.
 */
public interface Source extends Annot8Component {

  /**
   * Read from the data source and return new items if found
   *
   * @param itemFactory factory used to create new items
   * @return status response
   */
  SourceResponse read(ItemFactory itemFactory);
}