An object of this types contains a PepperModule and handles as a connector between such an object and the Pepper framework. More...

Public Member Functions
String	getId ()
	Returns the id of this object.

PepperModule	getPepperModule ()
	Returns the `PepperModule` object, this controller object is observing.

PepperJobImpl	getJob ()
	Returns the `PepperJobImpl` object reference of this object.

void	setJob (PepperJobImpl job)
	Sets the `PepperJobImpl` object reference of this object.

void	setJob_basic (PepperJobImpl job)
	Sets the `PepperJobImpl` object reference of this object.

DocumentBus	getInputDocumentBus ()
	The `DocumentBus` object working as input for this `ModuleControllerImpl`.

void	setInputDocumentBus (DocumentBus inputDocumentBus)
	The `DocumentBus` object working as input for this `ModuleControllerImpl`.

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

void	setOutputDocumentBus (DocumentBus outputDocumentBus)
	All documents which were consumed by the `PepperModule` contained in this object are set to this output bus, regarding the status, the `PepperModule` returned.

SCorpusGraph	getCorpusGraph ()
	Returns the `SCorpusGraph` object, the contained `PepperImporter` is mapping.

Future<?>	importCorpusStructure (SCorpusGraph sCorpusGraph)
	Starts the import of corpus structure via the set `PepperImporter` object by calling `PepperImporter#importCorpusStructure(SCorpusGraph)`.

DocumentController	next (boolean ignorePermissionForDocument)
	Returns the next `DocumentController` waiting in the input document bus to be processed by the contained `PepperModule`.

DocumentController	next ()
	Returns the next `DocumentController` waiting in the input document bus to be processed by the contained `PepperModule`.

void	complete (DocumentController documentController)
	Adds the given `DocumentController` to the output document bus to be processed by the next `PepperModule` objects.

void	delete (DocumentController documentController)
	Notifies the Pepper framework, that the `SDocument` being contained in passed `DocumentController` shall not be processed any further by following Pepper modules.

Double	getProgress (String globalId)
	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.

void	setPepperModule (PepperModule newPepperModule)
	Sets the `PepperModule` object, this controller object is observing.

void	setPepperModule_basic (PepperModule newPepperModule)
	Sets the `PepperModule` object, this controller object is observing.

Detailed Description

An object of this types contains a PepperModule and handles as a connector between such an object and the Pepper framework.

Author: Florian Zipser

Member Function Documentation

◆ complete()

void org.corpus_tools.pepper.modules.ModuleController.complete ( DocumentController documentController )

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

Parameters

documentController to be passed to next Pepper module

◆ delete()

void org.corpus_tools.pepper.modules.ModuleController.delete ( DocumentController documentController )

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

Parameters

sElementId the id corresponding to the SDocument object, which shall be not further processed

◆ getCorpusGraph()

SCorpusGraph org.corpus_tools.pepper.modules.ModuleController.getCorpusGraph ( )

Returns the SCorpusGraph object, the contained PepperImporter is mapping.

This method will only return a non empty object, if the contained PepperModule is an PepperImporter and if importCorpusStructure(SCorpusGraph) was called.

Returns

◆ getId()

String org.corpus_tools.pepper.modules.ModuleController.getId ( )

Returns the id of this object.

Returns: the stable id

◆ getInputDocumentBus()

DocumentBus org.corpus_tools.pepper.modules.ModuleController.getInputDocumentBus ( )

The DocumentBus object working as input for this ModuleControllerImpl.

All documents on bus will be processed and set to outputDocumentBus

Returns: bus which is input bus

◆ getJob()

PepperJobImpl org.corpus_tools.pepper.modules.ModuleController.getJob ( )

Returns the PepperJobImpl object reference of this object.

Returns: containing PepperJobImpl object

◆ getOutputDocumentBus()

DocumentBus org.corpus_tools.pepper.modules.ModuleController.getOutputDocumentBus ( )

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

Returns: bus, which is output bus

◆ getPepperModule()

