Pepper
3.6.0
A highly extensible plattform for conversion and manipulationoflinguisticdata.
|
Inherited by org.corpus_tools.pepper.connectors.impl.PepperOSGiConnector, org.corpus_tools.pepper.connectors.PepperConnector, and org.corpus_tools.pepper.core.PepperImpl.
Public Member Functions | |
PepperConfiguration | getConfiguration () |
Returns set configuration for Pepper. More... | |
void | setConfiguration (PepperConfiguration configuration) |
Sets the configuration for Pepper. More... | |
Set< String > | findAppropriateImporters (final URI corpusPath) throws FileNotFoundException |
Returns the names of importers which can import the data located at the specified corpusPath . More... | |
String | createJob () |
Creates a new PepperJob object for a new conversion process. More... | |
PepperJob | getJob (String id) throws JobNotFoundException |
Returns a PepperJob corresponding to the passed id. More... | |
boolean | removeJob (String id) throws JobNotFoundException |
Removes the PepperJob corresponding to the passed identifier, if a job exists. More... | |
Collection< PepperModuleDesc > | getRegisteredImporters () |
Returns all PepperModuleDesc corresponding to a registered importer. More... | |
Collection< PepperModuleDesc > | getRegisteredModules () |
Returns a collection of all PepperModuleDesc corresponding to Pepper modules, which are registered in this Pepper instance. More... | |
String | getRegisteredModulesAsString () |
Returns a string representation of the method getRegisteredModules(). More... | |
Collection< String > | selfTest () |
Checks if the Pepper framework is ready to run. More... | |
Collection< ModuleFitness > | checkFitness () |
Checks the fitness of each registered Pepper module. More... | |
Collection<ModuleFitness> org.corpus_tools.pepper.common.Pepper.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.
Implemented in org.corpus_tools.pepper.connectors.impl.PepperOSGiConnector, and org.corpus_tools.pepper.core.PepperImpl.
String org.corpus_tools.pepper.common.Pepper.createJob | ( | ) |
Creates a new PepperJob object for a new conversion process.
Implemented in org.corpus_tools.pepper.connectors.impl.PepperOSGiConnector, and org.corpus_tools.pepper.core.PepperImpl.
Set<String> org.corpus_tools.pepper.common.Pepper.findAppropriateImporters | ( | final 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.
corpusPath | the path which should be checked by each importer |
corpusPath
Implemented in org.corpus_tools.pepper.core.PepperImpl.
PepperConfiguration org.corpus_tools.pepper.common.Pepper.getConfiguration | ( | ) |
Returns set configuration for Pepper.
Implemented in org.corpus_tools.pepper.connectors.impl.PepperOSGiConnector, and org.corpus_tools.pepper.core.PepperImpl.
PepperJob org.corpus_tools.pepper.common.Pepper.getJob | ( | String | id | ) | throws JobNotFoundException |
Returns a PepperJob corresponding to the passed id.
id | identifier of a PepperJob |
Implemented in org.corpus_tools.pepper.connectors.impl.PepperOSGiConnector, and org.corpus_tools.pepper.core.PepperImpl.
Collection<PepperModuleDesc> org.corpus_tools.pepper.common.Pepper.getRegisteredImporters | ( | ) |
Returns all PepperModuleDesc corresponding to a registered importer.
When no importer is registered returns an empty collection, not null.
Implemented in org.corpus_tools.pepper.connectors.impl.PepperOSGiConnector, and org.corpus_tools.pepper.core.PepperImpl.
Collection<PepperModuleDesc> org.corpus_tools.pepper.common.Pepper.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.
Implemented in org.corpus_tools.pepper.connectors.impl.PepperOSGiConnector, and org.corpus_tools.pepper.core.PepperImpl.
String org.corpus_tools.pepper.common.Pepper.getRegisteredModulesAsString | ( | ) |
Returns a string representation of the method getRegisteredModules().
Implemented in org.corpus_tools.pepper.connectors.impl.PepperOSGiConnector, and org.corpus_tools.pepper.core.PepperImpl.
boolean org.corpus_tools.pepper.common.Pepper.removeJob | ( | String | id | ) | throws JobNotFoundException |
Removes the PepperJob corresponding to the passed identifier, if a job exists.
id | identifier of a PepperJob |
JobNotFoundException |
Implemented in org.corpus_tools.pepper.connectors.impl.PepperOSGiConnector, and org.corpus_tools.pepper.core.PepperImpl.
Collection<String> org.corpus_tools.pepper.common.Pepper.selfTest | ( | ) |
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.
Implemented in org.corpus_tools.pepper.connectors.impl.PepperOSGiConnector, and org.corpus_tools.pepper.core.PepperImpl.
void org.corpus_tools.pepper.common.Pepper.setConfiguration | ( | PepperConfiguration | configuration | ) |
Sets the configuration for Pepper.
configuration |
Implemented in org.corpus_tools.pepper.connectors.impl.PepperOSGiConnector, and org.corpus_tools.pepper.core.PepperImpl.