PepperImpl (pepper-framework 3.3.4 API)

java.lang.Object
- org.corpus_tools.pepper.core.PepperImpl

All Implemented Interfaces:: Pepper

public class PepperImpl
extends Object
implements Pepper

Constructor Summary

Constructors
Constructor and Description

PepperImpl()

Constructors
Constructor and Description
`PepperImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Collection<ModuleFitness>`	`checkFitness()` Checks the fitness of each registered Pepper module.
`void`	`cleanUp()` Cleans up current workspace.
`String`	`createJob()` Creates a new `PepperJob` object for a new conversion process.
`Set<String>`	`findAppropriateImporters(org.eclipse.emf.common.util.URI corpusPath)` Returns the names of importers which can import the data located at the specified `corpusPath`.
`PepperConfiguration`	`getConfiguration()` Returns set configuration for `Pepper`.
`PepperJob`	`getJob(String id)` Returns a `PepperJob` corresponding to the passed id.
`Set<String>`	`getJobIds()` Return identifiers of all registered `PepperJobImpl` objects.
`File`	`getLocation(String id)` Returns the location of a job.
`ModuleResolver`	`getModuleResolver()` Returns the set `ModuleResolverImpl` object, to resolve `PepperModule` objects.
`PepperJobImpl`	`getPepperJobImpl(String id)`
`Collection<PepperModuleDesc>`	`getRegisteredImporters()` Returns all `PepperModuleDesc` corresponding to a registered importer.
`Collection<PepperModuleDesc>`	`getRegisteredModules()` Returns a collection of all `PepperModuleDesc` corresponding to Pepper modules, which are registered in this `Pepper` instance.
`String`	`getRegisteredModulesAsString()` Returns a string representation of the method `Pepper.getRegisteredModules()`.
`boolean`	`removeJob(String id)` Removes the `PepperJob` corresponding to the passed identifier, if a job exists.
`Collection<String>`	`selfTest()` Checks if the Pepper framework is ready to run.
`void`	`setConfiguration(PepperConfiguration configuration)` Sets the configuration for `Pepper`.
`void`	`setModuleResolver(ModuleResolver moduleResolver)` Sets a `ModuleResolverImpl` object to resolve `PepperModule` objects for Pepper jobs.
`String`	`toString()` Returns a string representation of this object.
`void`	`unsetModuleResolver(ModuleResolver moduleResolver)` Unsets the `ModuleResolverImpl` reference.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PepperImpl
```
public PepperImpl()
```
- Method Detail
  - getConfiguration
```
public PepperConfiguration getConfiguration()
```
    Description copied from interface: Pepper
    
    Returns set configuration for Pepper.
    
    Specified by:
    
    getConfiguration in interface Pepper
    
    Returns:
  - setConfiguration
```
public void setConfiguration(PepperConfiguration configuration)
```
    Description copied from interface: Pepper
    
    Sets the configuration for Pepper.
    
    Specified by:
    
    setConfiguration in interface Pepper
  - findAppropriateImporters
```
public Set<String> findAppropriateImporters(org.eclipse.emf.common.util.URI corpusPath)
                                     throws FileNotFoundException
```
    Description copied from interface: Pepper
    
    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.
    
    Specified by:
    
    findAppropriateImporters in interface Pepper
    
    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
```
public String createJob()
```
    Description copied from interface: Pepper
    
    Creates a new PepperJob object for a new conversion process.
    
    Specified by:
    
    createJob in interface Pepper
    
    Returns:
    
    identifier of the new created PepperJob
  - getJobIds
```
public Set<String> getJobIds()
```
    Return identifiers of all registered PepperJobImpl objects.
    
    Returns:
    
    a list of all job identifiers
  - getJob
```
public PepperJob getJob(String id)
                 throws JobNotFoundException
```
    Description copied from interface: Pepper
    
    Returns a PepperJob corresponding to the passed id.
    
    Specified by:
    
    getJob in interface Pepper
    
    Parameters:
    
    id - identifier of a PepperJob
    
    Returns:
    
    a PepperJob corresponding to the passed id
    
    Throws:
    
    JobNotFoundException
  - getPepperJobImpl