PepperModule org.corpus_tools.pepper.modules.ModuleController.getPepperModule ( )

Returns the PepperModule object, this controller object is observing.

Returns: observed object

◆ getProgress()

Double org.corpus_tools.pepper.modules.ModuleController.getProgress ( String globalId )

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.

Parameters

globalId global id for SDocument, note, that this is not the SElementId

Returns: progress of process

◆ importCorpusStructure()

Future<?> org.corpus_tools.pepper.modules.ModuleController.importCorpusStructure ( SCorpusGraph sCorpusGraph )

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

The import runs in a separate thread, which is set as child of current thread. Therefore, don::t forget to call method, this method keeps the focus until, the import of the corpus structure has ended. This enables the calling object to wait until the corpus structure was imported. This method can only be invoked once per time.

Parameters

sCorpusGraph a SCorpusGraph object, in which the PepperImporter shall import the corpus structure.

◆ next() [1/2]

DocumentController org.corpus_tools.pepper.modules.ModuleController.next ( )

Returns the next DocumentController waiting in the input document bus to be processed by the contained PepperModule.

Returns: next document controller

◆ next() [2/2]

DocumentController org.corpus_tools.pepper.modules.ModuleController.next ( boolean ignorePermissionForDocument )

Returns the next DocumentController waiting in the input document bus to be processed by the contained PepperModule.

In contrast to pop(String), if ignorePermissionForDocument is set to true this method returns a DocumentController object even if the PepperJob permission does not allow to process a further document. This mechanism can be used, if a PepperModule has an own control mechanism of sending SDocuments to sleep.

Parameters

ignorePermissionForDocument if set, a document will be returned even if the Pepper job gives no permission

Returns: next document controller

◆ setInputDocumentBus()

void org.corpus_tools.pepper.modules.ModuleController.setInputDocumentBus ( DocumentBus inputDocumentBus )

The DocumentBus object working as input for this ModuleControllerImpl.

All documents on bus will be processed and set to outputDocumentBus

Parameters

inputDocumentBus bus to be used as input bus

◆ setJob()

void org.corpus_tools.pepper.modules.ModuleController.setJob ( PepperJobImpl job )

Sets the PepperJobImpl object reference of this object.

And notifies the reverse method PepperJobImpl, to set the ModuleControllerImpl object to this.

Parameters

job	new `PepperJobImpl` object

◆ setJob_basic()

void org.corpus_tools.pepper.modules.ModuleController.setJob_basic ( PepperJobImpl job )

Sets the PepperJobImpl object reference of this object.

Parameters

job	new `PepperJobImpl` object

◆ setOutputDocumentBus()

void org.corpus_tools.pepper.modules.ModuleController.setOutputDocumentBus ( DocumentBus outputDocumentBus )

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

Parameters

outputDocumentBus bus to be used as input bus

◆ setPepperModule()

void org.corpus_tools.pepper.modules.ModuleController.setPepperModule ( PepperModule newPepperModule )

Sets the PepperModule object, this controller object is observing.

Also sets the inverse method PepperModule#setPepperModuleController_basic(ModuleControllerImpl)

Parameters

newPepperModule new object to observe

◆ setPepperModule_basic()

void org.corpus_tools.pepper.modules.ModuleController.setPepperModule_basic ( PepperModule newPepperModule )

Sets the PepperModule object, this controller object is observing.

Parameters

newPepperModule new object to observe

Public Member Functions

Detailed Description

Member Function Documentation

◆ complete()

◆ delete()

◆ getCorpusGraph()

◆ getId()

◆ getInputDocumentBus()

◆ getJob()

◆ getOutputDocumentBus()

◆ getPepperModule()

◆ getProgress()

◆ importCorpusStructure()

◆ next() [1/2]

◆ next() [2/2]

◆ setInputDocumentBus()

◆ setJob()

◆ setJob_basic()

◆ setOutputDocumentBus()

◆ setPepperModule()

◆ setPepperModule_basic()