Interface PipelineStep

  • All Known Implementing Classes:
    ClassBasedStep, RemoteAction

    public interface PipelineStep
    An interface that describes the contract for a pipeline step.

    Each step will recieve one document at a time, and also the pipeline context, it can then work with that document and return it, or create a new document to return.

    • Method Detail

      • process

        Document process​(Document document,
                         PipelineContext context)
        The pipeline will call the process method, passing each document to the step. The step will then perform and actions and can return either the same document or a new document representing its result.

        It can also interact with the context if it wishes to work with the stores or other contextual information.

        Parameters:
        document - The document to process
        context - The pipeline's context
        Returns:
        The document after the steps actions
      • getName

        String getName()
        The name of the pipeline step
        Returns:
        a string representing the name