Package org.corpus_tools.pepper.common

Interface Pepper

  • All Known Implementing Classes:
    PepperImpl
    public interface Pepper
    Author:
    Florian Zipser

    • Method Detail

      • setConfiguration

        void setConfiguration​(PepperConfiguration configuration)
        Sets the configuration for Pepper.
        Parameters:
        configuration -

      • findAppropriateImporters

        Set<String> findAppropriateImporters​(org.eclipse.emf.common.util.URI corpusPath)
                              throws FileNotFoundException
        Returns the names of importers which can import the data located at the specified corpusPath. If no importer was found for importing the returned list is empty, not null.
        Parameters:
        corpusPath - the path which should be checked by each importer
        Returns:
        names of importers how can import the data located at corpusPath
        Throws:
        FileNotFoundException

      • createJob

        String createJob()
        Creates a new PepperJob object for a new conversion process.
        Returns:
        identifier of the new created PepperJob

      • getRegisteredImporters

        Collection<PepperModuleDesc> getRegisteredImporters()
        Returns all PepperModuleDesc corresponding to a registered importer. When no importer is registered returns an empty collection, not null.
        Returns:
        all importer fingerprints

      • getRegisteredModules

        Collection<PepperModuleDesc> getRegisteredModules()
        Returns a collection of all PepperModuleDesc corresponding to Pepper modules, which are registered in this Pepper instance.
        Note: Depending on the implementation, the computation of this result, can take a time. It could be useful, to store the returned list in case of multiple calls.
        Returns:
        a collection of all PepperModuleDesc objects corresponding to Pepper modules

      • getRegisteredModulesAsString

        String getRegisteredModulesAsString()
        Returns a string representation of the method getRegisteredModules().
        Returns:
        a string representation of all registered modules

      • selfTest

        @Deprecated
Collection<String> selfTest()
        Deprecated.
        Checks if the Pepper framework is ready to run. This means, it checks if everything necessary is given and if all registered modules could be ran. This method can be used as a kind of integration test.
        Returns:
        returns an empty list, if check was positive; if list is not empty, each entry describes a single problem.

      • checkFitness

        Collection<ModuleFitness> checkFitness()
        Checks the fitness of each registered Pepper module. The fitness of a module indicates in what way a module is docking to the Pepper interface. For instance it checks whether a module provides a contact address of the module'supplier. Or when the module is an importer whether it supports the PepperImporterImpl.isImportable(URI) method.
        Further the fitness says whether a module is ready to start.
        Returns:
        a list of fitness entries, one per module, if no module is registered an empty list is returned