A B C D E F G H I J L M N O P R S T U V W X

A

AbstractPepperModuleException - Exception in org.corpus_tools.pepper.exceptions

This PepperException is thrown by PepperModules or PepperMapper objects.

AbstractPepperModuleException() - Constructor for exception org.corpus_tools.pepper.exceptions.AbstractPepperModuleException

AbstractPepperModuleException(String) - Constructor for exception org.corpus_tools.pepper.exceptions.AbstractPepperModuleException

AbstractPepperModuleException(String, Throwable) - Constructor for exception org.corpus_tools.pepper.exceptions.AbstractPepperModuleException

activate(ComponentContext) - Method in interface org.corpus_tools.pepper.core.ModuleResolver

Sets the ComponentContext of the OSGi environment the bundle was started in.

activate(ComponentContext) - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

Sets the ComponentContext of the OSGi environment the bundle was started in.

activate(ComponentContext) - Method in class org.corpus_tools.pepper.core.PepperOSGiRunner

Method is called by OSGi framework, when bundle is activated.

activate(ComponentContext) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

This method is called by OSGi framework and sets the component context, this class is running in.

activate(ComponentContext) - Method in class org.corpus_tools.pepper.modules.coreModules.DoNothingExporter

activate(ComponentContext) - Method in class org.corpus_tools.pepper.modules.coreModules.DoNothingManipulator

addFitnessFeature(ModuleFitness.FitnessFeature, boolean) - Method in class org.corpus_tools.pepper.common.ModuleFitness.ModuleFitnessBuilder

addFormatWhichShouldBeSupported(FormatDesc) - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperImExporterTest

Adds a format description to the list of formats which should be supported by the module to be tested.

addFormatWhichShouldBeSupported(String, String) - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperImExporterTest

Adds a format description to the list of formats which should be supported by the module to be tested.

addModuleControllers(ModuleControllerImpl) - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Adds a further ModuleControllerImpl to internal list of all ModuleControllerImpl objects, the here contained SDocument object has to pass.

addModuleControllers(ModuleControllerImpl) - Method in interface org.corpus_tools.pepper.modules.DocumentController

Adds a further ModuleControllerImpl to internal list of all ModuleControllerImpl objects, the here contained SDocument object has to pass.

addPepperExporterComponentFactory(ComponentFactory) - Method in interface org.corpus_tools.pepper.core.ModuleResolver

This method is called by OSGi framework and adds all registered ComponentFactory objects having the name PepperExporterComponentFactory to this object.

addPepperExporterComponentFactory(ComponentFactory) - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

This method is called by OSGi framework and adds all registered ComponentFactory objects having the name PepperExporterComponentFactory to this object.

addPepperImporterComponentFactory(ComponentFactory) - Method in interface org.corpus_tools.pepper.core.ModuleResolver

This method is called by OSGi framework and adds all registered ComponentFactory objects having the name PepperImporterComponentFactory to this object.

addPepperImporterComponentFactory(ComponentFactory) - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

This method is called by OSGi framework and adds all registered ComponentFactory objects having the name PepperImporterComponentFactory to this object.

addPepperManipulatorComponentFactory(ComponentFactory) - Method in interface org.corpus_tools.pepper.core.ModuleResolver

This method is called by OSGi framework and adds all registered ComponentFactory objects having the name PepperManipulatorComponentFactory to this object.

addPepperManipulatorComponentFactory(ComponentFactory) - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

This method is called by OSGi framework and adds all registered ComponentFactory objects having the name PepperManipulatorComponentFactory to this object.

addProgress(Double) - Method in class org.corpus_tools.pepper.impl.PepperMapperImpl

Adds the given progress to the already existing progress of the current handled SDocument or SCorpus object.

addProgress(Double) - Method in interface org.corpus_tools.pepper.modules.PepperMapper

Adds the given progress to the already existing progress of the current handled SDocument or SCorpus object.

addProperties(URI) - Method in class org.corpus_tools.pepper.modules.PepperModuleProperties

Loads the given file via Properties.load(java.io.InputStream) and adds all properties given in the passed Property object.

addProperty(PepperModuleProperty<?>) - Method in class org.corpus_tools.pepper.modules.PepperModuleProperties

Adds the given PepperModuleProperty object to the internal list.

addSLayers(SDocument, String) - Method in class org.corpus_tools.pepper.impl.BeforeAfterAction

Adds the passed layer to all nodes and objects in the passed SDocument.

addStep(StepDesc) - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Creates a new Step object containing all values of the passed StepDesc object and adds it to the workflow covered by this PepperJobImpl.

addStep(Step) - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Adds the passed Step object to the workflow covered by this PepperJobImpl object and tries to resolve the described PepperModule.

addStepDesc(StepDesc) - Method in class org.corpus_tools.pepper.common.PepperJob

Adds a StepDesc object to job.

addStepDesc(StepDesc) - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Overrides method PepperJob.addStepDesc(StepDesc), but calls it via super and than calls PepperJobImpl.addStep(Step).

addSupportedFormat(String, String, URI) - Method in class org.corpus_tools.pepper.common.PepperModuleDesc

Creates a new FormatDesc object containing the passed name, version and reference to the list of of FormatDesc objects describing all formats supported by the Pepper module, this object describes.

addSupportedFormat(String, String, URI) - Method in class org.corpus_tools.pepper.impl.PepperExporterImpl

addSupportedFormat(String, String, URI) - Method in class org.corpus_tools.pepper.impl.PepperImporterImpl

addSupportedFormat(String, String, URI) - Method in interface org.corpus_tools.pepper.modules.PepperExporter

addSupportedFormat(String, String, URI) - Method in interface org.corpus_tools.pepper.modules.PepperImporter

addSupportedFormat(FormatDesc) - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperImExporterTest

Deprecated.

use PepperImExporterTest.addFormatWhichShouldBeSupported(FormatDesc) or PepperImExporterTest.addFormatWhichShouldBeSupported(String, String) instead

after(SCorpusGraph) - Method in class org.corpus_tools.pepper.impl.BeforeAfterAction

Invokes an actions, after the mapping of an entire corpus structure was done.

after(Identifier) - Method in class org.corpus_tools.pepper.impl.BeforeAfterAction

Invokes actions, after the mapping of a corpus or document is done.

ALL_PROP_NAMES - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

This array contains all properties, which with the Pepper framework can be configured.

ARG_COMMAND_LINE_PARAMS - Static variable in class org.corpus_tools.pepper.core.PepperOSGiRunner

params passed to this application

ARG_SELFTEST - Static variable in class org.corpus_tools.pepper.core.PepperOSGiRunner

argument on command line call to determine, that pepper should make a self test

ATT_DEST_PATH - Static variable in class org.corpus_tools.pepper.core.PepperParamsReader

ATT_FORMAT_NAME - Static variable in class org.corpus_tools.pepper.core.PepperParamsReader

ATT_FORMAT_NAME - Static variable in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

ATT_FORMAT_VERSION - Static variable in class org.corpus_tools.pepper.core.PepperParamsReader

ATT_FORMAT_VERSION - Static variable in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

ATT_ID - Static variable in class org.corpus_tools.pepper.core.PepperParamsReader

ATT_ID - Static variable in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

ATT_KEY - Static variable in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

ATT_MODULE_NAME - Static variable in class org.corpus_tools.pepper.core.PepperParamsReader

ATT_NAME - Static variable in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

ATT_PATH - Static variable in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

ATT_SOURCE_PATH - Static variable in class org.corpus_tools.pepper.core.PepperParamsReader

ATT_SPECIAL_PARAMS - Static variable in class org.corpus_tools.pepper.core.PepperParamsReader

ATT_VERSION - Static variable in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

awake() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Wakes up the contained SDocument, which means, it the SDocumentGraph of the SDocument will be load to main memory again by calling SDocument#loadSDocumentGraph().

awake() - Method in interface org.corpus_tools.pepper.modules.DocumentController

Wakes up the contained SDocument, which means, it the SDocumentGraph of the SDocument will be load to main memory again by calling SDocument#loadSDocumentGraph().

B

before(SCorpusGraph) - Method in class org.corpus_tools.pepper.impl.BeforeAfterAction

Invokes an actions, after the mapping of an entire corpus structure was done.

before(Identifier) - Method in class org.corpus_tools.pepper.impl.BeforeAfterAction

Invokes actions, before the mapping of a corpus or document was started.

BeforeAfterAction - Class in org.corpus_tools.pepper.impl

This class is a helper class to perform actions before or after a mapping was done.

BeforeAfterAction(PepperModule) - Constructor for class org.corpus_tools.pepper.impl.BeforeAfterAction

Initializes this object and in case an action should be performed, it sets the internal PepperModule which does the action, and the internal SCorpusGraph on which the action should be performed.

breakString(String) - Static method in class org.corpus_tools.pepper.common.PepperUtil

Breaks the String theString at position PepperUtil.CONSOLE_WIDTH and adds a linebreak.

breakString(String, int) - Static method in class org.corpus_tools.pepper.common.PepperUtil

Breaks the String theString at position length and adds a linebreak.

breakString(String, String) - Static method in class org.corpus_tools.pepper.common.PepperUtil

Breaks the String theString at position PepperUtil.CONSOLE_WIDTH and adds a linebreak.

breakString(String, String, int) - Static method in class org.corpus_tools.pepper.common.PepperUtil

Breaks the String theString at position length and adds a linebreak.

breakString2(StringBuilder, String, int) - Static method in class org.corpus_tools.pepper.common.PepperUtil

Returns rest

build() - Method in class org.corpus_tools.pepper.common.CorpusDesc.Builder

build() - Method in class org.corpus_tools.pepper.common.FormatDesc.FormatDescBuilder

build() - Method in class org.corpus_tools.pepper.common.ModuleFitness.ModuleFitnessBuilder

build() - Method in class org.corpus_tools.pepper.core.SelfTestDesc.Builder

build() - Method in class org.corpus_tools.pepper.modules.PepperModuleProperty.NameBuilder.TypeBuilder.DescriptionBuilder.Builder

Builder() - Constructor for class org.corpus_tools.pepper.common.CorpusDesc.Builder

Builder() - Constructor for class org.corpus_tools.pepper.core.SelfTestDesc.Builder

Builder(String, Class<T>, String) - Constructor for class org.corpus_tools.pepper.modules.PepperModuleProperty.NameBuilder.TypeBuilder.DescriptionBuilder.Builder

busyLock - Variable in class org.corpus_tools.pepper.core.ModuleControllerImpl

A lock determining, whether this object currently is busy with importing corpus structure or importing document structure.

C

characters(char[], int, int) - Method in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

Reads the property values and adds them to property object

checkFitness() - Method in interface org.corpus_tools.pepper.common.Pepper

Checks the fitness of each registered Pepper module.

checkFitness(Collection<PepperModule>) - Method in class org.corpus_tools.pepper.core.ModuleFitnessChecker

Returns a ModuleFitness value for each PepperModule in specified list.

checkFitness(PepperModule) - Method in class org.corpus_tools.pepper.core.ModuleFitnessChecker

Returns a ModuleFitness value for specified PepperModule.

checkFitness() - Method in class org.corpus_tools.pepper.core.PepperImpl

checkHealth(Collection<PepperModule>) - Method in class org.corpus_tools.pepper.core.ModuleFitnessChecker

Returns a ModuleFitness value for each PepperModule in specified list.

checkHealth(PepperModule) - Method in class org.corpus_tools.pepper.core.ModuleFitnessChecker

Returns a ModuleFitness value for specified PepperModule.

checkProperties() - Method in class org.corpus_tools.pepper.modules.PepperModuleProperties

Checks if all properties marked as required are really set.

checkProperty(PepperModuleProperty<?>) - Method in class org.corpus_tools.pepper.modules.PepperModuleProperties

Checks if the value of given property, when marked as required is really set.

checkReadyToStart() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Checks for each PepperModule in all steps, if it is ready to start, via calling PepperModule.isReadyToStart().

checkThatCorpusGraphIsSettable() - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTest

checkThatCorrectFormatsAreSupported() - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperImExporterTest

checkThatFixtureIsSet() - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTest

checkThatModuleHasName() - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTest

checkThatResourcePathIsSet() - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTest

checkThatWhenSimulatingFitnessCheckModulePassesSelfTest() - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTest

checkThatWhenSimulatingFitnessCheckModulePassesSelfTest(ModuleFitness) - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTest

checkThatWhenSimulatingFitnessCheckModulePassesSelfTest(ModuleFitness) - Method in class org.corpus_tools.pepper.testFramework.PepperExporterTest

checkThatWhenSimulatingFitnessCheckModulePassesSelfTest(ModuleFitness) - Method in class org.corpus_tools.pepper.testFramework.PepperImporterTest

checkThatWhenSimulatingFitnessCheckModulePassesSelfTest(ModuleFitness) - Method in class org.corpus_tools.pepper.testFramework.PepperManipulatorTest

cleanUp() - Method in class org.corpus_tools.pepper.core.PepperImpl

Cleans up current workspace.

clear() - Method in class org.corpus_tools.pepper.common.PepperJob

Removes all Steps from all internal lists.

clear() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Removes all Steps from all internal lists.

close() - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

compare(SaltProject, SaltProject) - Method in class org.corpus_tools.pepper.core.SelfTestDesc

This method is called by the Pepper framework, when making a selftest of the module.

compare(URI, URI) - Method in class org.corpus_tools.pepper.core.SelfTestDesc

This method is called by the Pepper framework, when making a selftest of the module.

compare(File, File) - Method in class org.corpus_tools.pepper.core.SelfTestDesc

This method is called by SelfTestDesc.compare(URI, URI) to compare two files with each other.

compareFiles(URI, URI) - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper

Compares the content of two files.

compareFiles(File, File) - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper

Compares the content of two files.

compareFiles(File, File) - Method in class org.corpus_tools.pepper.util.FileComparator

Compares the content of two files.

compareTo(PepperModuleDesc) - Method in class org.corpus_tools.pepper.common.PepperModuleDesc

Compares the passed PepperModuleDesc object with this.

compareTo(PepperModuleProperty<?>) - Method in class org.corpus_tools.pepper.modules.PepperModuleProperty

compareXML(File, File) - Method in class org.corpus_tools.pepper.core.SelfTestDesc

This method is called by SelfTestDesc.compare(URI, URI) to compare two xmlfiles with each other.

complete(DocumentController) - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

Adds the given DocumentController to the output document bus to be processed by the next PepperModule objects.

complete(DocumentController) - Method in interface org.corpus_tools.pepper.modules.ModuleController

Adds the given DocumentController to the output document bus to be processed by the next PepperModule objects.

CONSOLE_WIDTH - Static variable in class org.corpus_tools.pepper.common.PepperUtil

The standard width of the output console of Pepper.

CONSOLE_WIDTH_120 - Static variable in class org.corpus_tools.pepper.common.PepperUtil

The width of the output console of Pepper.

CONSOLE_WIDTH_80 - Static variable in class org.corpus_tools.pepper.common.PepperUtil

The width of the output console of Pepper, when os is windows.

controller - Variable in class org.corpus_tools.pepper.impl.PepperMapperImpl

convert() - Method in class org.corpus_tools.pepper.common.PepperJob

Starts the conversion of this job.

convert() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Starts the conversion of this job.

convertFrom() - Method in class org.corpus_tools.pepper.common.PepperJob

Imports a SaltProject from any format.

convertFrom() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Imports a SaltProject from any format.

convertTo() - Method in class org.corpus_tools.pepper.common.PepperJob

Exports the SaltProject into any format.

convertTo() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Exports the SaltProject into any format.

copyResources(String) - Method in class org.corpus_tools.pepper.impl.BeforeAfterAction

Reads customization property PepperModuleProperties.PROP_AFTER_COPY_RES and copies the listed resources to the named target folder.

corpusDefinition - Variable in class org.corpus_tools.pepper.impl.PepperExporterImpl

TODO make docu

CorpusDesc - Class in org.corpus_tools.pepper.common

This class realizes a description of a corpus to be imported or exported.

CorpusDesc() - Constructor for class org.corpus_tools.pepper.common.CorpusDesc

Initializes a new CorpusDesc object.

corpusDesc - Variable in class org.corpus_tools.pepper.impl.PepperImporterImpl

TODO make docu

CorpusDesc.Builder - Class in org.corpus_tools.pepper.common

corpusPath - Variable in class org.corpus_tools.pepper.common.CorpusDesc

location of corpus

CorpusPathResolver - Class in org.corpus_tools.pepper.impl

CorpusPathResolver() - Constructor for class org.corpus_tools.pepper.impl.CorpusPathResolver

CorpusPathResolver(URI) - Constructor for class org.corpus_tools.pepper.impl.CorpusPathResolver

create() - Static method in class org.corpus_tools.pepper.modules.PepperModuleProperty

createCorpusDesc() - Static method in class org.corpus_tools.pepper.common.PepperUtil

createDefaultPepper() - Static method in class org.corpus_tools.pepper.testFramework.PepperTestUtil

createFolderStructure(Identifier) - Method in class org.corpus_tools.pepper.impl.PepperExporterImpl

Deprecated.

createFolderStructure(Identifier) - Method in interface org.corpus_tools.pepper.modules.PepperExporter

Creates a folder structure basing on the passed corpus path in ( CorpusDesc.getCorpusPath()).

createJob() - Method in interface org.corpus_tools.pepper.common.Pepper

Creates a new PepperJob object for a new conversion process.

createJob() - Method in class org.corpus_tools.pepper.core.PepperImpl

createPepperMapper(Identifier) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

OVERRIDE THIS METHOD FOR CUSTOMIZED MAPPING.

createPepperMapper(Identifier) - Method in class org.corpus_tools.pepper.modules.coreModules.DoNothingExporter

Creates a mapper which does nothing.

createPepperMapper(Identifier) - Method in class org.corpus_tools.pepper.modules.coreModules.DoNothingImporter

Creates a mapper of type EXMARaLDA2SaltMapper.

createPepperMapper(Identifier) - Method in class org.corpus_tools.pepper.modules.coreModules.DoNothingManipulator

Creates a dummy mapper, which only returns DOCUMENT_STATUS.COMPLETED.

createPepperMapper(Identifier) - Method in class org.corpus_tools.pepper.modules.coreModules.DOTExporter

createPepperMapper(Identifier) - Method in class org.corpus_tools.pepper.modules.coreModules.DOTManipulator

createPepperMapper(Identifier) - Method in class org.corpus_tools.pepper.modules.coreModules.SaltValidator

createPepperMapper(Identifier) - Method in class org.corpus_tools.pepper.modules.coreModules.SaltXMLExporter

Creates a mapper of type SaltXMLExporterMapper.

createPepperMapper(Identifier) - Method in class org.corpus_tools.pepper.modules.coreModules.SaltXMLImporter

