public interface ModuleController
PepperModule
and handles as a
connector between such an object and the Pepper framework.Modifier and Type | Method and Description |
---|---|
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. |
org.corpus_tools.salt.common.SCorpusGraph |
getCorpusGraph()
Returns the
SCorpusGraph object, the contained
PepperImporter is mapping. |
String |
getId()
Returns the id of this object.
|
DocumentBus |
getInputDocumentBus()
The
DocumentBus object working as input for this
ModuleControllerImpl . |
PepperJobImpl |
getJob()
Returns the
PepperJobImpl object reference of this object. |
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. |
PepperModule |
getPepperModule()
Returns the
PepperModule object, this controller object is
observing. |
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. |
Future<?> |
importCorpusStructure(org.corpus_tools.salt.common.SCorpusGraph sCorpusGraph)
Starts the import of corpus structure via the set
PepperImporter
object by calling
PepperImporter.importCorpusStructure(SCorpusGraph) . |
DocumentController |
next()
Returns the next
DocumentController waiting in the input document
bus to be processed by the contained PepperModule . |
DocumentController |
next(boolean ignorePermissionForDocument)
Returns the next
DocumentController waiting in the input document
bus to be processed by the contained PepperModule . |
void |
setInputDocumentBus(DocumentBus inputDocumentBus)
The
DocumentBus object working as input for this
ModuleControllerImpl . |
void |
setJob_basic(PepperJobImpl job)
Sets the
PepperJobImpl object reference of this object. |
void |
setJob(PepperJobImpl job)
Sets the
PepperJobImpl object reference of this object. |
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. |
void |
setPepperModule_basic(PepperModule newPepperModule)
Sets the
PepperModule object, this controller object is
observing. |
void |
setPepperModule(PepperModule newPepperModule)
Sets the
PepperModule object, this controller object is
observing. |
String getId()
PepperModule getPepperModule()
PepperModule
object, this controller object is
observing.PepperJobImpl getJob()
PepperJobImpl
object reference of this object.PepperJobImpl
objectvoid setJob(PepperJobImpl job)
PepperJobImpl
object reference of this object. And
notifies the reverse method PepperJobImpl
, to set the
ModuleControllerImpl
object to this.job
- new PepperJobImpl
objectvoid setJob_basic(PepperJobImpl job)
PepperJobImpl
object reference of this object.job
- new PepperJobImpl
objectDocumentBus getInputDocumentBus()
DocumentBus
object working as input for this
ModuleControllerImpl
. All documents on bus will be processed and
set to #outputDocumentBus
void setInputDocumentBus(DocumentBus inputDocumentBus)
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 busDocumentBus getOutputDocumentBus()
PepperModule
contained
in this object are set to this output bus, regarding the status, the
PepperModule
returned.void setOutputDocumentBus(DocumentBus outputDocumentBus)
PepperModule
contained
in this object are set to this output bus, regarding the status, the
PepperModule
returned.outputDocumentBus
- bus to be used as input busorg.corpus_tools.salt.common.SCorpusGraph getCorpusGraph()
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.Future<?> importCorpusStructure(org.corpus_tools.salt.common.SCorpusGraph sCorpusGraph)
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.DocumentController next(boolean ignorePermissionForDocument)
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 SDocument
s to sleep.ignorePermissionForDocument
- if set, a document will be returned even if the Pepper job
gives no permissionDocumentController next()
DocumentController
waiting in the input document
bus to be processed by the contained PepperModule
.void complete(DocumentController documentController)
DocumentController
to the output document bus to
be processed by the next PepperModule
objects.documentController
- to be passed to next Pepper modulevoid delete(DocumentController documentController)
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 processedDouble getProgress(String globalId)
PepperModule
object concerning to the SDocument
corresponding to the passed global identifier.globalId
- global id for SDocument
, note, that this is not the
SElementId
void setPepperModule(PepperModule newPepperModule)
PepperModule
object, this controller object is
observing. Also sets the inverse method
PepperModule#setPepperModuleController_basic(ModuleControllerImpl)
newPepperModule
- new object to observevoid setPepperModule_basic(PepperModule newPepperModule)
PepperModule
object, this controller object is
observing.newPepperModule
- new object to observeCopyright © 2009–2019 Humboldt-Universität zu Berlin, INRIA. All rights reserved.