Module es.uvigo.esei.sing.textproc.step
Package es.uvigo.esei.sing.textproc.step

Interface ProcessingStepService

All Known Implementing Classes:
AbstractTppProcessingStepService
public interface ProcessingStepService
Specifies the contract of any processing step service, which allows it to integrate with the application in an extensible manner.
Author:
Alejandro González García
See Also:
AbstractProcessingStep

  • Method Summary

    Modifier and Type Method Description
    AbstractProcessingStep create()
    Returns a new instance of the processing step contained by this service, which implements AbstractProcessingStep.
    java.util.Set<java.lang.Class<? extends AbstractProcessingStepParameter>> getAdditionalParameters()
    Returns a set with every additional processing step parameter used by the processing step contained in this service.
    java.lang.String getName()
    Returns the unique name of the processing step represented by this service.
    java.util.Set<java.lang.Class<? extends ProcessedDocument>> getProcessedDocumentTypes()
    Returns a set with every additional processed document types that the processing step contained in this service creates in the database.

  • Method Details

    • create

      AbstractProcessingStep create()
      Returns a new instance of the processing step contained by this service, which implements AbstractProcessingStep. No unchecked exceptions can be thrown by this method.
      Returns:
      The described instance. It must not be null.

    • getName

      java.lang.String getName()
      Returns the unique name of the processing step represented by this service. No unchecked exceptions can be thrown by this method.
      Returns:
      The described name. It must not be null.

    • getAdditionalParameters

      java.util.Set<java.lang.Class<? extends AbstractProcessingStepParameter>> getAdditionalParameters()
      Returns a set with every additional processing step parameter used by the processing step contained in this service. No unchecked exceptions can be thrown by this method.
      Returns:
      The described set. It can be empty and unmodifiable, but it must not be null, and not contain null elements.

    • getProcessedDocumentTypes

      java.util.Set<java.lang.Class<? extends ProcessedDocument>> getProcessedDocumentTypes()
      Returns a set with every additional processed document types that the processing step contained in this service creates in the database. No unchecked exceptions can be thrown by this method.
      Returns:
      The described set. It can be empty and unmodifiable, but it must not be null, and not contain null elements.