Creates a mapper of type EXMARaLDA2SaltMapper.

createPepperMapper(Identifier) - Method in class org.corpus_tools.pepper.modules.coreModules.TextExporter

Creates a mapper to export primary texts.

createPepperMapper(Identifier) - Method in class org.corpus_tools.pepper.modules.coreModules.TextImporter

Creates a mapper OVERRIDE THIS METHOD FOR CUSTOMIZED MAPPING.

createPepperMapper(Identifier) - Method in interface org.corpus_tools.pepper.modules.PepperModule

OVERRIDE THIS METHOD FOR CUSTOMIZED MAPPING.

createStepDesc() - Method in class org.corpus_tools.pepper.common.PepperJob

Creates a StepDesc object an returns it, without adding the created StepDesc object to this PepperJob object.

createTable(Integer[], String[][], boolean, boolean, boolean) - Static method in class org.corpus_tools.pepper.common.PepperUtil

Returns a table created from the passed Strings.

currentModuleController - Variable in class org.corpus_tools.pepper.core.DocumentControllerImpl

stores the currently active document controller

D

deactivate(ComponentContext) - Method in class org.corpus_tools.pepper.core.PepperOSGiRunner

Method is called by OSGi framework, when bundle is deactivated.

DEFAULT_WORKSPACE - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

A sub folder in Pepper directory to be used as workspace (to store jobs etc.)

delete(DocumentController) - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

Notifies the Pepper framework, that the SDocument being contained in passed DocumentController shall not be processed any further by following Pepper modules.

delete(DocumentController) - Method in interface org.corpus_tools.pepper.modules.ModuleController

Notifies the Pepper framework, that the SDocument being contained in passed DocumentController shall not be processed any further by following Pepper modules.

DescriptionBuilder(String, Class<T>) - Constructor for class org.corpus_tools.pepper.modules.PepperModuleProperty.NameBuilder.TypeBuilder.DescriptionBuilder

DetailedStatus() - Constructor for class org.corpus_tools.pepper.core.DocumentControllerImpl.DetailedStatus

diffsBetweenActualAndExpected() - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTest

DIR_CONF - Static variable in class org.corpus_tools.pepper.core.PepperOSGiRunner

extension of where to find plugins and resources

DIR_PLUGINS - Static variable in class org.corpus_tools.pepper.core.PepperOSGiRunner

extension of where to find plugins and resources

docBuilderFactory - Variable in class org.corpus_tools.pepper.core.SelfTestDesc

DOCUMENT_STATUS - Enum in org.corpus_tools.pepper.common

This Enumeration shows the status of a more or less currently processed document.

DocumentBus - Class in org.corpus_tools.pepper.core

This object is an implementation of a threadsafe queue to store DocumentController objects.

DocumentBus(String, String) - Constructor for class org.corpus_tools.pepper.core.DocumentBus

Creates an object of this type and sets the passes the given input controller and output controller.

DocumentBus(String, List<String>) - Constructor for class org.corpus_tools.pepper.core.DocumentBus

Creates an object of this type and sets the passes the given input controller and output controller.

DocumentBus(List<String>, String) - Constructor for class org.corpus_tools.pepper.core.DocumentBus

Creates an object of this type and sets the passes the given input controller and output controller.

DocumentBus(List<String>, List<String>) - Constructor for class org.corpus_tools.pepper.core.DocumentBus

Creates an object of this type and sets all passed in- and output ModuleController objects.

documentBus - Variable in class org.corpus_tools.pepper.core.DocumentBus

This table is the central management object of the DocumentBus.

documentBuses - Variable in class org.corpus_tools.pepper.core.PepperJobImpl

A list of all buses between the ModuleControllerImpl objects

DocumentController - Interface in org.corpus_tools.pepper.modules

DocumentControllerImpl - Class in org.corpus_tools.pepper.core

Stores the global status of a SDocument.

DocumentControllerImpl() - Constructor for class org.corpus_tools.pepper.core.DocumentControllerImpl

Initializes an object of this class.

DocumentControllerImpl(SDocument) - Constructor for class org.corpus_tools.pepper.core.DocumentControllerImpl

Initializes an object of this class.

DocumentControllerImpl.DetailedStatus - Class in org.corpus_tools.pepper.core

A small helper class, to store the status and the processing a specific PepperModule needed for the SDocument object contained by the container DocumentControllerImpl object.

documentControllers - Variable in class org.corpus_tools.pepper.core.PepperJobImpl

A list of all DocumentControllerImpl objects corresponding to each SDocument belonging to this job.

done(Identifier, DOCUMENT_STATUS) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

This method is called by a PepperMapperController object to notify the PepperModule object, that the mapping for this object is done.

done(PepperMapperController) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

This method is called by a PepperMapperController object to notify the PepperModule object, that the mapping is done.

done(PepperMapperController) - Method in interface org.corpus_tools.pepper.modules.PepperModule

This method is called by a PepperMapperController object to notify the PepperModule object, that the mapping is done.

done(Identifier, DOCUMENT_STATUS) - Method in interface org.corpus_tools.pepper.modules.PepperModule

This method is called by a PepperMapperController object to notify the PepperModule object, that the mapping for this object is done.

DoNothingExporter - Class in org.corpus_tools.pepper.modules.coreModules

DoNothingExporter() - Constructor for class org.corpus_tools.pepper.modules.coreModules.DoNothingExporter

DoNothingImporter - Class in org.corpus_tools.pepper.modules.coreModules

DoNothingImporter() - Constructor for class org.corpus_tools.pepper.modules.coreModules.DoNothingImporter

Specifies the separator, which has to be set between to the texts of two token.

DoNothingManipulator - Class in org.corpus_tools.pepper.modules.coreModules

A dummy manipulator, which waves through all documents and corpora.

DoNothingManipulator() - Constructor for class org.corpus_tools.pepper.modules.coreModules.DoNothingManipulator

DOTExporter - Class in org.corpus_tools.pepper.modules.coreModules

DOTExporter() - Constructor for class org.corpus_tools.pepper.modules.coreModules.DOTExporter

DOTManipulator - Class in org.corpus_tools.pepper.modules.coreModules

DOTManipulator() - Constructor for class org.corpus_tools.pepper.modules.coreModules.DOTManipulator

DOTManipulatorProperties - Class in org.corpus_tools.pepper.modules.coreModules

DOTManipulatorProperties() - Constructor for class org.corpus_tools.pepper.modules.coreModules.DOTManipulatorProperties

E

ELEMENT_EXPORTER_PARAMS - Static variable in class org.corpus_tools.pepper.core.PepperParamsReader

ELEMENT_IMPORTER_PARAMS - Static variable in class org.corpus_tools.pepper.core.PepperParamsReader

ELEMENT_MODULE_PARAMS - Static variable in class org.corpus_tools.pepper.core.PepperParamsReader

ELEMENT_PEPPER_JOB_PARAMS - Static variable in class org.corpus_tools.pepper.core.PepperParamsReader

ELEMENT_PEPPERPARAMS - Static variable in class org.corpus_tools.pepper.core.PepperParamsReader

EMAIL - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

pepper-eMail address

end() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Calls method PepperModuleImpl.start(Identifier) for every root SCorpus of SaltProject object.

end() - Method in interface org.corpus_tools.pepper.modules.PepperModule

This method is called by the pepper framework at the end of a conversion process.

endElement(String, String, String) - Method in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

If a property has no value, it must be created here.

ENDING_ALL_FILES - Static variable in interface org.corpus_tools.pepper.modules.PepperModule

All kinds of file endings

ENDING_FOLDER - Static variable in interface org.corpus_tools.pepper.modules.PepperModule

A string specifying a value for a folder as ending.

ENDING_LEAF_FOLDER - Static variable in interface org.corpus_tools.pepper.modules.PepperModule

A string specifying a value for a leaf folder as ending.

ENDING_TAB - Static variable in interface org.corpus_tools.pepper.modules.PepperModule

Ending for an tab file.

ENDING_TXT - Static variable in interface org.corpus_tools.pepper.modules.PepperModule

Ending for an txt file.

ENDING_XML - Static variable in interface org.corpus_tools.pepper.modules.PepperModule

Ending for an xml file.

ENV_PEPPER_MODULE_RESOURCES - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

ENV_PEPPER_WORKFLOW_FILE - Static variable in class org.corpus_tools.pepper.core.PepperOSGiRunner

name of environment variable, which is supposed to contain the workflow description file

equals(Object) - Method in class org.corpus_tools.pepper.common.FormatDesc

Compares a CorpusDesc object with this object.

equals(Object) - Method in class org.corpus_tools.pepper.common.ModuleFitness

equals(Object) - Method in class org.corpus_tools.pepper.common.PepperModuleDesc

This method was overwritten because of a findbugs warning

equals(Object) - Method in class org.corpus_tools.pepper.core.SelfTestDesc

equals(Object) - Method in class org.corpus_tools.pepper.modules.PepperModuleProperty

executor - Variable in class org.corpus_tools.pepper.core.ModuleControllerImpl

Executor, to create and manage threads for import of corpus structure and import of document structure

exportCorpusStructure() - Method in class org.corpus_tools.pepper.impl.PepperExporterImpl

This method is called by PepperModule.start() to export the corpus-structure into a folder-structure.

exportCorpusStructure() - Method in interface org.corpus_tools.pepper.modules.PepperExporter

This method is called by PepperModule.start() to export the corpus-structure into a folder-structure.

F

FILE_CONF_FILE - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

Name of the configuration file.

FILE_CONF_FOLDER - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

Name of the folder containing configuration files.

FILE_CONF_TEST_FILE - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

Name of the configuration file for testing.

FILE_ENDING_PEPPER - Static variable in class org.corpus_tools.pepper.common.PepperUtil

This is the default ending of a Pepper workflow description file.

FileComparator - Class in org.corpus_tools.pepper.util

FileComparator() - Constructor for class org.corpus_tools.pepper.util.FileComparator

findAppropriateImporters(URI) - Method in interface org.corpus_tools.pepper.common.Pepper

Returns the names of importers which can import the data located at the specified corpusPath.

findAppropriateImporters(URI) - Method in class org.corpus_tools.pepper.core.PepperImpl

finish(String) - Method in class org.corpus_tools.pepper.core.DocumentBus

Sets the entry corresponding to given id to status finished, which means, that when all listed ModuleController objects on input side, are set to status finish, this queue is finished and no further documents are passed to ModuleController objects on output side.

FITNESS_FEATURE_DESC - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

link to Pepper developers homepage for fitness features

fixture - Variable in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper

flush() - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

FORMAT_NAME - Static variable in class org.corpus_tools.pepper.modules.coreModules.DoNothingExporter

FORMAT_NAME - Static variable in class org.corpus_tools.pepper.modules.coreModules.DoNothingImporter

FORMAT_NAME - Static variable in class org.corpus_tools.pepper.modules.coreModules.DoNothingManipulator

FORMAT_NAME - Static variable in class org.corpus_tools.pepper.modules.coreModules.DOTExporter

FORMAT_NAME - Static variable in class org.corpus_tools.pepper.modules.coreModules.SaltXMLExporter

FORMAT_NAME - Static variable in class org.corpus_tools.pepper.modules.coreModules.SaltXMLImporter

FORMAT_NAME - Static variable in class org.corpus_tools.pepper.modules.coreModules.TextExporter

FORMAT_NAME - Static variable in class org.corpus_tools.pepper.modules.coreModules.TextImporter

FORMAT_VERSION - Static variable in class org.corpus_tools.pepper.modules.coreModules.DoNothingExporter

FORMAT_VERSION - Static variable in class org.corpus_tools.pepper.modules.coreModules.DoNothingImporter

FORMAT_VERSION - Static variable in class org.corpus_tools.pepper.modules.coreModules.DoNothingManipulator

FORMAT_VERSION - Static variable in class org.corpus_tools.pepper.modules.coreModules.DOTExporter

FORMAT_VERSION - Static variable in class org.corpus_tools.pepper.modules.coreModules.SaltXMLExporter

FORMAT_VERSION - Static variable in class org.corpus_tools.pepper.modules.coreModules.SaltXMLImporter

FORMAT_VERSION - Static variable in class org.corpus_tools.pepper.modules.coreModules.TextExporter

FORMAT_VERSION - Static variable in class org.corpus_tools.pepper.modules.coreModules.TextImporter

formatDesc - Variable in class org.corpus_tools.pepper.common.CorpusDesc

format description belonging to this corpus

FormatDesc - Class in org.corpus_tools.pepper.common

This class is used by Pepper to describe a linguistic data format.

FormatDesc() - Constructor for class org.corpus_tools.pepper.common.FormatDesc

Initilizes an object.

FormatDesc.FormatDescBuilder - Class in org.corpus_tools.pepper.common

FormatDescBuilder() - Constructor for class org.corpus_tools.pepper.common.FormatDesc.FormatDescBuilder

formatName - Variable in class org.corpus_tools.pepper.common.FormatDesc

Name of the linguistic format.

formatReference - Variable in class org.corpus_tools.pepper.common.FormatDesc

Documentation reference for the linguistic format.

formatVersion - Variable in class org.corpus_tools.pepper.common.FormatDesc

The version of the format.

G

getActiveDocuments() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Returns a set of all currently active documents.

getAllSteps() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Returns a of all steps belonging no matter, to which phase they belong.

getBaseDir() - Method in class org.corpus_tools.pepper.common.PepperJob

Returns the base directory for this ModuleController.

getBusyLock() - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

A lock determining, whether this object currently is busy with importing corpus structure or importing document structure.

getComponentContext() - Method in interface org.corpus_tools.pepper.core.ModuleResolver

Returns the ComponentContext of the OSGi environment the bundle was started in.

getComponentContext() - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

Returns the ComponentContext of the OSGi environment the bundle was started in.

getComponentContext() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Returns the ComponentContext of the OSGi environment the bundle was started in.

getComponentContext() - Method in interface org.corpus_tools.pepper.modules.PepperModule

Returns the ComponentContext of the OSGi environment the bundle was started in.

getConfFolder() - Method in class org.corpus_tools.pepper.common.PepperConfiguration

Returns the folder containing the configuration file(s).

getConfiguration() - Method in interface org.corpus_tools.pepper.common.Pepper

Returns set configuration for Pepper.

getConfiguration() - Method in interface org.corpus_tools.pepper.core.ModuleResolver

Returns the configuration object for this converter object.

getConfiguration() - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

Returns the configuration object for this converter object.

getConfiguration() - Method in class org.corpus_tools.pepper.core.PepperImpl

getConfiguration() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

returns the properties to customize the behavior of conversion for this single job.

getCorpus() - Method in class org.corpus_tools.pepper.impl.PepperMapperImpl

Returns the SCorpus object to be mapped by this mapper.

getCorpus() - Method in interface org.corpus_tools.pepper.modules.PepperMapper

Returns the SCorpus object to be mapped by this mapper.

getCorpusDesc() - Method in class org.corpus_tools.pepper.common.StepDesc

Returns an object to describe all infos about the corpus to im- or export.

getCorpusDesc() - Method in class org.corpus_tools.pepper.impl.PepperExporterImpl

TODO docu

getCorpusDesc() - Method in class org.corpus_tools.pepper.impl.PepperImporterImpl

TODO docu

getCorpusDesc() - Method in interface org.corpus_tools.pepper.modules.PepperExporter

TODO docu

getCorpusDesc() - Method in interface org.corpus_tools.pepper.modules.PepperImporter

TODO docu

getCorpusEndings() - Method in class org.corpus_tools.pepper.impl.PepperImporterImpl

Returns a collection of all file endings for a SCorpus object.

getCorpusEndings() - Method in interface org.corpus_tools.pepper.modules.PepperImporter

Returns a collection of all file endings for a SCorpus object.

getCorpusGraph() - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

Returns the SCorpusGraph object, the contained PepperImporter is mapping.

getCorpusGraph() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Returns the SCorpusGraph object which is filled, manipulated or exported by the current module.

getCorpusGraph() - Method in interface org.corpus_tools.pepper.modules.ModuleController

Returns the SCorpusGraph object, the contained PepperImporter is mapping.

getCorpusGraph() - Method in interface org.corpus_tools.pepper.modules.PepperModule

Returns the SCorpusGraph object which is filled, manipulated or exported by the current module.

getCorpusPath() - Method in class org.corpus_tools.pepper.common.CorpusDesc

Returns the path of where to store or from where to load this corpus.

getCurrentModuleController() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Returns the module controller, which is currently processing this document.

getCurrentModuleController() - Method in interface org.corpus_tools.pepper.modules.DocumentController

Returns the module controller, which is currently processing this document.

getDefaultValue() - Method in class org.corpus_tools.pepper.modules.PepperModuleProperty

getDesc() - Method in class org.corpus_tools.pepper.common.PepperModuleDesc

Returns a short description of this module.

getDesc() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Returns a short description of this module.

getDesc() - Method in interface org.corpus_tools.pepper.modules.PepperModule

Returns a short description of this module.

getDescription() - Method in class org.corpus_tools.pepper.modules.PepperModuleProperty

getDetaialedStatReport() - Method in class org.corpus_tools.pepper.common.PepperConfiguration

Property to determine whether the status report should contain a progress for each module or just the global progress.

getDocument() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Returns the SDocument object, to which this object belongs to.

getDocument() - Method in class org.corpus_tools.pepper.impl.PepperMapperImpl

Returns the SDocument object to be mapped by this mapper.

getDocument() - Method in interface org.corpus_tools.pepper.modules.DocumentController

Returns the SDocument object, to which this object belongs to.

getDocument() - Method in interface org.corpus_tools.pepper.modules.PepperMapper

Returns the SDocument object to be mapped by this mapper.

getDocumentBus() - Method in class org.corpus_tools.pepper.core.DocumentBus

Returns the table, which is the central management object of the DocumentBus.

getDocumentBuses() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

getDocumentController() - Method in class org.corpus_tools.pepper.modules.MappingSubject

Returns the document controller, if one was set.

getDocumentControllers() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Returns a list of all DocumentControllerImpl objects corresponding to each SDocument belonging to this job.

getDocumentEnding() - Method in class org.corpus_tools.pepper.impl.PepperExporterImpl

Returns the format ending for files to be exported and related to SDocument objects.

getDocumentEnding() - Method in interface org.corpus_tools.pepper.modules.PepperExporter

Returns the format ending for files to be exported and related to SDocument objects.

getDocumentEndings() - Method in class org.corpus_tools.pepper.impl.PepperImporterImpl

Returns list containing all format endings for files, which are importable and could be mapped to SDocument or SDocumentGraph objects by this Pepper module.

getDocumentEndings() - Method in interface org.corpus_tools.pepper.modules.PepperImporter

