Pepper
3.6.0
A highly extensible plattform for conversion and manipulationoflinguisticdata.
|
An object of this types contains a PepperModule and handles as a connector between such an object and the Pepper framework. More...
Inherited by org.corpus_tools.pepper.core.ModuleControllerImpl.
Public Member Functions | |
String | getId () |
Returns the id of this object. More... | |
PepperModule | getPepperModule () |
Returns the PepperModule object, this controller object is observing. More... | |
PepperJobImpl | getJob () |
Returns the PepperJobImpl object reference of this object. More... | |
void | setJob (PepperJobImpl job) |
Sets the PepperJobImpl object reference of this object. More... | |
void | setJob_basic (PepperJobImpl job) |
Sets the PepperJobImpl object reference of this object. More... | |
DocumentBus | getInputDocumentBus () |
The DocumentBus object working as input for this ModuleControllerImpl. More... | |
void | setInputDocumentBus (DocumentBus inputDocumentBus) |
The DocumentBus object working as input for this ModuleControllerImpl. More... | |
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. More... | |
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. More... | |
SCorpusGraph | getCorpusGraph () |
Returns the SCorpusGraph object, the contained PepperImporter is mapping. More... | |
Future<?> | importCorpusStructure (SCorpusGraph sCorpusGraph) |
Starts the import of corpus structure via the set PepperImporter object by calling PepperImporter#importCorpusStructure(SCorpusGraph). More... | |
DocumentController | next (boolean ignorePermissionForDocument) |
Returns the next DocumentController waiting in the input document bus to be processed by the contained PepperModule. More... | |
DocumentController | next () |
Returns the next DocumentController waiting in the input document bus to be processed by the contained PepperModule. More... | |
void | complete (DocumentController documentController) |
Adds the given DocumentController to the output document bus to be processed by the next PepperModule objects. More... | |
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. More... | |
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. More... | |
void | setPepperModule (PepperModule newPepperModule) |
Sets the PepperModule object, this controller object is observing. More... | |
void | setPepperModule_basic (PepperModule newPepperModule) |
Sets the PepperModule object, this controller object is observing. More... | |
An object of this types contains a PepperModule and handles as a connector between such an object and the Pepper framework.
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.
documentController | to be passed to next Pepper module |
Implemented in org.corpus_tools.pepper.core.ModuleControllerImpl.
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.
sElementId | the id corresponding to the SDocument object, which shall be not further processed |
Implemented in org.corpus_tools.pepper.core.ModuleControllerImpl.
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.
Implemented in org.corpus_tools.pepper.core.ModuleControllerImpl.
String org.corpus_tools.pepper.modules.ModuleController.getId | ( | ) |
Returns the id of this object.
Implemented in org.corpus_tools.pepper.core.ModuleControllerImpl.
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
Implemented in org.corpus_tools.pepper.core.ModuleControllerImpl.
PepperJobImpl org.corpus_tools.pepper.modules.ModuleController.getJob | ( | ) |
Returns the PepperJobImpl object reference of this object.
Implemented in org.corpus_tools.pepper.core.ModuleControllerImpl.
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.
Implemented in org.corpus_tools.pepper.core.ModuleControllerImpl.
PepperModule org.corpus_tools.pepper.modules.ModuleController.getPepperModule | ( | ) |
Returns the PepperModule object, this controller object is observing.
Implemented in org.corpus_tools.pepper.core.ModuleControllerImpl.
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.
globalId | global id for SDocument, note, that this is not the SElementId |
Implemented in org.corpus_tools.pepper.core.ModuleControllerImpl.
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.
sCorpusGraph | a SCorpusGraph object, in which the PepperImporter shall import the corpus structure. |
Implemented in org.corpus_tools.pepper.core.ModuleControllerImpl.
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.
Implemented in org.corpus_tools.pepper.core.ModuleControllerImpl.
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.
ignorePermissionForDocument | if set, a document will be returned even if the Pepper job gives no permission |
Implemented in org.corpus_tools.pepper.core.ModuleControllerImpl.
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
inputDocumentBus | bus to be used as input bus |
Implemented in org.corpus_tools.pepper.core.ModuleControllerImpl.
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.
job | new PepperJobImpl object |
Implemented in org.corpus_tools.pepper.core.ModuleControllerImpl.
void org.corpus_tools.pepper.modules.ModuleController.setJob_basic | ( | PepperJobImpl | job | ) |
Sets the PepperJobImpl object reference of this object.
job | new PepperJobImpl object |
Implemented in org.corpus_tools.pepper.core.ModuleControllerImpl.
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.
outputDocumentBus | bus to be used as input bus |
Implemented in org.corpus_tools.pepper.core.ModuleControllerImpl.
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)
newPepperModule | new object to observe |
Implemented in org.corpus_tools.pepper.core.ModuleControllerImpl.
void org.corpus_tools.pepper.modules.ModuleController.setPepperModule_basic | ( | PepperModule | newPepperModule | ) |
Sets the PepperModule object, this controller object is observing.
newPepperModule | new object to observe |
Implemented in org.corpus_tools.pepper.core.ModuleControllerImpl.