```
public PepperJobImpl getPepperJobImpl(String id)
                               throws JobNotFoundException
```
    Throws:
    
    JobNotFoundException
  - removeJob
```
public boolean removeJob(String id)
                  throws JobNotFoundException
```
    Description copied from interface: Pepper
    
    Removes the PepperJob corresponding to the passed identifier, if a job exists.
    
    Specified by:
    
    removeJob in interface Pepper
    
    Parameters:
    
    id - identifier of a PepperJob
    
    Returns:
    
    true, if job was removed successfully, false otherwise
    
    Throws:
    
    JobNotFoundException
  - getLocation
```
public File getLocation(String id)
                 throws JobNotFoundException
```
    Returns the location of a job.
    
    Parameters:
    
    id -
    
    Returns:
    
    Throws:
    
    JobNotFoundException
  - cleanUp
```
public void cleanUp()
```
    Cleans up current workspace. Removes all non active jobs.
  - getRegisteredImporters
```
public Collection<PepperModuleDesc> getRegisteredImporters()
```
    Description copied from interface: Pepper
    
    Returns all PepperModuleDesc corresponding to a registered importer. When no importer is registered returns an empty collection, not null.
    
    Specified by:
    
    getRegisteredImporters in interface Pepper
    
    Returns:
    
    all importer fingerprints
  - getRegisteredModules
```
public Collection<PepperModuleDesc> getRegisteredModules()
```
    Description copied from interface: Pepper
    
    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.
    
    Specified by:
    
    getRegisteredModules in interface Pepper
    
    Returns:
    
    a collection of all PepperModuleDesc objects corresponding to Pepper modules
  - getModuleResolver
```
public ModuleResolver getModuleResolver()
```
    Returns the set ModuleResolverImpl object, to resolve PepperModule objects.
    
    Returns:
    
    set set ModuleResolverImpl object
  - setModuleResolver
```
public void setModuleResolver(ModuleResolver moduleResolver)
```
    Sets a ModuleResolverImpl object to resolve PepperModule objects for Pepper jobs.
    
    Parameters:
    
    moduleResolver - ModuleResolverImpl object to be used for jobs
  - unsetModuleResolver
```
public void unsetModuleResolver(ModuleResolver moduleResolver)
```
    Unsets the ModuleResolverImpl reference. This is necessary for OSGi declarative service.
  - checkFitness
```
public Collection<ModuleFitness> checkFitness()
```
    Description copied from interface: Pepper
    
    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.
    
    Specified by:
    
    checkFitness in interface Pepper
    
    Returns:
    
    a list of fitness entries, one per module, if no module is registered an empty list is returned
  - selfTest
```
public Collection<String> selfTest()
```
    Description copied from interface: Pepper
    
    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.
    
    Specified by:
    
    selfTest in interface Pepper
    
    Returns:
    
    returns an empty list, if check was positive; if list is not empty, each entry describes a single problem.
  - getRegisteredModulesAsString
```
public String getRegisteredModulesAsString()
```
    Description copied from interface: Pepper
    
    Returns a string representation of the method Pepper.getRegisteredModules().
    
    Specified by:
    
    getRegisteredModulesAsString in interface Pepper
    
    Returns:
    
    a string representation of all registered modules
  - toString
```
public String toString()
```
    Returns a string representation of this object. Note: This representation cannot be used for serialization/deserialization purposes.
    
    Overrides:
    
    toString in class Object

Class PepperImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PepperImpl

Method Detail

getConfiguration

setConfiguration

findAppropriateImporters

createJob

getJobIds

getJob

getPepperJobImpl

removeJob

getLocation

cleanUp

getRegisteredImporters

getRegisteredModules

getModuleResolver

setModuleResolver

unsetModuleResolver

checkFitness

selfTest

getRegisteredModulesAsString

toString