Returns list containing all format endings for files, which are importable and could be mapped to SDocument or SDocumentGraph objects by this Pepper module.

getDocumentId() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Returns the Identifier of the SDocument object, to which this object belongs to.

getDocumentId() - Method in interface org.corpus_tools.pepper.modules.DocumentController

Returns the Identifier of the SDocument object, to which this object belongs to.

getDocumentId2DC() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Returns the map relating Identifier belonging to SDocument objects to their DocumentController container.

getExecutor() - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

Returns an executor service for this object.

getExpectedCorpusPath() - Method in class org.corpus_tools.pepper.core.SelfTestDesc

getExportMode() - Method in class org.corpus_tools.pepper.impl.PepperExporterImpl

Returns how corpus-structure is exported.

getExportMode() - Method in interface org.corpus_tools.pepper.modules.PepperExporter

Returns how corpus-structure is exported.

getExportSteps() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Returns the list of all steps belonging to the export phase.

getFileEnding() - Method in class org.corpus_tools.pepper.modules.coreModules.DOTManipulatorProperties

getFingerprint() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Returns a PepperModuleDesc object, which is a kind of a fingerprint of this PepperModule.

getFingerprint() - Method in interface org.corpus_tools.pepper.modules.PepperModule

Returns a PepperModuleDesc object, which is a kind of a fingerprint of this PepperModule.

getFitness(ModuleFitness.FitnessFeature) - Method in class org.corpus_tools.pepper.common.ModuleFitness

getFitnessFeatures() - Static method in enum org.corpus_tools.pepper.common.ModuleFitness.FitnessFeature

Returns the names of the fitness feature.

getFixture() - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper

Returns the current fixture to test.

getFixture() - Method in class org.corpus_tools.pepper.testFramework.PepperExporterTest

getFixture() - Method in class org.corpus_tools.pepper.testFramework.PepperImporterTest

getFormatDesc() - Method in class org.corpus_tools.pepper.common.CorpusDesc

Returns a set format description.

getFormatName() - Method in class org.corpus_tools.pepper.common.FormatDesc

Returns the name of the linguistic format.

getFormatReference() - Method in class org.corpus_tools.pepper.common.FormatDesc

Returns the documentation reference for the linguistic format.

getFormatVersion() - Method in class org.corpus_tools.pepper.common.FormatDesc

Returns the version of the linguistic format.

getGcAfterDocumentSleep() - Method in class org.corpus_tools.pepper.common.PepperConfiguration

getGlobalId() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Returns a global unique (inside one Salt project) id for the contained SDocument object.

getGlobalId() - Method in interface org.corpus_tools.pepper.modules.DocumentController

Returns a global unique (inside one Salt project) id for the contained SDocument object.

getGlobalStatus() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Returns the global status of this object.

getGlobalStatus() - Method in interface org.corpus_tools.pepper.modules.DocumentController

Returns the global status of this object.

getHealthFeatures() - Static method in enum org.corpus_tools.pepper.common.ModuleFitness.FitnessFeature

Returns the names of the fitness features taking part at health test.

getHello() - Static method in class org.corpus_tools.pepper.common.PepperUtil

Returns a formatted String, a kind of a welcome screen of Pepper.

getHello(int, String, String) - Static method in class org.corpus_tools.pepper.common.PepperUtil

Returns a formatted String, a kind of a welcome screen of Pepper.

getId() - Method in class org.corpus_tools.pepper.common.PepperJob

Returns the unique identifier for this job.

getId() - Method in class org.corpus_tools.pepper.core.DocumentBus

Creates an id for this object. the id consists of the in- and output DocumentController objects.

getId() - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

Returns the id of this object.

getId() - Method in class org.corpus_tools.pepper.core.Step

Returns the internal id, which represents position of the Step in list of steps.

getId() - Method in interface org.corpus_tools.pepper.modules.ModuleController

Returns the id of this object.

getIdentifier() - Method in class org.corpus_tools.pepper.impl.PepperMapperControllerImpl

Returns Identifier object of the SCorpus or SDocument object, which is contained by containing PepperMapper.

getIdentifier() - Method in class org.corpus_tools.pepper.modules.MappingSubject

Returns Identifier object corresponding to either SDocument or SCorpus which should be mapped

getIdentifier() - Method in interface org.corpus_tools.pepper.modules.PepperMapperController

Returns Identifier object of the SCorpus or SDocument object, which is contained by containing PepperMapper.

getIdentifier2ResourceTable() - Method in class org.corpus_tools.pepper.impl.PepperExporterImpl

Returns table correspondence between Identifier and a resource.

getIdentifier2ResourceTable() - Method in class org.corpus_tools.pepper.impl.PepperImporterImpl

Stores Identifier objects corresponding to either a SDocument or a SCorpus object, which has been created during the run of PepperImporter.importCorpusStructure(SCorpusGraph).

getIdentifier2ResourceTable() - Method in interface org.corpus_tools.pepper.modules.PepperExporter

Returns table correspondence between Identifier and a resource.

getIdentifier2ResourceTable() - Method in interface org.corpus_tools.pepper.modules.PepperImporter

Stores Identifier objects corresponding to either a SDocument or a SCorpus object, which has been created during the run of PepperImporter.importCorpusStructure(SCorpusGraph).

getIgnoreEndings() - Method in class org.corpus_tools.pepper.impl.PepperImporterImpl

Returns a collection of filenames, not to be imported.

getIgnoreEndings() - Method in interface org.corpus_tools.pepper.modules.PepperImporter

Returns a collection of filenames, not to be imported.

getImportSteps() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Returns the list of all steps belonging to the import phase.

getInputControllerIds() - Method in class org.corpus_tools.pepper.core.DocumentBus

Returns a list of Ids belonging to ModuleController objects on the input side.

getInputCorpusPath() - Method in class org.corpus_tools.pepper.core.SelfTestDesc

getInputDocumentBus() - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

The DocumentBus object working as input for this ModuleControllerImpl.

getInputDocumentBus() - Method in interface org.corpus_tools.pepper.modules.ModuleController

The DocumentBus object working as input for this ModuleControllerImpl.

getIntend() - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

Returns the intend character(s) for pretty printing.

getInterval() - Method in class org.corpus_tools.pepper.common.PepperUtil.PepperJobReporter

Returns the interval in which the status is printed

getJob(String) - Method in interface org.corpus_tools.pepper.common.Pepper

Returns a PepperJob corresponding to the passed id.

getJob() - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

Returns the PepperJobImpl object reference of this object.

getJob(String) - Method in class org.corpus_tools.pepper.core.PepperImpl

getJob() - Method in class org.corpus_tools.pepper.core.PepperParamsReader

Returns PepperJob to be filled.

getJob() - Method in interface org.corpus_tools.pepper.modules.ModuleController

Returns the PepperJobImpl object reference of this object.

getJobIds() - Method in class org.corpus_tools.pepper.core.PepperImpl

Return identifiers of all registered PepperJobImpl objects.

getKeepDocuments() - Method in class org.corpus_tools.pepper.common.PepperConfiguration

name of the flag to determine whether the temporary created document-graph files should be preserved or deleted after Pepper terminates.

getLocation() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Returns location, where to store SDocumentGraph when #sleep() was called or load when DocumentController.awake() was called

getLocation(String) - Method in class org.corpus_tools.pepper.core.PepperImpl

Returns the location of a job.

getLocation() - Method in class org.corpus_tools.pepper.core.PepperParamsReader

getLocation() - Method in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

getLocation() - Method in interface org.corpus_tools.pepper.modules.DocumentController

Returns location, where to store SDocumentGraph when #sleep() was called or load when DocumentController.awake() was called

getManipulationSteps() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Returns the list of all steps belonging to the manipulation phase.

getMapperControllers() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Returns a threadsafe map of all PepperMapperController objects which are connected with a started PepperMapper corresponding to their

getMapperThreadGroup() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Returns a ThreadGroup where PepperMapper objects and the corresponding threads are supposed to run in.

getMappingResult() - Method in class org.corpus_tools.pepper.impl.PepperMapperControllerImpl

Returns the result of the mapping, when finished.

getMappingResult() - Method in class org.corpus_tools.pepper.impl.PepperMapperImpl

Returns the result of the mapping, when finished.

getMappingResult() - Method in class org.corpus_tools.pepper.modules.MappingSubject

getMappingResult() - Method in interface org.corpus_tools.pepper.modules.PepperMapper

Returns the result of the mapping, when finished.

getMappingResult() - Method in interface org.corpus_tools.pepper.modules.PepperMapperController

Returns the result of the mapping, when finished.

getMappingSubjects() - Method in class org.corpus_tools.pepper.impl.PepperMapperControllerImpl

Returns a list of all subjects (SDocument or SCorpus) to be merged

getMappingSubjects() - Method in class org.corpus_tools.pepper.impl.PepperMapperImpl

Returns a list of all subjects (SDocument or SCorpus) to be merged

getMappingSubjects() - Method in interface org.corpus_tools.pepper.modules.PepperMapper

Returns a list of all subjects (SDocument or SCorpus) to be merged

getMappingSubjects() - Method in interface org.corpus_tools.pepper.modules.PepperMapperController

Returns a list of all subjects (SDocument or SCorpus) to be merged

getMaxAmountOfDocuments() - Method in class org.corpus_tools.pepper.common.PepperConfiguration

Returns the the maximal number of currently processed SDocument-objects

getMaxNumberOfDocuments() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Returns the maximal number of SDocument objects which could be processed at the same time

getMemPolicy() - Method in class org.corpus_tools.pepper.common.PepperConfiguration

Returns the memory policy for instance to configure the behavior of loading documents.

getMemPolicy() - Method in class org.corpus_tools.pepper.core.DocumentBus

Returns the set memory policy.

getMemPolicy() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Returns the set memory policy.

getModuleController() - Method in class org.corpus_tools.pepper.core.Step

The ModuleControllerImpl object which belongs to this step and acts as a bridge between Pepper and the Pepper module.

getModuleController() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Returns the container and controller object for the current module.

getModuleController() - Method in interface org.corpus_tools.pepper.modules.PepperModule

Returns the container and controller object for the current module.

getModuleControllers() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Returns a list of all ModuleControllerImpl objects, the here contained SDocument object has to pass.

getModuleControllers() - Method in interface org.corpus_tools.pepper.modules.DocumentController

Returns a list of all ModuleControllerImpl objects, the here contained SDocument object has to pass.

getModuleName() - Method in class org.corpus_tools.pepper.common.ModuleFitness

getModuleResolver() - Method in class org.corpus_tools.pepper.core.PepperImpl

Returns the set ModuleResolverImpl object, to resolve PepperModule objects.

getModuleResolver() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Returns a reference to the OSGi module resolver, to find modules matching to the step description.

getModuleType() - Method in class org.corpus_tools.pepper.common.PepperModuleDesc

Returns the type of this module.

getModuleType() - Method in class org.corpus_tools.pepper.common.StepDesc

Returns the type of the PepperModule to be used.

getModuleType() - Method in class org.corpus_tools.pepper.core.Step

Returns the type of the PepperModule to be used.

getModuleType() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Returns the type of this module.

getModuleType() - Method in interface org.corpus_tools.pepper.modules.PepperModule

Returns the type of this module.

getName() - Method in enum org.corpus_tools.pepper.common.DOCUMENT_STATUS

Returns a prosa name of the type

getName() - Method in class org.corpus_tools.pepper.common.PepperModuleDesc

Returns the name of a Pepper module described by this PepperModuleDesc object.

getName() - Method in class org.corpus_tools.pepper.common.StepDesc

Returns the name of the PepperModule to be used for this step.

getName() - Method in class org.corpus_tools.pepper.core.Step

If a PepperModule is set, overrides the set name with the name of the PepperModule.

getName() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Returns the name of this module.

getName() - Method in interface org.corpus_tools.pepper.modules.PepperModule

Returns the name of this module.

getName() - Method in class org.corpus_tools.pepper.modules.PepperModuleProperty

getNamespaceContext() - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

getNumOfActiveDocuments() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Returns the current number of SDocument objects which could be processed at the same time

getNumOfProcessingModules() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Returns the number of PepperModule currently processing the SDocument or more precisly the SDocumentGraph contained by this DocumentControllerImpl object.

getNumOfProcessingModules() - Method in interface org.corpus_tools.pepper.modules.DocumentController

Returns the number of PepperModule currently processing the SDocument or more precisly the SDocumentGraph contained by this DocumentControllerImpl object.

getOutputControllerIds() - Method in class org.corpus_tools.pepper.core.DocumentBus

Returns a list of Ids belonging to ModuleController objects, which are on the output side of this queue.

getOutputDocumentBus() - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

All documents which were consumed by the PepperModule contained in this object are set to this output bus, regarding the status, the PepperModule returned.

getOutputDocumentBus() - Method in interface org.corpus_tools.pepper.modules.ModuleController

All documents which were consumed by the PepperModule contained in this object are set to this output bus, regarding the status, the PepperModule returned.

getOutputFile() - Method in class org.corpus_tools.pepper.modules.coreModules.DOTManipulatorProperties

getOverallFitness() - Method in class org.corpus_tools.pepper.common.ModuleFitness

Returns a combined fitness value representing all single values.

getPepper() - Method in class org.corpus_tools.pepper.core.PepperOSGiRunner

Returns Pepper registered Pepper object.

getPepperExporter(StepDesc) - Method in interface org.corpus_tools.pepper.core.ModuleResolver

Creates an instance of PepperExporter for each listed ComponentFactory in list #pepperExporterComponentFactories and returns that list.

getPepperExporter(StepDesc) - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

Creates an instance of PepperExporter for each listed ComponentFactory in list #pepperExporterComponentFactories and returns that list.

getPepperExporterComponentFactories() - Method in interface org.corpus_tools.pepper.core.ModuleResolver

TODO make docu

getPepperExporterComponentFactories() - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

TODO make docu

getPepperExporters() - Method in interface org.corpus_tools.pepper.core.ModuleResolver

Creates an instance of PepperExporter for each listed ComponentFactory in list #pepperExporterComponentFactories and returns that list.

getPepperExporters() - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

Creates an instance of PepperExporter for each listed ComponentFactory in list #pepperExporterComponentFactories and returns that list.

getPepperImporter(StepDesc) - Method in interface org.corpus_tools.pepper.core.ModuleResolver

Returns a PepperImporter object matching to the given ImporterParams.

getPepperImporter(StepDesc) - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

Returns a PepperImporter object matching to the given ImporterParams.

getPepperImporterComponentFactories() - Method in interface org.corpus_tools.pepper.core.ModuleResolver

TODO make docu

getPepperImporterComponentFactories() - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

TODO make docu

getPepperImporters() - Method in interface org.corpus_tools.pepper.core.ModuleResolver

Creates an instance of PepperImporter for each listed ComponentFactory in list #pepperImporterComponentFactories and returns that list.

getPepperImporters() - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

Creates an instance of PepperImporter for each listed ComponentFactory in list #pepperImporterComponentFactories and returns that list.

getPepperJob() - Method in class org.corpus_tools.pepper.common.PepperUtil.PepperJobReporter

Returns the PepperJob object, which is observed

getPepperJob() - Method in class org.corpus_tools.pepper.core.DocumentBus

Returns the PepperJob object containing this object

getPepperJob() - Method in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

Returns PepperJob object to be filled with content.

getPepperJobImpl(String) - Method in class org.corpus_tools.pepper.core.PepperImpl

getPepperManipulator(StepDesc) - Method in interface org.corpus_tools.pepper.core.ModuleResolver

Creates an instance of PepperManipulator for each listed ComponentFactory in list #pepperManipulatorComponentFactories and returns that list.

getPepperManipulator(StepDesc) - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

Creates an instance of PepperManipulator for each listed ComponentFactory in list #pepperManipulatorComponentFactories and returns that list.

getPepperManipulatorComponentFactories() - Method in interface org.corpus_tools.pepper.core.ModuleResolver

TODO make docu

getPepperManipulatorComponentFactories() - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

TODO make docu

getPepperManipulators() - Method in interface org.corpus_tools.pepper.core.ModuleResolver

Creates an instance of PepperManipulator for each listed ComponentFactory in list #pepperManipulatorComponentFactories and returns that list.

getPepperManipulators() - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

Creates an instance of PepperManipulator for each listed ComponentFactory in list #pepperManipulatorComponentFactories and returns that list.

getPepperMapper() - Method in class org.corpus_tools.pepper.impl.PepperMapperControllerImpl

Returns the PepperMapper, controlled by this object.

getPepperMapper() - Method in interface org.corpus_tools.pepper.modules.PepperMapperController

Returns the PepperMapper, controlled by this object.

getPepperMapperController() - Method in class org.corpus_tools.pepper.impl.PepperMapperImpl

Returns the controller of this mapper, to grant n access to Pepper via the controller.

getPepperMapperController() - Method in interface org.corpus_tools.pepper.modules.PepperMapper

Returns the controller of this mapper, to grant n access to Pepper via the controller.

getPepperModule() - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

Returns the PepperModule object, this controller object is observing.

getPepperModule(StepDesc) - Method in interface org.corpus_tools.pepper.core.ModuleResolver

Returns a PepperModule object matching to the given StepDesc.

getPepperModule(StepDesc) - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

Returns a PepperModule object matching to the given StepDesc.

getPepperModule() - Method in class org.corpus_tools.pepper.impl.BeforeAfterAction

getPepperModule() - Method in class org.corpus_tools.pepper.impl.PepperMapperControllerImpl

Returns PepperModule object containing this object

getPepperModule() - Method in interface org.corpus_tools.pepper.modules.ModuleController

Returns the PepperModule object, this controller object is observing.

getPermissionForProcessDoument(DocumentController) - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Returns true, if a SDocument or more precisely spoken a SDocumentGraph could be woken up or imported.

getPermissionForProcessDoument(DocumentController) - Method in class org.corpus_tools.pepper.impl.PepperMapperControllerImpl

getPermissionForProcessDoument(DocumentController) - Method in interface org.corpus_tools.pepper.modules.PepperMapperController

