org.corpus_tools.pepper.common.Pepper Interface Reference

Public Member Functions
PepperConfiguration	getConfiguration ()
	Returns set configuration for Pepper.
void	setConfiguration (PepperConfiguration configuration)
	Sets the configuration for Pepper.
Set< String >	findAppropriateImporters (final URI corpusPath) throws FileNotFoundException
	Returns the names of importers which can import the data located at the specified corpusPath.
String	createJob ()
	Creates a new PepperJob object for a new conversion process.
PepperJob	getJob (String id) throws JobNotFoundException
	Returns a PepperJob corresponding to the passed id.
boolean	removeJob (String id) throws JobNotFoundException
	Removes the PepperJob corresponding to the passed identifier, if a job exists.
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 getRegisteredModules().
Collection< String >	selfTest ()
	Checks if the Pepper framework is ready to run.
Collection< ModuleFitness >	checkFitness ()
	Checks the fitness of each registered Pepper module.

Detailed Description

Author

Florian Zipser

Member Function Documentation

checkFitness()

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.

Returns

a list of fitness entries, one per module, if no module is registered an empty list is returned

createJob()

String org.corpus_tools.pepper.common.Pepper.createJob

(

)

Creates a new PepperJob object for a new conversion process.

Returns

identifier of the new created PepperJob

findAppropriateImporters()

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.

Parameters

corpusPath

the path which should be checked by each importer

Returns

names of importers how can import the data located at corpusPath

getConfiguration()

PepperConfiguration org.corpus_tools.pepper.common.Pepper.getConfiguration

(

)

Returns set configuration for Pepper.

Returns

getJob()

PepperJob org.corpus_tools.pepper.common.Pepper.getJob

(

String

id

)

throws JobNotFoundException

Returns a PepperJob corresponding to the passed id.

Parameters

id	identifier of a PepperJob

Returns

a PepperJob corresponding to the passed id

getRegisteredImporters()

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.

Returns

all importer fingerprints

getRegisteredModules()

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.

Returns

a collection of all PepperModuleDesc objects corresponding to Pepper modules

getRegisteredModulesAsString()

String org.corpus_tools.pepper.common.Pepper.getRegisteredModulesAsString

(

)

Returns a string representation of the method getRegisteredModules().

Returns

a string representation of all registered modules

removeJob()

boolean org.corpus_tools.pepper.common.Pepper.removeJob

(

String

id

)

throws JobNotFoundException

Removes the PepperJob corresponding to the passed identifier, if a job exists.

Parameters

id	identifier of a PepperJob

Returns

true, if job was removed successfully, false otherwise

Exceptions

JobNotFoundException

selfTest()

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.

Returns

returns an empty list, if check was positive; if list is not empty, each entry describes a single problem.

setConfiguration()

void org.corpus_tools.pepper.common.Pepper.setConfiguration

(

PepperConfiguration

configuration

)

Sets the configuration for Pepper.

Parameters

configuration