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

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

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

enum	JOB_STATUS
	Status of a job in Pepper, the status could be one of the following: More...

enum	MEMORY_POLICY
	Describes the main memory policy of PepperJobs. More...

enum	MODULE_TYPE
	Names of types of org.corpus_tools.pepper.modules.PepperModule: More...

class	ModuleFitness
	An object determining the fitness of a single Pepper module. More...

interface	Pepper

class	PepperConfiguration
	This class contains all possible configurations, to take influence on the Pepper process. More...

class	PepperJob

class	PepperModuleDesc
	This class is a kind of a fingerprint of a Pepper module and provides some information about a module. More...

class	PepperUtil

class	StepDesc
	This class represents a description of a single step in Pepper. More...

Detailed Description

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Class Documentation

◆ org::corpus_tools::pepper::common::MEMORY_POLICY

enum org::corpus_tools::pepper::common::MEMORY_POLICY

Describes the main memory policy of PepperJobs.

More specific, it determines the way of loading and storing SDocumentGraph objects during the processing. The behavior of the DocumentBus is described as follows:

MEMORY_POLICY#THRIFTY - each time, a PepperModule is setting a SDocument to DOCUMENT_STATUS#COMPLETED and no other PepperModule is currently working on it, it will be send to sleep.
MEMORY_POLICY#MODERATE - each time, a PepperModule is setting a SDocument to DOCUMENT_STATUS#COMPLETED, no other PepperModule is currently working on it and no other PepperModule is waiting on it, it will be send to sleep.
MEMORY_POLICY#GREEDY - A SDocumentGraph will never be send to sleep. In case of the number of maximal processed documents is limited, and was reached, no further SDocumentGraphs will be imported until one was finished somehow.

Author: Florian Zipser

Enumerator
GREEDY
MODERATE
THRIFTY

◆ org::corpus_tools::pepper::common::MODULE_TYPE

enum org::corpus_tools::pepper::common::MODULE_TYPE

Names of types of org.corpus_tools.pepper.modules.PepperModule:

Enumerator
EXPORTER
IMPORTER
MANIPULATOR

Classes

Detailed Description

Class Documentation

◆ org::corpus_tools::pepper::common::MEMORY_POLICY

◆ org::corpus_tools::pepper::common::MODULE_TYPE