getPrefix(String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

getPrettyPrint() - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

Returns whether xml should be pretty printed

getProcessingTime() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl.DetailedStatus

getProcessingTime() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Returns the processing time of the contained SDocument object, needed by all registered PepperModule, which have already started the process.

getProcessingTime() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Returns the amount of time the job already took.

getProcessingTime() - Method in interface org.corpus_tools.pepper.modules.DocumentController

Returns the processing time of the contained SDocument object, needed by all registered PepperModule, which have already started the process.

getProgress() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Returns the progress of the contained SDocument for all registered ModuleControllerImpl objects.

getProgress(String) - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

Returns the progress as a value between 0 and 1 of the contained PepperModule object concerning to the SDocument corresponding to the passed global identifier.

getProgress() - Method in class org.corpus_tools.pepper.impl.PepperMapperControllerImpl

This method is invoked by the containing PepperModule object, to get the current progress concerning the SDocument or SCorpus object handled by this object.

getProgress() - Method in class org.corpus_tools.pepper.impl.PepperMapperImpl

This method is invoked by the containing PepperModule object, to get the current progress concerning the SDocument or SCorpus object handled by this object.

getProgress(String) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

This method is invoked by the Pepper framework, to get the current progress concerning the SDocument object corresponding to the given Identifier in percent.

getProgress() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

This method is invoked by the Pepper framework, to get the current total progress of all SDocument objects being processed by this module.

getProgress() - Method in interface org.corpus_tools.pepper.modules.DocumentController

Returns the progress of the contained SDocument for all registered ModuleControllerImpl objects.

getProgress(String) - Method in interface org.corpus_tools.pepper.modules.ModuleController

Returns the progress as a value between 0 and 1 of the contained PepperModule object concerning to the SDocument corresponding to the passed global identifier.

getProgress() - Method in interface org.corpus_tools.pepper.modules.PepperMapper

This method is invoked by the containing PepperModule object, to get the current progress concerning the SDocument or SCorpus object handled by this object.

getProgress() - Method in interface org.corpus_tools.pepper.modules.PepperMapperController

This method is invoked by the containing PepperModule object, to get the current progress concerning the SDocument or SCorpus object handled by this object.

getProgress(String) - Method in interface org.corpus_tools.pepper.modules.PepperModule

This method is invoked by the Pepper framework, to get the current progress concerning the SDocument object corresponding to the given Identifier in percent.

getProgress() - Method in interface org.corpus_tools.pepper.modules.PepperModule

This method is invoked by the Pepper framework, to get the current total progress of all SDocument objects being processed by this module.

getProperties() - Method in class org.corpus_tools.pepper.common.PepperModuleDesc

Returns a PepperModuleProperties object containing properties to customize the behavior of this PepperModule.

getProperties() - Method in class org.corpus_tools.pepper.impl.PepperMapperImpl

Returns the PepperModuleProperties object containing user customizations to be observed during the mapping.

getProperties() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Returns a PepperModuleProperties object containing properties to customize the behavior of this PepperModule.

getProperties() - Method in interface org.corpus_tools.pepper.modules.PepperMapper

Returns the PepperModuleProperties object containing user customizations to be observed during the mapping.

getProperties() - Method in interface org.corpus_tools.pepper.modules.PepperModule

Returns a PepperModuleProperties object containing properties to customize the behavior of this PepperModule.

getProperties() - Method in class org.corpus_tools.pepper.modules.PepperModuleProperties

Returns a new Properties object containing all property names and their values.

getProperty(String) - Method in class org.corpus_tools.pepper.modules.PepperModuleProperties

Returns a PepperModuleProperty object corresponding to the given property name.

getProperty(String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

getPropertyDesctriptions() - Method in class org.corpus_tools.pepper.modules.PepperModuleProperties

Returns all registered PepperModuleProperty objects, which are usable for the corresponding PepperModule.

getPropertyNames() - Method in class org.corpus_tools.pepper.modules.PepperModuleProperties

Returns all property names registered in that object, and therefore usable for the corresponding PepperModule.

getProps() - Method in class org.corpus_tools.pepper.common.StepDesc

Returns the object for temporary storage of customization properties.

getRegisteredImporters() - Method in interface org.corpus_tools.pepper.common.Pepper

Returns all PepperModuleDesc corresponding to a registered importer.

getRegisteredImporters() - Method in class org.corpus_tools.pepper.core.PepperImpl

getRegisteredModules() - Method in interface org.corpus_tools.pepper.common.Pepper

Returns a collection of all PepperModuleDesc corresponding to Pepper modules, which are registered in this Pepper instance.

getRegisteredModules() - Method in class org.corpus_tools.pepper.core.PepperImpl

getRegisteredModulesAsString() - Method in interface org.corpus_tools.pepper.common.Pepper

Returns a string representation of the method Pepper.getRegisteredModules().

getRegisteredModulesAsString() - Method in class org.corpus_tools.pepper.core.PepperImpl

getReportInterval() - Method in class org.corpus_tools.pepper.common.PepperConfiguration

Flag to determine the time interval of the convert status report

getResources() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Returns the path of the folder which might contain resources for a Pepper module.

getResources() - Method in interface org.corpus_tools.pepper.modules.PepperModule

Returns the path of the folder which might contain resources for a Pepper module.

getResourceURI() - Method in class org.corpus_tools.pepper.impl.PepperMapperImpl

Returns URI of resource.

getResourceURI() - Method in class org.corpus_tools.pepper.modules.MappingSubject

getResourceURI() - Method in interface org.corpus_tools.pepper.modules.PepperMapper

Returns URI of resource.

getSaltProject() - Method in class org.corpus_tools.pepper.common.PepperJob

Returns the SaltProject which is converted by this job.

getSaltProject() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Returns the SaltProject which is converted by this job.

getSaltProject() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Returns the SaltProject object, which is filled, manipulated or exported by the current module.

getSaltProject() - Method in interface org.corpus_tools.pepper.modules.PepperModule

Returns the SaltProject object, which is filled, manipulated or exported by the current module.

getSelfTestDesc() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

getSelfTestDesc() - Method in class org.corpus_tools.pepper.modules.coreModules.DoNothingExporter

getSelfTestDesc() - Method in class org.corpus_tools.pepper.modules.coreModules.DoNothingImporter

getSelfTestDesc() - Method in class org.corpus_tools.pepper.modules.coreModules.DoNothingManipulator

getSelfTestDesc() - Method in class org.corpus_tools.pepper.modules.coreModules.DOTExporter

getSelfTestDesc() - Method in class org.corpus_tools.pepper.modules.coreModules.DOTManipulator

getSelfTestDesc() - Method in class org.corpus_tools.pepper.modules.coreModules.SaltValidator

getSelfTestDesc() - Method in class org.corpus_tools.pepper.modules.coreModules.SaltXMLExporter

getSelfTestDesc() - Method in class org.corpus_tools.pepper.modules.coreModules.SaltXMLImporter

getSelfTestDesc() - Method in class org.corpus_tools.pepper.modules.coreModules.TextExporter

getSelfTestDesc() - Method in class org.corpus_tools.pepper.modules.coreModules.TextImporter

getSelfTestDesc() - Method in interface org.corpus_tools.pepper.modules.PepperModule

This method is called by the Pepper framework to run an integration test for module.

getSize_nodes() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Stores the number of SNodes a document contains, when it ws send to sleep.

getSize_nodes() - Method in interface org.corpus_tools.pepper.modules.DocumentController

Stores the number of SNodes a document contains, when it ws send to sleep.

getSize_relations() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Stores the number of SRelations a document contains, when it ws send to sleep.

getSize_relations() - Method in interface org.corpus_tools.pepper.modules.DocumentController

Stores the number of SRelations a document contains, when it ws send to sleep.

getSrcResources() - Static method in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper

getSrcResources() - Static method in class org.corpus_tools.pepper.testFramework.PepperTestUtil

Returns a default test folder, where to find resources for tests.

getStartProblems() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

If PepperModule.isReadyToStart() has returned false, this method returns a list of reasons why this module is not ready to start.

getStartProblems() - Method in interface org.corpus_tools.pepper.modules.PepperModule

If PepperModule.isReadyToStart() has returned false, this method returns a list of reasons why this module is not ready to start.

getStatus() - Method in class org.corpus_tools.pepper.common.PepperJob

Returns the current status of this job.

getStatus() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl.DetailedStatus

getStatus() - Method in interface org.corpus_tools.pepper.core.ModuleResolver

Returns a status description as String.

getStatus() - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

Returns a status description as String.

getStatusReport() - Method in class org.corpus_tools.pepper.common.PepperJob

Returns a formated string as a kind of a document centric progress status.

getStatusReport() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Returns a formated string containing a report of the progress status of the contained document.

getStatusReport() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Returns a formated string as a kind of a document centric progress status.

getStepDescs() - Method in class org.corpus_tools.pepper.common.PepperJob

Returns a list of all step descriptions.

getSupplierContact() - Method in class org.corpus_tools.pepper.common.PepperModuleDesc

Returns a uri where to find more information about this module and where to find some contact information to contact the supllier.

getSupplierContact() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Returns a uri where to find more information about this module and where to find some contact information to contact the supplier.

getSupplierContact() - Method in interface org.corpus_tools.pepper.modules.PepperModule

Returns a uri where to find more information about this module and where to find some contact information to contact the supplier.

getSupplierHomepage() - Method in class org.corpus_tools.pepper.common.PepperModuleDesc

Sets the URI to the homepage describing the functionality of the module.

getSupplierHomepage() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

getSupplierHomepage() - Method in interface org.corpus_tools.pepper.modules.PepperModule

Sets the URI to the homepage describing the functionality of the module.

getSupportedFormats() - Method in class org.corpus_tools.pepper.common.PepperModuleDesc

Returns a list of FormatDesc objects describing all formats supported by the Pepper module, this object describes.

getSupportedFormats() - Method in class org.corpus_tools.pepper.impl.PepperExporterImpl

TODO docu

getSupportedFormats() - Method in class org.corpus_tools.pepper.impl.PepperImporterImpl

Returns a list of formats, which are importable by this PepperImporter object.

getSupportedFormats() - Method in interface org.corpus_tools.pepper.modules.PepperExporter

TODO docu

getSupportedFormats() - Method in interface org.corpus_tools.pepper.modules.PepperImporter

Returns a list of formats, which are importable by this PepperImporter object.

getSymbolicName() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Returns the symbolic name of this OSGi bundle.

getSymbolicName() - Method in interface org.corpus_tools.pepper.modules.PepperModule

Returns the symbolic name of this OSGi bundle.

getTempFile() - Static method in class org.corpus_tools.pepper.common.PepperUtil

Returns a temporary folder, where Pepper and all modules can store temp files.

getTempFile(String) - Static method in class org.corpus_tools.pepper.common.PepperUtil

Returns a temporary folder, where Pepper and all modules can store temp files.

getTempFile(String, String) - Static method in class org.corpus_tools.pepper.common.PepperUtil

Returns a temporary folder, where Pepper and all modules can store temp files.

getTempPath() - Method in class org.corpus_tools.pepper.common.PepperConfiguration

Returns a temporary path, where the entire system and all modules can store temp files.

getTempPath(String) - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper

Returns a File object pointing to a temporary path, where the caller can store temporary files.

getTempPath_static(String) - Static method in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper

getTempPath_static(String) - Static method in class org.corpus_tools.pepper.testFramework.PepperTestUtil

Returns a File object pointing to a temporary path, where the caller can store temporary files.

getTemproraries() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Deprecated.

getTemproraries() - Method in interface org.corpus_tools.pepper.modules.PepperModule

Deprecated.

getTempTestFile(String) - Static method in class org.corpus_tools.pepper.common.PepperUtil

Returns a temporary folder, where all tests can store temporary files.

getTempTestFile() - Static method in class org.corpus_tools.pepper.common.PepperUtil

Returns a temporary folder, where all tests can store temporary files.

getTempURI(String) - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper

Returns a File object pointing to a temporary path, where the caller can store temporary files.

getTestResources() - Static method in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper

getTestResources() - Static method in class org.corpus_tools.pepper.testFramework.PepperTestUtil

Returns a default test folder, where to find resources for tests.

getType() - Method in class org.corpus_tools.pepper.modules.PepperModuleProperty

getValue() - Method in enum org.corpus_tools.pepper.common.DOCUMENT_STATUS

Returns the level of the object in level hierarchie.

getValue() - Method in class org.corpus_tools.pepper.modules.PepperModuleProperty

getVersion() - Method in class org.corpus_tools.pepper.common.PepperModuleDesc

Returns the version of a Pepper module described by this PepperModuleDesc object.

getVersion() - Method in class org.corpus_tools.pepper.common.StepDesc

Returns the version of the PepperModule to be used for this step.

getVersion() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Returns the version of this module.

getVersion() - Method in interface org.corpus_tools.pepper.modules.PepperModule

Returns the version of this module.

getWorkspace() - Method in class org.corpus_tools.pepper.common.PepperConfiguration

Returns the default workspace for PepperJobImpl objects, if one is given in configuration.

getXFilesWithExtension(int, int, String) - Method in class org.corpus_tools.pepper.impl.CorpusPathResolver

groupFilesByEnding(URI) - Method in class org.corpus_tools.pepper.impl.CorpusPathResolver

Groups files for their file ending into a multimap.

H

hashCode() - Method in class org.corpus_tools.pepper.common.FormatDesc

This method is overwritten because of findbugs.

hashCode() - Method in class org.corpus_tools.pepper.common.ModuleFitness

hashCode() - Method in class org.corpus_tools.pepper.common.PepperModuleDesc

This method was overwritten because of a findbugs warning

hashCode() - Method in class org.corpus_tools.pepper.core.SelfTestDesc

hashCode() - Method in class org.corpus_tools.pepper.modules.PepperModuleProperty

HOMEPAGE - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

pepper-homepage

hp - Variable in class org.corpus_tools.pepper.common.PepperModuleDesc

I

id - Variable in class org.corpus_tools.pepper.common.PepperJob

Identifier of this job.

id - Variable in class org.corpus_tools.pepper.core.DocumentBus

Id of this object.

id - Variable in class org.corpus_tools.pepper.core.ModuleControllerImpl

id of this object

ID_INTITIAL - Static variable in class org.corpus_tools.pepper.core.InitialDocumentBus

id for the initial document bus, which is input for importers

ID_TERMINAL - Static variable in class org.corpus_tools.pepper.core.TerminalDocumentBus

id for the terminal document bus, which is output for exporters

importCorpusStructure(SCorpusGraph) - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

Starts the import of corpus structure via the set PepperImporter object by calling PepperImporter.importCorpusStructure(SCorpusGraph).

importCorpusStructure(SCorpusGraph) - Method in class org.corpus_tools.pepper.impl.PepperImporterImpl

This method is called by Pepper at the start of a conversion process to create the corpus-structure.

importCorpusStructure(SCorpusGraph) - Method in class org.corpus_tools.pepper.modules.coreModules.DoNothingImporter

importCorpusStructure(SCorpusGraph) - Method in class org.corpus_tools.pepper.modules.coreModules.SaltXMLImporter

Imports the corpus-structure by a call of SaltProject#loadSCorpusStructure(URI)

importCorpusStructure(SCorpusGraph) - Method in interface org.corpus_tools.pepper.modules.ModuleController

Starts the import of corpus structure via the set PepperImporter object by calling PepperImporter.importCorpusStructure(SCorpusGraph).

importCorpusStructure(SCorpusGraph) - Method in interface org.corpus_tools.pepper.modules.PepperImporter

This method is called by Pepper at the start of a conversion process to create the corpus-structure.

importCorpusStructureRec(URI, SCorpus) - Method in class org.corpus_tools.pepper.impl.PepperImporterImpl

Top down traversal in file given structure.

importCorpusStructures() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Imports corpus structures of all registered ImportCorpusStructureTest steps.

init(List<String>, List<String>) - Method in class org.corpus_tools.pepper.core.DocumentBus

Creates an object of this type and passes all output ModuleController objects.

initDocumentBus(List<String>) - Method in class org.corpus_tools.pepper.core.DocumentBus

Initializes the table, which is the central management object of the DocumentBus.

InitialDocumentBus - Class in org.corpus_tools.pepper.core

TODO make docu

InitialDocumentBus(String) - Constructor for class org.corpus_tools.pepper.core.InitialDocumentBus

Creates an object of this type and sets the passes the given input controller and output controller.

InitialDocumentBus(List<String>) - Constructor for class org.corpus_tools.pepper.core.InitialDocumentBus

Creates an object of this type and sets the passes the given input controller and output controller.

initialDocumentBuses - Variable in class org.corpus_tools.pepper.core.PepperJobImpl

all documentBusses which are connected with PepperImporter modules

initialize() - Method in class org.corpus_tools.pepper.impl.PepperMapperImpl

This method initializes this object and is called by the constructor.

initialize() - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper

Initializes this object.

inProgress - Variable in class org.corpus_tools.pepper.core.PepperJobImpl

Specifies if this job currently runs a conversion.

inputModuleControllerIds - Variable in class org.corpus_tools.pepper.core.DocumentBus

A list of Ids belonging to ModuleController objects on the input side.

isAsleep() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Returns if the SDocumentGraph of contained SDocument is send to sleep or awake.

isAsleep() - Method in interface org.corpus_tools.pepper.modules.DocumentController

Returns if the SDocumentGraph of contained SDocument is send to sleep or awake.

isClean() - Method in class org.corpus_tools.pepper.modules.coreModules.SaltValidatorProperties

isFinished() - Method in class org.corpus_tools.pepper.core.DocumentBus

Returns true, whether all input ModuleController objects called the DocumentBus.finish(String) method and set this object to status finish.

isImportable(URI) - Method in class org.corpus_tools.pepper.impl.PepperImporterImpl

This method is called by Pepper and returns if a corpus located at the given URI is importable by this importer.

isImportable(URI) - Method in class org.corpus_tools.pepper.modules.coreModules.DoNothingImporter

isImportable(URI) - Method in class org.corpus_tools.pepper.modules.coreModules.SaltXMLImporter

Reads recursively first found file and returns 1.0 if file contains: <?

isImportable(URI) - Method in class org.corpus_tools.pepper.modules.coreModules.TextImporter

isImportable(URI) - Method in interface org.corpus_tools.pepper.modules.PepperImporter

This method is called by Pepper and returns if a corpus located at the given URI is importable by this importer.

isImportedCorpusStructure - Variable in class org.corpus_tools.pepper.core.PepperJobImpl

flag to determine, if corpus structure has already been imported

isInProgress() - Method in enum org.corpus_tools.pepper.common.JOB_STATUS

Returns whether the status determines, that the Pepper job is still in progress.

isMultithreaded - Variable in class org.corpus_tools.pepper.impl.PepperModuleImpl

isMultithreaded() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Returns whether this PepperModule is able to run multithreaded.

isMultithreaded() - Method in interface org.corpus_tools.pepper.modules.PepperModule

Returns whether this PepperModule is able to run multithreaded.

isNotNullOrEmpty(Collection<T>) - Static method in class org.corpus_tools.pepper.common.PepperUtil

Checks whether a collection is not null nor empty

isNullOrEmpty(Collection<T>) - Static method in class org.corpus_tools.pepper.common.PepperUtil

Checks whether a collection is null or empty

isReadyToStart - Variable in class org.corpus_tools.pepper.core.PepperJobImpl

Determines if PepperJobImpl.checkReadyToStart() was already called

isReadyToStart() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

This method is called by the pepper framework after initializing this object and directly before start processing.

isReadyToStart() - Method in interface org.corpus_tools.pepper.modules.PepperModule

This method is called by the pepper framework after initializing this object and directly before start processing.

isRequired() - Method in class org.corpus_tools.pepper.modules.PepperModuleProperty

isRequired(boolean) - Method in class org.corpus_tools.pepper.modules.PepperModuleProperty.NameBuilder.TypeBuilder.DescriptionBuilder.Builder

isSelfRelation() - Method in class org.corpus_tools.pepper.modules.coreModules.SaltValidatorProperties

isStarted - Variable in class org.corpus_tools.pepper.core.DocumentControllerImpl

Determines, if this object is already 'started', which means if #updateStatus(String, DOCUMENT_STATUS) has been called.

isStop() - Method in class org.corpus_tools.pepper.common.PepperUtil.PepperJobReporter

Returns, if PepperJob still has to be observed

isValid(Collection<String>) - Method in class org.corpus_tools.pepper.core.SelfTestDesc

Returns whether this object was correctly instantiated by module.

isWired - Variable in class org.corpus_tools.pepper.core.PepperJobImpl

Determines, if steps are already wired.

J

JOB_STATUS - Enum in org.corpus_tools.pepper.common

Status of a job in Pepper, the status could be one of the following: JOB_STATUS.NOT_STARTED, if the job was not started #IN_PROGRESS, if the job is running JOB_STATUS.ENDED, if the job ended successful JOB_STATUS.ENDED_WITH_ERRORS, if the job ended with errors

JobNotFoundException - Exception in org.corpus_tools.pepper.exceptions

This exception class is used, in case of a PepperMapper object was not correctly initialized.

JobNotFoundException() - Constructor for exception org.corpus_tools.pepper.exceptions.JobNotFoundException

JobNotFoundException(String) - Constructor for exception org.corpus_tools.pepper.exceptions.JobNotFoundException

JobNotFoundException(String, Throwable) - Constructor for exception org.corpus_tools.pepper.exceptions.JobNotFoundException

join() - Method in interface org.corpus_tools.pepper.modules.PepperMapperController

Thread.join() Waits for this thread to die.

L

load(File) - Method in class org.corpus_tools.pepper.common.PepperConfiguration

Loads the configuration from the passed file location

load(ComponentContext) - Method in class org.corpus_tools.pepper.common.PepperConfiguration

Resolves the location of the bundle by the given ComponentContext and loads the configuration file.

load(URI) - Method in class org.corpus_tools.pepper.common.PepperJob

Loads a serialization of a PepperJob and fills this object with these entries.

load(URI) - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Loads a serialization of a PepperJob and fills this object with these entries.

lock - Variable in class org.corpus_tools.pepper.core.DocumentBus

This lock is used for creating the condition DocumentBus.waitUntilAllDocumentsArePut to let the DocumentBus.pop(String) method wait until all documents have been put.

logger - Variable in class org.corpus_tools.pepper.impl.PepperMapperControllerImpl

logger - Variable in class org.corpus_tools.pepper.impl.PepperModuleImpl

logger - Static variable in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper

M

map() - Method in class org.corpus_tools.pepper.impl.PepperMapperControllerImpl

This method starts the PepperMapper object.

map() - Method in interface org.corpus_tools.pepper.modules.PepperMapperController

This method starts the PepperMapper object.

mappingResult - Variable in class org.corpus_tools.pepper.modules.MappingSubject

MappingSubject - Class in org.corpus_tools.pepper.modules

A subject is a container for SDocument or SCorpus object to be merged.

MappingSubject() - Constructor for class org.corpus_tools.pepper.modules.MappingSubject

mapSCorpus() - Method in class org.corpus_tools.pepper.impl.PepperMapperImpl

Starts to map a given SCorpus object, if one is given.

mapSCorpus() - Method in class org.corpus_tools.pepper.modules.coreModules.SaltValidator.ValidatorMapper

Checks whether each SCorpus object contains either a SCorpus object or a SDocument object.

mapSCorpus() - Method in interface org.corpus_tools.pepper.modules.PepperMapper

Starts to map a given SCorpus object, if one is given.

mapSDocument() - Method in class org.corpus_tools.pepper.impl.PepperMapperImpl

Starts to map a given SDocument object, if one is given.

mapSDocument() - Method in class org.corpus_tools.pepper.modules.coreModules.SaltValidator.ValidatorMapper

Checks whether STextualDS.getText() is not empty when an STextualRelation is pointing to it.

mapSDocument() - Method in class org.corpus_tools.pepper.modules.coreModules.TextImporter.TextMapper

Reads txt files and maps their content to a STextualDS object.

mapSDocument() - Method in interface org.corpus_tools.pepper.modules.PepperMapper

Starts to map a given SDocument object, if one is given.

MEMORY_POLICY - Enum in org.corpus_tools.pepper.common

Describes the main memory policy of PepperJobs.

memPolicy - Variable in class org.corpus_tools.pepper.core.DocumentBus

memPolicy - Variable in class org.corpus_tools.pepper.core.PepperJobImpl

MODULE_NAME - Static variable in class org.corpus_tools.pepper.modules.coreModules.DoNothingExporter

MODULE_NAME - Static variable in class org.corpus_tools.pepper.modules.coreModules.DoNothingImporter

MODULE_NAME - Static variable in class org.corpus_tools.pepper.modules.coreModules.DoNothingManipulator

MODULE_NAME - Static variable in class org.corpus_tools.pepper.modules.coreModules.SaltXMLExporter

MODULE_NAME - Static variable in class org.corpus_tools.pepper.modules.coreModules.SaltXMLImporter

MODULE_NAME - Static variable in class org.corpus_tools.pepper.modules.coreModules.TextExporter

MODULE_NAME - Static variable in class org.corpus_tools.pepper.modules.coreModules.TextImporter

MODULE_TYPE - Enum in org.corpus_tools.pepper.common

Names of types of PepperModule: MODULE_TYPE.IMPORTER - for PepperExporter MODULE_TYPE.MANIPULATOR - for PepperManipulator MODULE_TYPE.EXPORTER - for PepperExporter

moduleController - Variable in class org.corpus_tools.pepper.impl.PepperModuleImpl

the controller object, which acts as bridge between Pepper framework and Pepper module.

ModuleController - Interface in org.corpus_tools.pepper.modules

An object of this types contains a PepperModule and handles as a connector between such an object and the Pepper framework.

ModuleControllerImpl - Class in org.corpus_tools.pepper.core

An object of this types contains a PepperModule and handles as a connector between such an object and the Pepper framework.

ModuleControllerImpl(String) - Constructor for class org.corpus_tools.pepper.core.ModuleControllerImpl

Creates an instance of ModuleControllerImpl.

moduleControllers - Variable in class org.corpus_tools.pepper.core.DocumentControllerImpl

A list of all ModuleControllerImpl objects, the here contained SDocument object has to pass.

ModuleFitness - Class in org.corpus_tools.pepper.common

An object determining the fitness of a single Pepper module.

ModuleFitness(String) - Constructor for class org.corpus_tools.pepper.common.ModuleFitness

ModuleFitness.Fitness - Enum in org.corpus_tools.pepper.common

ModuleFitness.FitnessFeature - Enum in org.corpus_tools.pepper.common

ModuleFitness.ModuleFitnessBuilder - Class in org.corpus_tools.pepper.common

A simple builder to create ModuleFitness objects.

ModuleFitnessBuilder(String) - Constructor for class org.corpus_tools.pepper.common.ModuleFitness.ModuleFitnessBuilder

ModuleFitnessChecker - Class in org.corpus_tools.pepper.core

A helper class for checking health and fitness of a module or a set of modules.

ModuleFitnessChecker(Pepper) - Constructor for class org.corpus_tools.pepper.core.ModuleFitnessChecker

ModuleFitnessChecker() - Constructor for class org.corpus_tools.pepper.core.ModuleFitnessChecker

ModuleResolver - Interface in org.corpus_tools.pepper.core

moduleResolver - Variable in class org.corpus_tools.pepper.core.PepperJobImpl

A reference to the OSGi module resolver, to find modules matching to the step description

ModuleResolverImpl - Class in org.corpus_tools.pepper.core

The ModuleResolverImpl realizes a bridge between the Pepper framework and the OSGi environment.

ModuleResolverImpl() - Constructor for class org.corpus_tools.pepper.core.ModuleResolverImpl

TODO make docu

MSG_PREFIX - Static variable in exception org.corpus_tools.pepper.exceptions.WorkflowException

N

NameBuilder() - Constructor for class org.corpus_tools.pepper.modules.PepperModuleProperty.NameBuilder

NEGATIVE_FILE_EXTENSION_MARKER - Static variable in interface org.corpus_tools.pepper.modules.PepperImporter

A character or character sequence to mark a file extension as not to be one of the imported ones.

next(boolean) - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

Returns the next DocumentController waiting in the input document bus to be processed by the contained PepperModule.

next() - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

Returns the next DocumentController waiting in the input document bus to be processed by the contained PepperModule.

next(boolean) - Method in interface org.corpus_tools.pepper.modules.ModuleController

Returns the next DocumentController waiting in the input document bus to be processed by the contained PepperModule.

next() - Method in interface org.corpus_tools.pepper.modules.ModuleController

Returns the next DocumentController waiting in the input document bus to be processed by the contained PepperModule.

NotInitializedException - Exception in org.corpus_tools.pepper.exceptions

This exception class is used, in case of a PepperMapper object was not correctly initialized.

NotInitializedException() - Constructor for exception org.corpus_tools.pepper.exceptions.NotInitializedException

NotInitializedException(String) - Constructor for exception org.corpus_tools.pepper.exceptions.NotInitializedException

NotInitializedException(String, Throwable) - Constructor for exception org.corpus_tools.pepper.exceptions.NotInitializedException

NS_PEPPERPARAMS - Static variable in class org.corpus_tools.pepper.core.PepperParamsReader

NS_XMI - Static variable in class org.corpus_tools.pepper.core.PepperParamsReader

NUMBER_OF_SAMPLED_FILES - Static variable in class org.corpus_tools.pepper.impl.CorpusPathResolver

The number of files which are read for sampling when invoking #findAppropriateImporters(URI).

NUMBER_OF_SAMPLED_LINES - Static variable in class org.corpus_tools.pepper.impl.CorpusPathResolver

The number of lines in a file which are read for sampling when invoking #findAppropriateImporters(URI).

numberOfProcessingModules - Variable in class org.corpus_tools.pepper.core.DocumentControllerImpl

Stores the number of PepperModule, currently processing this DocumentControllerImpl.

O

org.corpus_tools.pepper.common - package org.corpus_tools.pepper.common

org.corpus_tools.pepper.core - package org.corpus_tools.pepper.core

org.corpus_tools.pepper.exceptions - package org.corpus_tools.pepper.exceptions

org.corpus_tools.pepper.impl - package org.corpus_tools.pepper.impl

org.corpus_tools.pepper.modules - package org.corpus_tools.pepper.modules

org.corpus_tools.pepper.modules.coreModules - package org.corpus_tools.pepper.modules.coreModules

org.corpus_tools.pepper.modules.exceptions - package org.corpus_tools.pepper.modules.exceptions

org.corpus_tools.pepper.testFramework - package org.corpus_tools.pepper.testFramework

org.corpus_tools.pepper.testFramework.helpers - package org.corpus_tools.pepper.testFramework.helpers

org.corpus_tools.pepper.util - package org.corpus_tools.pepper.util

outputModuleControllerIds - Variable in class org.corpus_tools.pepper.core.DocumentBus

A list of Ids belonging to ModuleController objects, which are on the output side of this queue.

P

Pepper - Interface in org.corpus_tools.pepper.common

PepperConfiguration - Class in org.corpus_tools.pepper.common

This class contains all possible configurations, to take influence on the Pepper process.

PepperConfiguration() - Constructor for class org.corpus_tools.pepper.common.PepperConfiguration

Standard constructor which initializes this object with default values: "pepper.gcAfterDocumentSleep"= "pepper.memPolicy"= "pepper.maxAmountOfProcessedSDocuments"= 10

PepperConfiguration(Properties) - Constructor for class org.corpus_tools.pepper.common.PepperConfiguration

Initializes a new object and copies all properties of the given Properties object.

PepperConfigurationException - Exception in org.corpus_tools.pepper.exceptions

Is thrown, when any exception occurs concerning the configuration of Pepper.

PepperConfigurationException() - Constructor for exception org.corpus_tools.pepper.exceptions.PepperConfigurationException

PepperConfigurationException(String) - Constructor for exception org.corpus_tools.pepper.exceptions.PepperConfigurationException

PepperConfigurationException(String, Throwable) - Constructor for exception org.corpus_tools.pepper.exceptions.PepperConfigurationException

PepperConvertException - Exception in org.corpus_tools.pepper.exceptions

PepperConvertException() - Constructor for exception org.corpus_tools.pepper.exceptions.PepperConvertException

PepperConvertException(String) - Constructor for exception org.corpus_tools.pepper.exceptions.PepperConvertException

PepperConvertException(String, Throwable) - Constructor for exception org.corpus_tools.pepper.exceptions.PepperConvertException

PepperException - Exception in org.corpus_tools.pepper.exceptions

This class is highest exception.

PepperException() - Constructor for exception org.corpus_tools.pepper.exceptions.PepperException

PepperException(String) - Constructor for exception org.corpus_tools.pepper.exceptions.PepperException

PepperException(String, Throwable) - Constructor for exception org.corpus_tools.pepper.exceptions.PepperException

PepperExporter - Interface in org.corpus_tools.pepper.modules

A mapping task in the Pepper workflow is not a monolithic block.

PepperExporter.EXPORT_MODE - Enum in org.corpus_tools.pepper.modules

Determines how the corpus-structure should be exported.

pepperExporterComponentFactories - Variable in class org.corpus_tools.pepper.core.ModuleResolverImpl

TODO make docu

pepperExporterComponentFactory - Variable in class org.corpus_tools.pepper.core.ModuleResolverImpl

This unnecessary variable must be initialized, because of restrictions of the maven osgi scr plugin.

PepperExporterImpl - Class in org.corpus_tools.pepper.impl

This class is an abstract implementation of PepperExporter and cannot be instantiated directly.

PepperExporterImpl() - Constructor for class org.corpus_tools.pepper.impl.PepperExporterImpl

Creates a PepperModule of type MODULE_TYPE.EXPORTER.

PepperExporterImpl(String) - Constructor for class org.corpus_tools.pepper.impl.PepperExporterImpl

Creates a PepperModule of type MODULE_TYPE.EXPORTER and sets is name to the passed one.

PepperExporterTest - Class in org.corpus_tools.pepper.testFramework

This class is a helper class for creating tests for PepperExporters.

PepperExporterTest() - Constructor for class org.corpus_tools.pepper.testFramework.PepperExporterTest

PepperFWException - Exception in org.corpus_tools.pepper.exceptions

This PepperException is thrown if an internal error occurs.

PepperFWException() - Constructor for exception org.corpus_tools.pepper.exceptions.PepperFWException

PepperFWException(String) - Constructor for exception org.corpus_tools.pepper.exceptions.PepperFWException

PepperFWException(String, Throwable) - Constructor for exception org.corpus_tools.pepper.exceptions.PepperFWException

PepperImExporterTest - Class in org.corpus_tools.pepper.testFramework.helpers

PepperImExporterTest() - Constructor for class org.corpus_tools.pepper.testFramework.helpers.PepperImExporterTest

PepperImpl - Class in org.corpus_tools.pepper.core

PepperImpl() - Constructor for class org.corpus_tools.pepper.core.PepperImpl

PepperImporter - Interface in org.corpus_tools.pepper.modules

A mapping task in the Pepper workflow is not a monolithic block.

pepperImporterComponentFactories - Variable in class org.corpus_tools.pepper.core.ModuleResolverImpl

TODO make docu

pepperImporterComponentFactory - Variable in class org.corpus_tools.pepper.core.ModuleResolverImpl

This unnecessary variable must be initialized, because of restrictions of the maven osgi scr plugin.

PepperImporterImpl - Class in org.corpus_tools.pepper.impl

An importer in Pepper reads data from a format A and maps its data to a Salt model.

PepperImporterImpl() - Constructor for class org.corpus_tools.pepper.impl.PepperImporterImpl

Creates a PepperModule of type MODULE_TYPE.IMPORTER.

PepperImporterImpl(String) - Constructor for class org.corpus_tools.pepper.impl.PepperImporterImpl

Creates a PepperModule of type MODULE_TYPE.IMPORTER and sets is name to the passed one.

PepperImporterTest - Class in org.corpus_tools.pepper.testFramework

This class is a helper class for creating tests for PepperImporters.

PepperImporterTest() - Constructor for class org.corpus_tools.pepper.testFramework.PepperImporterTest

PepperInActionException - Exception in org.corpus_tools.pepper.exceptions

This PepperException is thrown if a calling method tries to start a new process or an action or tries to get access to a resource, but it currently is in action and therefore can not be accessed.

PepperInActionException() - Constructor for exception org.corpus_tools.pepper.exceptions.PepperInActionException

PepperInActionException(String) - Constructor for exception org.corpus_tools.pepper.exceptions.PepperInActionException

PepperInActionException(String, Throwable) - Constructor for exception org.corpus_tools.pepper.exceptions.PepperInActionException

PepperJob - Class in org.corpus_tools.pepper.common

PepperJob() - Constructor for class org.corpus_tools.pepper.common.PepperJob

PepperJobImpl - Class in org.corpus_tools.pepper.core

This class represents a single, but entire conversion process in Pepper, containing the entire workflow like import, manipulation and export.

PepperJobImpl(String) - Constructor for class org.corpus_tools.pepper.core.PepperJobImpl

Initializes a PepperJobImpl and sets its unique identifier.

PepperJobReporter(PepperJob, int) - Constructor for class org.corpus_tools.pepper.common.PepperUtil.PepperJobReporter

Sets the PepperJob object, which is observed

PepperJobReporter(PepperJob) - Constructor for class org.corpus_tools.pepper.common.PepperUtil.PepperJobReporter

Sets the PepperJob object, which is observed

PepperManipulator - Interface in org.corpus_tools.pepper.modules

A mapping task in the Pepper workflow is not a monolithic block.

pepperManipulatorComponentFactories - Variable in class org.corpus_tools.pepper.core.ModuleResolverImpl

TODO make docu

pepperManipulatorComponentFactory - Variable in class org.corpus_tools.pepper.core.ModuleResolverImpl

This unnecessary variable must be initialized, because of restrictions of the maven osgi scr plugin.

PepperManipulatorImpl - Class in org.corpus_tools.pepper.impl

This class is an abstract implementation of PepperManipulator and cannot be instantiated directly.

PepperManipulatorImpl() - Constructor for class org.corpus_tools.pepper.impl.PepperManipulatorImpl

Creates a PepperModule of type MODULE_TYPE#.

PepperManipulatorImpl(String) - Constructor for class org.corpus_tools.pepper.impl.PepperManipulatorImpl

Creates a PepperModule of type MODULE_TYPE.MANIPULATOR and sets is name to the passed one.

PepperManipulatorTest - Class in org.corpus_tools.pepper.testFramework

This class is a helper class for creating tests for PepperManipulator s.

PepperManipulatorTest() - Constructor for class org.corpus_tools.pepper.testFramework.PepperManipulatorTest

PepperMapper - Interface in org.corpus_tools.pepper.modules

This interface can be used in a threaded environment, where the PepperModule is used for delegating thread jobs, and a set of PepperMappers are mapping one SDocument or SCorpus object.

PepperMapperController - Interface in org.corpus_tools.pepper.modules

The interface PepperMapperController is a communicator class between a PepperModule and a PepperMapper object.

PepperMapperControllerImpl - Class in org.corpus_tools.pepper.impl

The class PepperMapperControllerImpl is a communicator class between a PepperModule and a PepperMapper object.

PepperMapperControllerImpl(ThreadGroup, String) - Constructor for class org.corpus_tools.pepper.impl.PepperMapperControllerImpl

Initializes this object and sets its ThreadGroup and the name of the thread.

PepperMapperImpl - Class in org.corpus_tools.pepper.impl

An abstract implementation of PepperMapper to be used for further derivations for specific mapping purposes.

PepperMapperImpl() - Constructor for class org.corpus_tools.pepper.impl.PepperMapperImpl

pepperModule - Variable in class org.corpus_tools.pepper.core.ModuleControllerImpl

The PepperModule object, this controller object is observing.

pepperModule - Variable in class org.corpus_tools.pepper.impl.PepperMapperControllerImpl

PepperModule containing this object

PepperModule - Interface in org.corpus_tools.pepper.modules

TODO make some docu

PepperModuleDataException - Exception in org.corpus_tools.pepper.modules.exceptions

This PepperException is thrown only by a PepperModule.

PepperModuleDataException(PepperModule, String) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleDataException

PepperModuleDataException(PepperModule, String, Throwable) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleDataException

PepperModuleDataException(PepperMapper, String) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleDataException

PepperModuleDataException(PepperMapper, String, Throwable) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleDataException

PepperModuleDesc - Class in org.corpus_tools.pepper.common

This class is a kind of a fingerprint of a Pepper module and provides some information about a module.

PepperModuleDesc() - Constructor for class org.corpus_tools.pepper.common.PepperModuleDesc

PepperModuleException - Exception in org.corpus_tools.pepper.modules.exceptions

This exception is a concrete implementation of AbstractPepperModuleException and provides constructors to pass the PepperModule throwing this exception.

PepperModuleException() - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleException

PepperModuleException(String) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleException

PepperModuleException(String, Throwable) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleException

PepperModuleException(PepperModule, String) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleException

PepperModuleException(PepperModule, String, Throwable) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleException

PepperModuleException(PepperMapper, String) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleException

PepperModuleException(PepperMapper, String, Throwable) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleException

PepperModuleImpl - Class in org.corpus_tools.pepper.impl

TODO make docu

PepperModuleImpl() - Constructor for class org.corpus_tools.pepper.impl.PepperModuleImpl

Creates a PepperModule object, which is either a MODULE_TYPE.IMPORTER, a MODULE_TYPE.MANIPULATOR or a MODULE_TYPE.EXPORTER.

PepperModuleImpl(String) - Constructor for class org.corpus_tools.pepper.impl.PepperModuleImpl

Creates a PepperModule object, which is either a MODULE_TYPE.IMPORTER, a MODULE_TYPE.MANIPULATOR or a MODULE_TYPE.EXPORTER.

PepperModuleInternalException - Exception in org.corpus_tools.pepper.modules.exceptions

This PepperException is thrown only by a PepperModule.

PepperModuleInternalException(String) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleInternalException

PepperModuleInternalException(String, Throwable) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleInternalException

PepperModuleInternalException(PepperModule, String) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleInternalException

PepperModuleInternalException(PepperModule, String, Throwable) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleInternalException

PepperModuleInternalException(PepperMapper, String) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleInternalException

PepperModuleInternalException(PepperMapper, String, Throwable) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleInternalException

PepperModuleNotReadyException - Exception in org.corpus_tools.pepper.modules.exceptions

This PepperException is thrown only by a PepperModule and marks, that the module is not ready for the requested action.

PepperModuleNotReadyException() - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleNotReadyException

PepperModuleNotReadyException(String) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleNotReadyException

PepperModuleNotReadyException(String, Throwable) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleNotReadyException

PepperModuleProperties - Class in org.corpus_tools.pepper.modules

This class is a container for a set of PepperModuleProperty objects.

PepperModuleProperties() - Constructor for class org.corpus_tools.pepper.modules.PepperModuleProperties

Creates instance of PepperModuleProperties and initializes it with a set of customization properties.

pepperModuleProperties - Variable in class org.corpus_tools.pepper.modules.PepperModuleProperties

Internal map to map all PepperModuleProperty objects to their name.

PepperModuleProperty<T> - Class in org.corpus_tools.pepper.modules

With properties, the conversion process done by a Pepper module can be customized.

PepperModuleProperty(String, Class<T>, String) - Constructor for class org.corpus_tools.pepper.modules.PepperModuleProperty

Deprecated.

will be removed with Pepper 4.0

PepperModuleProperty(String, Class<T>, String, T) - Constructor for class org.corpus_tools.pepper.modules.PepperModuleProperty

Deprecated.

will be removed with Pepper 4.0

PepperModuleProperty(String, Class<T>, String, boolean) - Constructor for class org.corpus_tools.pepper.modules.PepperModuleProperty

Deprecated.

will be removed with Pepper 4.0

PepperModuleProperty(String, Class<T>, String, T, boolean) - Constructor for class org.corpus_tools.pepper.modules.PepperModuleProperty

Deprecated.

the visibility of this method will be set to private

PepperModuleProperty.NameBuilder - Class in org.corpus_tools.pepper.modules

PepperModuleProperty.NameBuilder.TypeBuilder - Class in org.corpus_tools.pepper.modules

PepperModuleProperty.NameBuilder.TypeBuilder.DescriptionBuilder<T> - Class in org.corpus_tools.pepper.modules

PepperModuleProperty.NameBuilder.TypeBuilder.DescriptionBuilder.Builder<T> - Class in org.corpus_tools.pepper.modules

PepperModulePropertyException - Exception in org.corpus_tools.pepper.modules.exceptions

Exception is used in case of an exception occurs concerning PepperModuleProperty .

PepperModulePropertyException() - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModulePropertyException

PepperModulePropertyException(String) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModulePropertyException

PepperModulePropertyException(String, Throwable) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModulePropertyException

PepperModuleTest - Class in org.corpus_tools.pepper.testFramework.helpers

This class is an abstract helper class to create own test classes for any PepperModule.

PepperModuleTest() - Constructor for class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTest

PepperModuleTestException - Exception in org.corpus_tools.pepper.modules.exceptions

This Exception class can be used for Tests (i.e.

PepperModuleTestException() - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleTestException

PepperModuleTestException(String) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleTestException

PepperModuleTestException(String, Throwable) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleTestException

PepperModuleTestException(PepperModule, String) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleTestException

PepperModuleTestException(PepperModule, String, Throwable) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleTestException

PepperModuleTestHelper - Class in org.corpus_tools.pepper.testFramework.helpers

PepperModuleTestHelper() - Constructor for class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper

Creates an object of type PepperModuleTest.

PepperModuleXMLResourceException - Exception in org.corpus_tools.pepper.modules.exceptions

This PepperException is thrown by a PepperModule.

PepperModuleXMLResourceException() - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleXMLResourceException

PepperModuleXMLResourceException(String) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleXMLResourceException

PepperModuleXMLResourceException(String, Throwable) - Constructor for exception org.corpus_tools.pepper.modules.exceptions.PepperModuleXMLResourceException

PepperOSGiRunner - Class in org.corpus_tools.pepper.core

Only starts pepper-osgi-runner, if "org.corpus_tools.pepper.disableTest" is not set or is set to false.

PepperOSGiRunner() - Constructor for class org.corpus_tools.pepper.core.PepperOSGiRunner

PepperOSGiRunnerException - Exception in org.corpus_tools.pepper.exceptions

This exception is only to use for unit tests.

PepperOSGiRunnerException() - Constructor for exception org.corpus_tools.pepper.exceptions.PepperOSGiRunnerException

PepperOSGiRunnerException(String) - Constructor for exception org.corpus_tools.pepper.exceptions.PepperOSGiRunnerException

PepperOSGiRunnerException(String, Throwable) - Constructor for exception org.corpus_tools.pepper.exceptions.PepperOSGiRunnerException

PepperParamsReader - Class in org.corpus_tools.pepper.core

This class reads the 'old' pepperParams file and fills a PepperJob with the content of the file.

PepperParamsReader() - Constructor for class org.corpus_tools.pepper.core.PepperParamsReader

PepperTestException - Exception in org.corpus_tools.pepper.exceptions

This PepperException is thrown if an internal error occurs.

PepperTestException() - Constructor for exception org.corpus_tools.pepper.exceptions.PepperTestException

PepperTestException(String) - Constructor for exception org.corpus_tools.pepper.exceptions.PepperTestException

PepperTestException(String, Throwable) - Constructor for exception org.corpus_tools.pepper.exceptions.PepperTestException

PepperTestUtil - Class in org.corpus_tools.pepper.testFramework

This class offers some static fields and methods for testing PepperModule objects.

PepperTestUtil() - Constructor for class org.corpus_tools.pepper.testFramework.PepperTestUtil

PepperUtil - Class in org.corpus_tools.pepper.common

PepperUtil() - Constructor for class org.corpus_tools.pepper.common.PepperUtil

PepperUtil.PepperJobReporter - Class in org.corpus_tools.pepper.common

Prints the status of the passed PepperJob object, until #setStop(Boolean#TRUE) was called.

pop(String) - Method in class org.corpus_tools.pepper.core.DocumentBus

Returns a DocumentController object, which is on first place of the internal queue (regarding the FIFO principle).

pop(String, boolean) - Method in class org.corpus_tools.pepper.core.DocumentBus

Returns a DocumentController object, which is on first place of the internal queue (regarding the FIFO principle).

pop(String, boolean) - Method in class org.corpus_tools.pepper.core.TerminalDocumentBus

pop(String) - Method in class org.corpus_tools.pepper.core.TerminalDocumentBus

Returns a DocumentController object, which is on first place of the internal queue (regarding the FIFO principle).

PREFIX - Static variable in class org.corpus_tools.pepper.modules.coreModules.DOTManipulatorProperties

PREFIX_PEPPERPARAMS - Static variable in class org.corpus_tools.pepper.core.PepperParamsReader

PREFIX_XMI - Static variable in class org.corpus_tools.pepper.core.PepperParamsReader

prepareFixturesAndCreateJob(Pepper, Collection<? extends PepperModule>) - Static method in class org.corpus_tools.pepper.testFramework.PepperTestUtil

processDocumentStructures() - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

Starts the import of document-structure.

progress - Variable in class org.corpus_tools.pepper.impl.PepperMapperControllerImpl

when PepperMapperControllerImpl.getPepperMapper() is set to null, in PepperMapperControllerImpl.map(), the progress value has to be stored here.

progress - Variable in class org.corpus_tools.pepper.impl.PepperMapperImpl

Stores the current progress (between 0 and 1)

PROP_AFTER_ADD_SLAYER - Static variable in class org.corpus_tools.pepper.modules.PepperModuleProperties

PROP_AFTER_COPY_RES - Static variable in class org.corpus_tools.pepper.modules.PepperModuleProperties

PROP_AFTER_REMOVE_ANNOTATIONS - Static variable in class org.corpus_tools.pepper.modules.PepperModuleProperties

PROP_AFTER_RENAME_ANNOTATIONS - Static variable in class org.corpus_tools.pepper.modules.PepperModuleProperties

PROP_AFTER_REPORT_CORPUSGRAPH - Static variable in class org.corpus_tools.pepper.modules.PepperModuleProperties

PROP_AFTER_TOKENIZE - Static variable in class org.corpus_tools.pepper.modules.PepperModuleProperties

PROP_BEFORE_ADD_SLAYER - Static variable in class org.corpus_tools.pepper.modules.PepperModuleProperties

PROP_BEFORE_READ_META - Static variable in class org.corpus_tools.pepper.modules.PepperModuleProperties

PROP_CALL_GC_AFTER_DOCUMENT - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

Name of property, to determine, if the garbage collector should run after a SDocument has been send to sleep when it waits in DocumentBus between to steps.

PROP_CLEAN - Static variable in class org.corpus_tools.pepper.modules.coreModules.SaltValidatorProperties

PROP_COMPUTE_PERFORMANCE - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

flag if Pepper shall measure and display the performance of the used PepperModules

PROP_DETAILED_STATUS_REPORT - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

Name of the property to determine Property to determine whether the status report should contain a progress for each module or just the global progress.

PROP_FILE_ENDING - Static variable in class org.corpus_tools.pepper.modules.coreModules.DOTManipulatorProperties

PROP_KEEP_TEMP_DOCS - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

name of the flag to determine whether the temporary created document-graph files should be preserved or deleted after Pepper terminates.

PROP_MAX_AMOUNT_OF_SDOCUMENTS - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

the maximal number of currently processed SDocument-objects

PROP_MEMORY_POLICY - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

Name of property to set the memory policy, for instance to configure the behavior of loading documents.

PROP_OSGI_BUNDLES - Static variable in class org.corpus_tools.pepper.core.ModuleResolverImpl

name of system property to determine the locations of OSGi bundles

PROP_OUTPUTFILE - Static variable in class org.corpus_tools.pepper.modules.coreModules.DOTManipulatorProperties

PROP_PEPPER_MODULE_RESOURCES - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

PROP_PREFIX - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

flag if Pepper shall measure and display the performance of the used PepperModules

PROP_REPORT_INTERVAL - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

name of property to determine the time interval of the convert status report

PROP_SELF_RELATION - Static variable in class org.corpus_tools.pepper.modules.coreModules.SaltValidatorProperties

PROP_TEMP_FOLDER - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

Name of the property, which determines a temporary folder, where the framework and all modules can store temporary data.

PROP_TEST_DISABLED - Static variable in class org.corpus_tools.pepper.core.PepperOSGiRunner

PROP_WORKSPACE - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

name of the flag to determine a workspace for pepper, where all jobs are stored by default.

proposeImportOrder(SCorpusGraph) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

This method could be overridden, to make a proposal for the import order of SDocument objects.

proposeImportOrder(SCorpusGraph) - Method in interface org.corpus_tools.pepper.modules.PepperModule

This method could be overridden, to make a proposal for the import order of SDocument objects.

props - Variable in class org.corpus_tools.pepper.impl.PepperMapperImpl

PepperModuleProperties object containing user customizations to be observed during the mapping.

put(DocumentController) - Method in class org.corpus_tools.pepper.core.DocumentBus

Adds the given DocumentController object to the queue.

put(DocumentController) - Method in class org.corpus_tools.pepper.core.InitialDocumentBus

Adds the given DocumentController object to the queue.

R

readFilesGroupedByExtension - Variable in class org.corpus_tools.pepper.impl.CorpusPathResolver

readFirstLines(File, int) - Method in class org.corpus_tools.pepper.impl.CorpusPathResolver

Reads the first X lines of the passed file and returns them as a String

readMeta(Identifier) - Method in class org.corpus_tools.pepper.impl.BeforeAfterAction

Loads meta data form a meta data file and adds them to the object corresponding to the passed Identifier.

readXMLResource(DefaultHandler2, URI) - Static method in class org.corpus_tools.pepper.common.PepperUtil

Helper method to read an xml file with a DefaultHandler2 implementation given as contentHandler.

readXMLResource(DefaultHandler2, URI) - Method in class org.corpus_tools.pepper.impl.PepperImporterImpl

Helper method to read an xml file with a DefaultHandler2 implementation given as contentHandler.

readXMLResource(DefaultHandler2, URI) - Method in class org.corpus_tools.pepper.impl.PepperMapperImpl

Helper method to read an xml file with a DefaultHandler2 implementation given as contentHandler.

releaseDocument(DocumentController) - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Releases a document and reduces the internal counter for the number of currently processed documents (PepperJobImpl.getNumOfActiveDocuments()).

removeJob(String) - Method in interface org.corpus_tools.pepper.common.Pepper

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

removeJob(String) - Method in class org.corpus_tools.pepper.core.PepperImpl

removePepperExporterComponentFactory(ComponentFactory) - Method in interface org.corpus_tools.pepper.core.ModuleResolver

TODO make some docu

removePepperExporterComponentFactory(ComponentFactory) - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

TODO make some docu

removePepperImporterComponentFactory(ComponentFactory) - Method in interface org.corpus_tools.pepper.core.ModuleResolver

TODO make docu

removePepperImporterComponentFactory(ComponentFactory) - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

TODO make docu

removePepperManipulatorComponentFactory(ComponentFactory) - Method in interface org.corpus_tools.pepper.core.ModuleResolver

TODO make docu

removePepperManipulatorComponentFactory(ComponentFactory) - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

TODO make docu

removePropertyValue(String) - Method in class org.corpus_tools.pepper.modules.PepperModuleProperties

Removes the value of the property with the passed property name from the properties.

renameAnnotations(Identifier, String) - Method in class org.corpus_tools.pepper.impl.BeforeAfterAction

Renames all annotations matching the search template to the new namespace, name or value.

reportConfiguration(PepperConfiguration) - Static method in class org.corpus_tools.pepper.common.PepperUtil

Returns a report as String containing the configuration for Pepper.

reportCorpusStructure(SCorpusGraph, SNode, String, boolean) - Method in class org.corpus_tools.pepper.impl.BeforeAfterAction

Deprecated.

use instead

reportModuleList(int, Collection<PepperModuleDesc>, Map<Integer, PepperModuleDesc>) - Static method in class org.corpus_tools.pepper.common.PepperUtil

Creates a table containing all passed Pepper modules corresponding to their description and their fingerprint

reportModuleList(int, Collection<PepperModuleDesc>) - Static method in class org.corpus_tools.pepper.common.PepperUtil

Creates a table containing all passed Pepper modules corresponding to their description and their fingerprint

resolveFile(String) - Method in class org.corpus_tools.pepper.core.PepperParamsReader

resolveURI(String) - Method in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

Transforms a given String to a URI.

RESOURCES - Static variable in interface org.corpus_tools.pepper.core.ModuleResolver

resources - Variable in class org.corpus_tools.pepper.impl.PepperModuleImpl

TODO make docu

resourceURI - Variable in class org.corpus_tools.pepper.modules.MappingSubject

URI of resource.

resourceURI - Variable in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper

retrieveResourcePathFromBundle(PepperModule) - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

Retrieves the path, where the bundle is located and extracts the path, where resources are estimated

run() - Method in class org.corpus_tools.pepper.common.PepperUtil.PepperJobReporter

run() - Method in class org.corpus_tools.pepper.core.PepperOSGiRunner

run() - Method in class org.corpus_tools.pepper.impl.PepperMapperControllerImpl

This method starts the PepperMapper object in a thread.

runPepperForTest(T...) - Static method in class org.corpus_tools.pepper.testFramework.PepperTestUtil

runSelfTest() - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTest

S

saltProject - Variable in class org.corpus_tools.pepper.core.PepperJobImpl

The SaltProject which is converted by this job.

saltProject - Variable in class org.corpus_tools.pepper.impl.PepperModuleImpl

Salt project which is processed by module.

SaltValidator - Class in org.corpus_tools.pepper.modules.coreModules

This class analyzes a Salt model and prints out a report about conflicts in the Salt model.

SaltValidator() - Constructor for class org.corpus_tools.pepper.modules.coreModules.SaltValidator

SaltValidator.ValidatorMapper - Class in org.corpus_tools.pepper.modules.coreModules

Checks whether each SCorpus object contains either a SCorpus object or a SDocument object.

SaltValidatorProperties - Class in org.corpus_tools.pepper.modules.coreModules

SaltValidatorProperties() - Constructor for class org.corpus_tools.pepper.modules.coreModules.SaltValidatorProperties

SaltXMLExporter - Class in org.corpus_tools.pepper.modules.coreModules

This is a PepperExporter which exports a salt model to the SaltXML format.

SaltXMLExporter() - Constructor for class org.corpus_tools.pepper.modules.coreModules.SaltXMLExporter

SaltXMLImporter - Class in org.corpus_tools.pepper.modules.coreModules

This is a PepperImporter which imports the SaltXML format into a salt model.

SaltXMLImporter() - Constructor for class org.corpus_tools.pepper.modules.coreModules.SaltXMLImporter

sampleFileContent(String...) - Method in class org.corpus_tools.pepper.impl.CorpusPathResolver

Returns 10 lines of a sampled set of 20 files having the ending specified by fileEndings recursively from specified corpus path.

sampleFileContent(int, int, String...) - Method in class org.corpus_tools.pepper.impl.CorpusPathResolver

Returns fileEndings lines of a sampled set of numberOfSampledLines files having the ending specified by fileEndings recursively from specified corpus path.

sampleFileContent(URI, String...) - Method in class org.corpus_tools.pepper.impl.PepperImporterImpl

Returns lines of a sampled set of files having the ending specified by fileEndings recursively from specified corpus path.

sampleFiles(Collection<File>, int) - Method in class org.corpus_tools.pepper.impl.CorpusPathResolver

Creates a sampled set of numberOfSampledFiles files recursively from directory dir with specified endings.

save(URI) - Method in class org.corpus_tools.pepper.common.PepperJob

Stores this job to the file at passed URI.

save(URI) - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Stores this job to the file at passed URI.

sCorpusGraph - Variable in class org.corpus_tools.pepper.core.ModuleControllerImpl

The SCorpusGraph object to be filled.

sCorpusGraph - Variable in class org.corpus_tools.pepper.impl.PepperModuleImpl

The SCorpusGraph object which should be processed by this module.

sElementId - Variable in class org.corpus_tools.pepper.modules.MappingSubject

Identifier object corresponding to either SDocument or SCorpus which should be mapped

selfTest() - Method in interface org.corpus_tools.pepper.common.Pepper

Deprecated.

selfTest(PepperModule) - Method in class org.corpus_tools.pepper.core.ModuleFitnessChecker

When the specified module provides a self test, the fitness feature ModuleFitness.FitnessFeature.HAS_SELFTEST is set to true and self test is ran.

selfTest(PepperModule, ModuleFitness) - Method in class org.corpus_tools.pepper.core.ModuleFitnessChecker

When the specified module provides a self test, the fitness feature ModuleFitness.FitnessFeature.HAS_SELFTEST is set to true and self test is ran.

selfTest(PepperModule, ModuleFitness, SelfTestDesc) - Method in class org.corpus_tools.pepper.core.ModuleFitnessChecker

When the specified module provides a self test, the fitness feature ModuleFitness.FitnessFeature.HAS_SELFTEST is set to true and self test is ran.

selfTest() - Method in class org.corpus_tools.pepper.core.PepperImpl

SelfTestDesc - Class in org.corpus_tools.pepper.core

This class is a container for a module selftest.

SelfTestDesc(URI, URI) - Constructor for class org.corpus_tools.pepper.core.SelfTestDesc

Creates an object with input corpus path and expected path.

SelfTestDesc.Builder - Class in org.corpus_tools.pepper.core

sendToSleep() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Notifies the DocumentControllerImpl object, that the contained SDocument or more precisely the SDocumentGraph object could be send to sleep.

sendToSleep() - Method in interface org.corpus_tools.pepper.modules.DocumentController

Notifies the DocumentControllerImpl object, that the contained SDocument or more precisely the SDocumentGraph object could be send to sleep.

sendToSleep_FORCE() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Sends the DocumentControllerImpl object, that the contained SDocument or more precisely the SDocumentGraph object could be send to sleep as method DocumentController.sendToSleep().

sendToSleep_FORCE() - Method in interface org.corpus_tools.pepper.modules.DocumentController

Sends the DocumentControllerImpl object, that the contained SDocument or more precisely the SDocumentGraph object could be send to sleep as method DocumentController.sendToSleep().

setBaseDir(URI) - Method in class org.corpus_tools.pepper.common.PepperJob

Sets the base directory for this ModuleController.

setCallGC(boolean) - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Sets whether the garbage collector should be called after sending a SDocument object to sleep.

setConfFolder(File) - Method in class org.corpus_tools.pepper.common.PepperConfiguration

Sets the folder containing the configuration file(s).

setConfiguration(PepperConfiguration) - Method in interface org.corpus_tools.pepper.common.Pepper

Sets the configuration for Pepper.

setConfiguration(PepperConfiguration) - Method in interface org.corpus_tools.pepper.core.ModuleResolver

Sets the configuration object for this object.

setConfiguration(PepperConfiguration) - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

Sets the configuration object for this object.

setConfiguration(PepperConfiguration) - Method in class org.corpus_tools.pepper.core.PepperImpl

setConfiguration(PepperConfiguration) - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Sets the properties to customize the behavior of conversion for this single job

setCorpus(SCorpus) - Method in class org.corpus_tools.pepper.impl.PepperMapperImpl

Sets the SCorpus object to be mapped by this mapper.

setCorpus(SCorpus) - Method in interface org.corpus_tools.pepper.modules.PepperMapper

Sets the SCorpus object to be mapped by this mapper.

setCorpusDesc(CorpusDesc) - Method in class org.corpus_tools.pepper.common.StepDesc

Sets an object to describe all infos about the corpus to im- or export.

setCorpusDesc(CorpusDesc) - Method in class org.corpus_tools.pepper.core.Step

Sets an object to describe all infos about the corpus to im- or export.

setCorpusDesc(CorpusDesc) - Method in class org.corpus_tools.pepper.impl.PepperExporterImpl

TODO docu

setCorpusDesc(CorpusDesc) - Method in class org.corpus_tools.pepper.impl.PepperImporterImpl

TODO docu

setCorpusDesc(CorpusDesc) - Method in interface org.corpus_tools.pepper.modules.PepperExporter

TODO docu

setCorpusDesc(CorpusDesc) - Method in interface org.corpus_tools.pepper.modules.PepperImporter

TODO docu

setCorpusGraph(SCorpusGraph) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Sets the SCorpusGraph object which is filled, manipulated or exported by the current module.

setCorpusGraph(SCorpusGraph) - Method in interface org.corpus_tools.pepper.modules.PepperModule

Sets the SCorpusGraph object which is filled, manipulated or exported by the current module.

setCorpusPath(URI) - Method in class org.corpus_tools.pepper.common.CorpusDesc

Sets the path of where to store or from where to load this corpus.

setCorpusPath(URI) - Method in class org.corpus_tools.pepper.impl.CorpusPathResolver

setCorpusPathResolver(CorpusPathResolver) - Method in class org.corpus_tools.pepper.impl.PepperImporterImpl

Sets a CorpusPathResolver which is used by PepperImporterImpl.isImportable(URI).

setDefaultNamespace(String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

setDesc(String) - Method in class org.corpus_tools.pepper.common.PepperModuleDesc

Sets a short description of this module.

setDesc(String) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Sets a short description of this module.

setDesc(String) - Method in interface org.corpus_tools.pepper.modules.PepperModule

Sets a short description of this module.

setDocument(SDocument) - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Sets the SDocument object, to which this object belongs to.

setDocument(SDocument) - Method in class org.corpus_tools.pepper.impl.PepperMapperImpl

Sets the SDocument object to be mapped by this mapper.

setDocument(SDocument) - Method in interface org.corpus_tools.pepper.modules.DocumentController

Sets the SDocument object, to which this object belongs to.

setDocument(SDocument) - Method in interface org.corpus_tools.pepper.modules.PepperMapper

Sets the SDocument object to be mapped by this mapper.

setDocumentController(DocumentController) - Method in class org.corpus_tools.pepper.modules.MappingSubject

If the set Identifier belongs to a SDocument, it's controller can be passed with this method.

setDocumentEnding(String) - Method in class org.corpus_tools.pepper.impl.PepperExporterImpl

Sets the format ending for files to be exported and related to SDocument objects.

setDocumentEnding(String) - Method in interface org.corpus_tools.pepper.modules.PepperExporter

Sets the format ending for files to be exported and related to SDocument objects.

setExportMode(PepperExporter.EXPORT_MODE) - Method in class org.corpus_tools.pepper.impl.PepperExporterImpl

{@inheritDoc PepperExporter#setExportMode(org.corpus_tools.pepper.modules.

setExportMode(PepperExporter.EXPORT_MODE) - Method in interface org.corpus_tools.pepper.modules.PepperExporter

Determines how the corpus-structure should be exported.

setFeature(ModuleFitness.FitnessFeature, boolean) - Method in class org.corpus_tools.pepper.common.ModuleFitness

Sets the value to the specified feature.

setFixture(PepperModule) - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperImExporterTest

setFixture(PepperModule) - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper

Sets the current fixture to test.

setFormatDesc(FormatDesc) - Method in class org.corpus_tools.pepper.common.CorpusDesc

Sets the format description for this corpus description.

setFormatName(String) - Method in class org.corpus_tools.pepper.common.FormatDesc

Sets the name of the linguistic format.

setFormatReference(URI) - Method in class org.corpus_tools.pepper.common.FormatDesc

Sets the documentation reference for the linguistic format.

setFormatVersion(String) - Method in class org.corpus_tools.pepper.common.FormatDesc

Sets the version of the linguistic format.

setIdentifier(Identifier) - Method in class org.corpus_tools.pepper.impl.PepperMapperControllerImpl

Set Identifier object of the SCorpus or SDocument object, which is contained by containing PepperMapper.

setIdentifier(Identifier) - Method in class org.corpus_tools.pepper.modules.MappingSubject

Sets Identifier object corresponding to either SDocument or SCorpus which should be mapped

setIdentifier(Identifier) - Method in interface org.corpus_tools.pepper.modules.PepperMapperController

Set Identifier object of the SCorpus or SDocument object, which is contained by containing PepperMapper.

setInputDocumentBus(DocumentBus) - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

The DocumentBus object working as input for this ModuleControllerImpl.

setInputDocumentBus(DocumentBus) - Method in interface org.corpus_tools.pepper.modules.ModuleController

The DocumentBus object working as input for this ModuleControllerImpl.

setIntend(String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

Set the intend character(s) for pretty printing.

setIsMultithreaded(boolean) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Sets whether this PepperModule is able to run multithreaded.

setIsMultithreaded(boolean) - Method in interface org.corpus_tools.pepper.modules.PepperModule

Sets whether this PepperModule is able to run multithreaded.

setJob(PepperJobImpl) - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

Sets the PepperJobImpl object reference of this object.

setJob(PepperJob) - Method in class org.corpus_tools.pepper.core.PepperParamsReader

Sets PepperJob to be filled.

setJob(PepperJobImpl) - Method in interface org.corpus_tools.pepper.modules.ModuleController

Sets the PepperJobImpl object reference of this object.

setJob_basic(PepperJobImpl) - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

Sets the PepperJobImpl object reference of this object.

setJob_basic(PepperJobImpl) - Method in interface org.corpus_tools.pepper.modules.ModuleController

Sets the PepperJobImpl object reference of this object.

setLocation(URI) - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Sets location, where to store SDocumentGraph when #sleep() was called or load when DocumentController.awake() was called.

setLocation(URI) - Method in class org.corpus_tools.pepper.core.PepperParamsReader

setLocation(URI) - Method in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

setLocation(URI) - Method in interface org.corpus_tools.pepper.modules.DocumentController

Sets location, where to store SDocumentGraph when #sleep() was called or load when DocumentController.awake() was called.

setMapperThreadGroup(ThreadGroup) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Sets a ThreadGroup where PepperMapper objects and the corresponding threads are supposed to run in.

setMappingResult(DOCUMENT_STATUS) - Method in class org.corpus_tools.pepper.impl.PepperMapperImpl

Sets the result of the current mapping, when it is finished.

setMappingResult(DOCUMENT_STATUS) - Method in class org.corpus_tools.pepper.modules.MappingSubject

setMappingResult(DOCUMENT_STATUS) - Method in interface org.corpus_tools.pepper.modules.PepperMapper

Sets the result of the current mapping, when it is finished.

setMaxNumerOfDocuments(int) - Method in class org.corpus_tools.pepper.core.PepperJobImpl

setMemPolicy(MEMORY_POLICY) - Method in class org.corpus_tools.pepper.core.DocumentBus

Sets the memory policy.

setMemPolicy(MEMORY_POLICY) - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Sets the memory policy.

setModuleResolver(ModuleResolver) - Method in class org.corpus_tools.pepper.core.PepperImpl

Sets a ModuleResolverImpl object to resolve PepperModule objects for Pepper jobs.

setModuleResolver(ModuleResolver) - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Sets a reference to the OSGi module resolver, to find modules matching to the step description.

setModuleType(MODULE_TYPE) - Method in class org.corpus_tools.pepper.common.PepperModuleDesc

Sets the type of this module.

setModuleType(MODULE_TYPE) - Method in class org.corpus_tools.pepper.common.StepDesc

Sets the type of the PepperModule to be used.

setName(String) - Method in class org.corpus_tools.pepper.common.PepperModuleDesc

Sets the name of a Pepper module described by this PepperModuleDesc object.

setName(String) - Method in class org.corpus_tools.pepper.common.StepDesc

Sets the name of the PepperModule to be used for this step.

setName(String) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Sets the name of this PepperModule.

setNamespaceContext(NamespaceContext) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

setOutputDocumentBus(DocumentBus) - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

All documents which were consumed by the PepperModule contained in this object are set to this output bus, regarding the status, the PepperModule returned.

setOutputDocumentBus(DocumentBus) - Method in interface org.corpus_tools.pepper.modules.ModuleController

All documents which were consumed by the PepperModule contained in this object are set to this output bus, regarding the status, the PepperModule returned.

setPepper(Pepper) - Method in class org.corpus_tools.pepper.core.PepperOSGiRunner

Sets the Pepper object to do the conversion task.

setPepperJob(PepperJobImpl) - Method in class org.corpus_tools.pepper.core.DocumentBus

Sets the PepperJob object containing this object

setPepperJob(PepperJob) - Method in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

Sets PepperJob object to be filled with content.

setPepperMapper(PepperMapper) - Method in class org.corpus_tools.pepper.impl.PepperMapperControllerImpl

Sets the mapper, controlled by this object.

setPepperMapper(PepperMapper) - Method in interface org.corpus_tools.pepper.modules.PepperMapperController

Sets the PepperMapper, controlled by this object.

setPepperMapperController(PepperMapperController) - Method in class org.corpus_tools.pepper.impl.PepperMapperImpl

Sets the controller of this mapper, to grant n access to Pepper via the controller.

setPepperMapperController(PepperMapperController) - Method in interface org.corpus_tools.pepper.modules.PepperMapper

Sets the controller of this mapper, to grant n access to Pepper via the controller.

setPepperModule(PepperModule) - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

Sets the PepperModule object, this controller object is observing.

setPepperModule(PepperModule) - Method in class org.corpus_tools.pepper.core.Step

Creates a ModuleControllerImpl object as container for the passed PepperModule object.

setPepperModule(PepperModule) - Method in class org.corpus_tools.pepper.impl.PepperMapperControllerImpl

Sets the PepperModule object, which contains the PepperMapperController as a callback reference.

setPepperModule(PepperModule) - Method in interface org.corpus_tools.pepper.modules.ModuleController

Sets the PepperModule object, this controller object is observing.

setPepperModule(PepperModule) - Method in interface org.corpus_tools.pepper.modules.PepperMapperController

Sets the PepperModule object, which contains the PepperMapperController as a callback reference.

setPepperModule_basic(PepperModule) - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

Sets the PepperModule object, this controller object is observing.

setPepperModule_basic(PepperModule) - Method in interface org.corpus_tools.pepper.modules.ModuleController

Sets the PepperModule object, this controller object is observing.

setPepperModuleController(ModuleController) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Sets the container and controller object for the current module.

setPepperModuleController(ModuleController) - Method in interface org.corpus_tools.pepper.modules.PepperModule

Sets the container and controller object for the current module.

setPepperModuleController_basic(ModuleController) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Sets the container and controller object for the current module.

setPepperModuleController_basic(ModuleController) - Method in interface org.corpus_tools.pepper.modules.PepperModule

Sets the container and controller object for the current module.

setPrefix(String, String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

setPrettyPrint(Boolean) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

Sets whether the xml should be pretty printed.

setProgress(Double) - Method in class org.corpus_tools.pepper.impl.PepperMapperImpl

Sets the progress of the current handled SDocument or SCorpus object.

setProgress(Double) - Method in interface org.corpus_tools.pepper.modules.PepperMapper

Sets the progress of the current handled SDocument or SCorpus object.

setProperties(PepperModuleProperties) - Method in class org.corpus_tools.pepper.common.PepperModuleDesc

Sets thePepperModuleProperties object containing properties to customize the behavior of this PepperModule.

setProperties(PepperModuleProperties) - Method in class org.corpus_tools.pepper.impl.PepperMapperImpl

Sets the PepperModuleProperties object containing user customizations to be observed during the mapping.

setProperties(PepperModuleProperties) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Sets thePepperModuleProperties object containing properties to customize the behavior of this PepperModule.

setProperties(PepperModuleProperties) - Method in interface org.corpus_tools.pepper.modules.PepperMapper

Sets the PepperModuleProperties object containing user customizations to be observed during the mapping.

setProperties(PepperModuleProperties) - Method in interface org.corpus_tools.pepper.modules.PepperModule

Sets thePepperModuleProperties object containing properties to customize the behavior of this PepperModule.

setPropertyValue(String, T) - Method in class org.corpus_tools.pepper.modules.PepperModuleProperties

Searches for a PepperModuleProperty object in registered PepperModuleProperty objects and sets its value attribute, if a PepperModuleProperty object was found.

setPropertyValues(File) - Method in class org.corpus_tools.pepper.modules.PepperModuleProperties

Loads the given file via Properties.load(java.io.InputStream) and adds all properties given in the passed Property object.

setPropertyValues(Properties) - Method in class org.corpus_tools.pepper.modules.PepperModuleProperties

Adds all properties given in the passed Property object.

setProps(Properties) - Method in class org.corpus_tools.pepper.common.StepDesc

If #setPepperModule(org.corpus_tools.pepper.modules.PepperModule) was already called, the passed Properties object is used to create a PepperModuleProperties object, which is set to given PepperModule .

setProps(Properties) - Method in class org.corpus_tools.pepper.core.Step

If Step.setPepperModule(PepperModule) was already called, the passed Properties object is used to create a PepperModuleProperties object, which is set to given PepperModule.

setResources(PepperModule) - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

Sets resources to a given PepperModule-object.

setResources(URI) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Sets the resource folder used by PepperModule.getResources().

setResources(URI) - Method in interface org.corpus_tools.pepper.modules.PepperModule

Sets the resource folder used by PepperModule.getResources().

setResourcesURI(URI) - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper

Sets the path to resources folder for module.

setResourceURI(URI) - Method in class org.corpus_tools.pepper.impl.PepperMapperImpl

Sets URI of resource.

setResourceURI(URI) - Method in class org.corpus_tools.pepper.modules.MappingSubject

setResourceURI(URI) - Method in interface org.corpus_tools.pepper.modules.PepperMapper

Sets URI of resource.

setSaltProject(SaltProject) - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Sets the SaltProject which is converted by this job.

setSaltProject(SaltProject) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Sets the SaltProject object, which is filled, manipulated or exported by the current module.

setSaltProject(SaltProject) - Method in interface org.corpus_tools.pepper.modules.PepperModule

Sets the SaltProject object, which is filled, manipulated or exported by the current module.

setStatus(DOCUMENT_STATUS) - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl.DetailedStatus

setStop(boolean) - Method in class org.corpus_tools.pepper.common.PepperUtil.PepperJobReporter

Sets if PepperJob still has to be observed

setSupplierContact(URI) - Method in class org.corpus_tools.pepper.common.PepperModuleDesc

Sets a uri where to find more information about this module and where to find some contact information to contact the supllier.

setSupplierContact(URI) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Sets a uri where to find more information about this module and where to find some contact information to contact the supplier.

setSupplierContact(URI) - Method in interface org.corpus_tools.pepper.modules.PepperModule

Sets a uri where to find more information about this module and where to find some contact information to contact the supplier.

setSupplierHomepage(URI) - Method in class org.corpus_tools.pepper.common.PepperModuleDesc

Returns the URI to the homepage describing the functionality of the module.

setSupplierHomepage(URI) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

setSupplierHomepage(URI) - Method in interface org.corpus_tools.pepper.modules.PepperModule

Returns the URI to the homepage describing the functionality of the module.

setSymbolicName(String) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Sets the symbolic name of this OSGi bundle.

setSymbolicName(String) - Method in interface org.corpus_tools.pepper.modules.PepperModule

Sets the symbolic name of this OSGi bundle.

setTemporaries(PepperModule, int) - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

Sets a temporary folder for each PepperModule to store temporary files if necessary.

setTemproraries(URI) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Deprecated.

setTemproraries(URI) - Method in interface org.corpus_tools.pepper.modules.PepperModule

Deprecated.

setTypeOfResource(URI) - Method in class org.corpus_tools.pepper.impl.PepperImporterImpl

This method is a callback and can be overridden by derived importers.

setTypeOfResource(URI) - Method in interface org.corpus_tools.pepper.modules.PepperImporter

This method is a callback and can be overridden by derived importers.

setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler) - Method in interface org.corpus_tools.pepper.modules.PepperMapperController

Calls method map.

setValue(T) - Method in class org.corpus_tools.pepper.modules.PepperModuleProperty

setValueString(String) - Method in class org.corpus_tools.pepper.modules.PepperModuleProperty

Sets the given value to the internal one.

setVersion(String) - Method in class org.corpus_tools.pepper.common.PepperModuleDesc

Sets the version of a Pepper module described by this PepperModuleDesc object.

setVersion(String) - Method in class org.corpus_tools.pepper.common.StepDesc

Sets the version of the PepperModule to be used for this step.

setVersion(String) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Sets the version of this module.

setVersion(String) - Method in interface org.corpus_tools.pepper.modules.PepperModule

Sets the version of this module.

sleep() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Sends the contained SDocument to sleep, which means, it will be stored to local disk and removed from main memory, by calling SDocument#saveSDocumentGraph(org.eclipse.emf.common.util.URI).

SOURCES_RESOURCES - Static variable in class org.corpus_tools.pepper.common.PepperConfiguration

Folder where the resources of a bundle is expected to be.

start() - Method in class org.corpus_tools.pepper.impl.PepperExporterImpl

Adds the call of method #exportCorpusStructure(SCorpusGraph), than calls PepperModule.start().

start() - Method in class org.corpus_tools.pepper.impl.PepperImporterImpl

Overrides the method PepperModuleImpl.start() to add the following, before PepperModuleImpl.start() is called.

start() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Starts the conversion process.

start(Identifier) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

This method is called by method PepperModuleImpl.start(), if the method was not overridden by the current class.

start() - Method in class org.corpus_tools.pepper.modules.coreModules.DoNothingExporter

start() - Method in class org.corpus_tools.pepper.modules.coreModules.SaltXMLExporter

Creates a Resource for the SaltProject to persist contained objects like SDocumentGraph etc.

start() - Method in interface org.corpus_tools.pepper.modules.PepperMapperController

Calls method map.

start() - Method in interface org.corpus_tools.pepper.modules.PepperModule

Starts the conversion process.

start(Identifier) - Method in interface org.corpus_tools.pepper.modules.PepperModule

This method is called by the method PepperModule.start().

start() - Method in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper

This methods starts the processing of Pepper in the development environment.

start(Collection<? extends PepperModule>) - Static method in class org.corpus_tools.pepper.testFramework.PepperTestUtil

This methods starts the processing of Pepper in the development environment for a set of Pepper modules.

start(Pepper, Collection<? extends PepperModule>) - Static method in class org.corpus_tools.pepper.testFramework.PepperTestUtil

startElement(String, String, String, Attributes) - Method in class org.corpus_tools.pepper.core.PepperParamsReader

startElement(String, String, String, Attributes) - Method in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

status - Variable in class org.corpus_tools.pepper.common.PepperJob

status of job

Step - Class in org.corpus_tools.pepper.core

This class is an extension of the class StepDesc and is for internal use only.

Step(String) - Constructor for class org.corpus_tools.pepper.core.Step

Initializes this object and sets its internal id, which represents its position in list of steps.

Step(String, StepDesc) - Constructor for class org.corpus_tools.pepper.core.Step

Initializes this object and sets its internal id, which represents its position in list of steps.

StepDesc - Class in org.corpus_tools.pepper.common

This class represents a description of a single step in Pepper.

StepDesc() - Constructor for class org.corpus_tools.pepper.common.StepDesc

stepDescs - Variable in class org.corpus_tools.pepper.common.PepperJob

list of all step descriptions

stringToCharList(String) - Method in class org.corpus_tools.pepper.modules.PepperModuleProperties

Expects a list of characters encoded as a String.

supplierContact - Variable in class org.corpus_tools.pepper.common.PepperModuleDesc

supportedFormatsCheck - Variable in class org.corpus_tools.pepper.testFramework.helpers.PepperImExporterTest

Deprecated.

the visibality of this memeber will be shrinked to private. Use PepperImExporterTest.addFormatWhichShouldBeSupported(FormatDesc) or PepperImExporterTest.addFormatWhichShouldBeSupported(String, String) instead.

symbolicName - Variable in class org.corpus_tools.pepper.impl.PepperModuleImpl

TODO make docu

T

TAG_CUSTOMIZATION - Static variable in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

TAG_EXPORTER - Static variable in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

TAG_IMPORTER - Static variable in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

TAG_MANIPULATOR - Static variable in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

TAG_PEPEPR_JOB - Static variable in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

TAG_PROP - Static variable in class org.corpus_tools.pepper.core.WorkflowDescriptionReader

temproraries - Variable in class org.corpus_tools.pepper.impl.PepperModuleImpl

Deprecated.

TerminalDocumentBus - Class in org.corpus_tools.pepper.core

TODO make docu

TerminalDocumentBus(String) - Constructor for class org.corpus_tools.pepper.core.TerminalDocumentBus

Creates an object of this type and sets the passes the given input controller and output controller.

TerminalDocumentBus(List<String>) - Constructor for class org.corpus_tools.pepper.core.TerminalDocumentBus

Creates an object of this type and sets all passed in- and output ModuleControllerImpl objects.

TextExporter - Class in org.corpus_tools.pepper.modules.coreModules

This is a PepperExporter which extracts and exports the primary text of a Salt model and stores it into a text file.

TextExporter() - Constructor for class org.corpus_tools.pepper.modules.coreModules.TextExporter

TextImporter - Class in org.corpus_tools.pepper.modules.coreModules

Maps a file-structure to a corpus-structure and reads the contained txt files to map their content to STextualDS objects.

TextImporter() - Constructor for class org.corpus_tools.pepper.modules.coreModules.TextImporter

Specifies the separator, which has to be set between to the texts of two token.

TextImporter.TextMapper - Class in org.corpus_tools.pepper.modules.coreModules

Reads the content of txt files and creates a STextualDS object for each.

TextMapper() - Constructor for class org.corpus_tools.pepper.modules.coreModules.TextImporter.TextMapper

TMP_TEST_DIR - Static variable in class org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper

TMP_TEST_DIR - Static variable in class org.corpus_tools.pepper.testFramework.PepperTestUtil

Name of the directory where tests for Pepper and Pepper modules can be stored.

toString() - Method in class org.corpus_tools.pepper.common.CorpusDesc

Returns a string representation of this object.

toString() - Method in class org.corpus_tools.pepper.common.FormatDesc

Returns a String representation of this object.

toString() - Method in enum org.corpus_tools.pepper.common.JOB_STATUS

toString() - Method in class org.corpus_tools.pepper.common.ModuleFitness

toString() - Method in class org.corpus_tools.pepper.common.PepperJob

Returns a textual representation of this Pepper job.

toString() - Method in class org.corpus_tools.pepper.common.PepperModuleDesc

Returns a String representation of this object.

toString() - Method in class org.corpus_tools.pepper.common.StepDesc

Returns a string representation of this object.

toString() - Method in class org.corpus_tools.pepper.core.DocumentBus

returns a String representation of this object.

toString() - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Returns a textual representation of this object.

toString() - Method in class org.corpus_tools.pepper.core.ModuleControllerImpl

Returns a String representation of this object.

toString() - Method in class org.corpus_tools.pepper.core.ModuleResolverImpl

TODO make docu

toString() - Method in class org.corpus_tools.pepper.core.PepperImpl

Returns a string representation of this object.

toString() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Returns a textual representation of this Pepper job.

toString() - Method in class org.corpus_tools.pepper.core.SelfTestDesc

toString() - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Returns a string representation of this object.

toString() - Method in class org.corpus_tools.pepper.modules.MappingSubject

Returns a String representation of this object.

toString() - Method in class org.corpus_tools.pepper.modules.PepperModuleProperties

toString() - Method in class org.corpus_tools.pepper.modules.PepperModuleProperty

toXML(XMLStreamWriter) - Method in class org.corpus_tools.pepper.common.StepDesc

TypeBuilder(String) - Constructor for class org.corpus_tools.pepper.modules.PepperModuleProperty.NameBuilder.TypeBuilder

U

uncaughtException(Thread, Throwable) - Method in class org.corpus_tools.pepper.impl.PepperModuleImpl

Method catches Uncaught exceptions thrown by PepperMapperImpl while running as Thread.

unifyProposedImportOrders(SCorpusGraph) - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Returns a list of Identifiers corresponding to the SDocument objects contained in the passed SCorpusGraph object.

unreadFilesGroupedByExtension - Variable in class org.corpus_tools.pepper.impl.CorpusPathResolver

unsetModuleResolver(ModuleResolver) - Method in class org.corpus_tools.pepper.core.PepperImpl

Unsets the ModuleResolverImpl reference.

unsetPepper(Pepper) - Method in class org.corpus_tools.pepper.core.PepperOSGiRunner

Unsets the Pepper object to do the conversion task.

updateStatus(ModuleController, DOCUMENT_STATUS) - Method in class org.corpus_tools.pepper.core.DocumentControllerImpl

Updates the status of a specified of contained SDocument object corresponding to the ModuleControllerImpl matching to the passed id.

updateStatus(ModuleController, DOCUMENT_STATUS) - Method in interface org.corpus_tools.pepper.modules.DocumentController

Updates the status of a specified of contained SDocument object corresponding to the ModuleControllerImpl matching to the passed id.

V

ValidatorMapper() - Constructor for class org.corpus_tools.pepper.modules.coreModules.SaltValidator.ValidatorMapper

valueOf(String) - Static method in enum org.corpus_tools.pepper.common.DOCUMENT_STATUS

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.corpus_tools.pepper.common.JOB_STATUS

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.corpus_tools.pepper.common.MEMORY_POLICY

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.corpus_tools.pepper.common.MODULE_TYPE

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.corpus_tools.pepper.common.ModuleFitness.Fitness

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.corpus_tools.pepper.common.ModuleFitness.FitnessFeature

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.corpus_tools.pepper.modules.PepperExporter.EXPORT_MODE

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.corpus_tools.pepper.common.DOCUMENT_STATUS

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.corpus_tools.pepper.common.JOB_STATUS

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.corpus_tools.pepper.common.MEMORY_POLICY

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.corpus_tools.pepper.common.MODULE_TYPE

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.corpus_tools.pepper.common.ModuleFitness.Fitness

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.corpus_tools.pepper.common.ModuleFitness.FitnessFeature

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.corpus_tools.pepper.modules.PepperExporter.EXPORT_MODE

Returns an array containing the constants of this enum type, in the order they are declared.

W

waitUntilAllDocumentsArePut - Variable in class org.corpus_tools.pepper.core.DocumentBus

Used to let the DocumentBus.pop(String) method wait until all documents have been put.

wire() - Method in class org.corpus_tools.pepper.core.PepperJobImpl

Wires all Step objects being contained by this object to be ready for #start().

withCorpusPath(URI) - Method in class org.corpus_tools.pepper.common.CorpusDesc.Builder

withCorpusPath(String) - Method in class org.corpus_tools.pepper.common.CorpusDesc.Builder

withDefaultValue(T) - Method in class org.corpus_tools.pepper.modules.PepperModuleProperty.NameBuilder.TypeBuilder.DescriptionBuilder.Builder

withDescription(String) - Method in class org.corpus_tools.pepper.modules.PepperModuleProperty.NameBuilder.TypeBuilder.DescriptionBuilder

withExpectedCorpusPath(URI) - Method in class org.corpus_tools.pepper.core.SelfTestDesc.Builder

withFormatName(String) - Method in class org.corpus_tools.pepper.common.CorpusDesc.Builder

withFormatReference(URI) - Method in class org.corpus_tools.pepper.common.CorpusDesc.Builder

withFormatReference(URI) - Method in class org.corpus_tools.pepper.common.FormatDesc.FormatDescBuilder

withFormatVersion(String) - Method in class org.corpus_tools.pepper.common.CorpusDesc.Builder

withInputCorpusPath(URI) - Method in class org.corpus_tools.pepper.core.SelfTestDesc.Builder

withName(String) - Method in class org.corpus_tools.pepper.common.FormatDesc.FormatDescBuilder

withName(String) - Method in class org.corpus_tools.pepper.modules.PepperModuleProperty.NameBuilder

withType(Class<T>) - Method in class org.corpus_tools.pepper.modules.PepperModuleProperty.NameBuilder.TypeBuilder

withVersion(String) - Method in class org.corpus_tools.pepper.common.FormatDesc.FormatDescBuilder

WorkflowDescriptionReader - Class in org.corpus_tools.pepper.core

This class reads the 'new' workflow description file version 1.0 and fills the passed PepperJob object with the content of the read file.

WorkflowDescriptionReader() - Constructor for class org.corpus_tools.pepper.core.WorkflowDescriptionReader

WorkflowException - Exception in org.corpus_tools.pepper.exceptions

This PepperException is thrown if an internal error occurs.

WorkflowException() - Constructor for exception org.corpus_tools.pepper.exceptions.WorkflowException

WorkflowException(String) - Constructor for exception org.corpus_tools.pepper.exceptions.WorkflowException

WorkflowException(String, Throwable) - Constructor for exception org.corpus_tools.pepper.exceptions.WorkflowException

writeAttribute(String, String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeAttribute(String, String, String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeAttribute(String, String, String, String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeCData(String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeCharacters(String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeCharacters(char[], int, int) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeComment(String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeDefaultNamespace(String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeDTD(String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeEmptyElement(String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeEmptyElement(String, String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeEmptyElement(String, String, String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeEndDocument() - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeEndElement() - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeEntityRef(String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeNamespace(String, String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeProcessingInstruction(String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeProcessingInstruction(String, String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeStartDocument() - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeStartDocument(String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeStartDocument(String, String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeStartElement(String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeStartElement(String, String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

writeStartElement(String, String, String) - Method in class org.corpus_tools.pepper.util.XMLStreamWriter

X

XMLStreamWriter - Class in org.corpus_tools.pepper.util

This class is just a delegator class for a XMLStreamWriter with a pretty printing possibility.

XMLStreamWriter(XMLStreamWriter) - Constructor for class org.corpus_tools.pepper.util.XMLStreamWriter

A B C D E F G H I J L M N O P R S T U V W X