Pepper
3.6.0
A highly extensible plattform for conversion and manipulationoflinguisticdata.
|
Inherits org.corpus_tools.pepper.common.Pepper.
Classes | |
class | JobEntry |
Public Member Functions | |
PepperConfiguration | getConfiguration () |
Returns set configuration for Pepper. More... | |
void | setConfiguration (PepperConfiguration configuration) |
Sets the configuration for Pepper. More... | |
Set< String > | findAppropriateImporters (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... | |
Set< String > | getJobIds () |
Return identifiers of all registered PepperJobImpl objects. More... | |
PepperJob | getJob (String id) throws JobNotFoundException |
Returns a PepperJob corresponding to the passed id. More... | |
PepperJobImpl | getPepperJobImpl (String id) throws JobNotFoundException |
{@inheritDoc Pepper::getJob(String)} | |
boolean | removeJob (String id) throws JobNotFoundException |
Removes the PepperJob corresponding to the passed identifier, if a job exists. More... | |
File | getLocation (String id) throws JobNotFoundException |
Returns the location of a job. More... | |
void | cleanUp () |
Cleans up current workspace. 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... | |
ModuleResolver | getModuleResolver () |
Returns the set ModuleResolverImpl object, to resolve PepperModule objects. More... | |
void | setModuleResolver (ModuleResolver moduleResolver) |
Sets a ModuleResolverImpl object to resolve PepperModule objects for Pepper jobs. More... | |
void | unsetModuleResolver (ModuleResolver moduleResolver) |
Unsets the ModuleResolverImpl reference. More... | |
Collection< ModuleFitness > | checkFitness () |
Checks the fitness of each registered Pepper module. More... | |
Collection< String > | selfTest () |
Checks if the Pepper framework is ready to run. More... | |
String | getRegisteredModulesAsString () |
Returns a string representation of the method getRegisteredModules(). More... | |
String | toString () |
Returns a string representation of this object. More... | |
Collection<ModuleFitness> org.corpus_tools.pepper.core.PepperImpl.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.
Implements org.corpus_tools.pepper.common.Pepper.
void org.corpus_tools.pepper.core.PepperImpl.cleanUp | ( | ) |
Cleans up current workspace.
Removes all non active jobs.
String org.corpus_tools.pepper.core.PepperImpl.createJob | ( | ) |
Creates a new PepperJob object for a new conversion process.
Implements org.corpus_tools.pepper.common.Pepper.
Set<String> org.corpus_tools.pepper.core.PepperImpl.findAppropriateImporters | ( | 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
Implements org.corpus_tools.pepper.common.Pepper.
PepperConfiguration org.corpus_tools.pepper.core.PepperImpl.getConfiguration | ( | ) |
PepperJob org.corpus_tools.pepper.core.PepperImpl.getJob | ( | String | id | ) | throws JobNotFoundException |
Returns a PepperJob corresponding to the passed id.
id | identifier of a PepperJob |
Implements org.corpus_tools.pepper.common.Pepper.
Set<String> org.corpus_tools.pepper.core.PepperImpl.getJobIds | ( | ) |
Return identifiers of all registered PepperJobImpl objects.
File org.corpus_tools.pepper.core.PepperImpl.getLocation | ( | String | id | ) | throws JobNotFoundException |
Returns the location of a job.
id |
JobNotFoundException |
ModuleResolver org.corpus_tools.pepper.core.PepperImpl.getModuleResolver | ( | ) |
Returns the set ModuleResolverImpl object, to resolve PepperModule objects.
Collection<PepperModuleDesc> org.corpus_tools.pepper.core.PepperImpl.getRegisteredImporters | ( | ) |
Returns all PepperModuleDesc corresponding to a registered importer.
When no importer is registered returns an empty collection, not null.
Implements org.corpus_tools.pepper.common.Pepper.
Collection<PepperModuleDesc> org.corpus_tools.pepper.core.PepperImpl.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.
Implements org.corpus_tools.pepper.common.Pepper.
String org.corpus_tools.pepper.core.PepperImpl.getRegisteredModulesAsString | ( | ) |
Returns a string representation of the method getRegisteredModules().
Implements org.corpus_tools.pepper.common.Pepper.
boolean org.corpus_tools.pepper.core.PepperImpl.removeJob | ( | String | id | ) | throws JobNotFoundException |
Removes the PepperJob corresponding to the passed identifier, if a job exists.
id | identifier of a PepperJob |
JobNotFoundException |
Implements org.corpus_tools.pepper.common.Pepper.
Collection<String> org.corpus_tools.pepper.core.PepperImpl.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.
Implements org.corpus_tools.pepper.common.Pepper.
void org.corpus_tools.pepper.core.PepperImpl.setConfiguration | ( | PepperConfiguration | configuration | ) |
Sets the configuration for Pepper.
configuration |
Implements org.corpus_tools.pepper.common.Pepper.
void org.corpus_tools.pepper.core.PepperImpl.setModuleResolver | ( | ModuleResolver | moduleResolver | ) |
Sets a ModuleResolverImpl object to resolve PepperModule objects for Pepper jobs.
moduleResolver | ModuleResolverImpl object to be used for jobs |
String org.corpus_tools.pepper.core.PepperImpl.toString | ( | ) |
Returns a string representation of this object.
Note: This representation cannot be used for serialization/deserialization purposes.
void org.corpus_tools.pepper.core.PepperImpl.unsetModuleResolver | ( | ModuleResolver | moduleResolver | ) |
Unsets the ModuleResolverImpl reference.
This is necessary for OSGi declarative service.