org.corpus_tools.pepper.core

Class ModuleControllerImpl

java.lang.Object

org.corpus_tools.pepper.core.ModuleControllerImpl

All Implemented Interfaces:

ModuleController

public class ModuleControllerImpl
extends Object
implements ModuleController

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

Author:

Florian Zipser

Field Summary

Fields

Modifier and Type	Field and Description
protected ReentrantLock	busyLock A lock determining, whether this object currently is busy with importing corpus structure or importing document structure.
protected ExecutorService	executor Executor, to create and manage threads for import of corpus structure and import of document structure
protected String	id id of this object
protected PepperModule	pepperModule The PepperModule object, this controller object is observing.
protected org.corpus_tools.salt.common.SCorpusGraph	sCorpusGraph The SCorpusGraph object to be filled.

Constructor Summary

Constructors

Constructor and Description
ModuleControllerImpl(String id) Creates an instance of ModuleControllerImpl.

Method Summary

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.
protected ReentrantLock	getBusyLock() A lock determining, whether this object currently is busy with importing corpus structure or importing document structure.
org.corpus_tools.salt.common.SCorpusGraph	getCorpusGraph() Returns the SCorpusGraph object, the contained PepperImporter is mapping.
protected ExecutorService	getExecutor() Returns an executor service for this object.
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.
Future<?>	processDocumentStructures() Starts the import of document-structure.
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	toString() Returns a String representation of this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

id

protected String id

id of this object

pepperModule

protected PepperModule pepperModule

The PepperModule object, this controller object is observing.

sCorpusGraph

protected volatile org.corpus_tools.salt.common.SCorpusGraph sCorpusGraph

The SCorpusGraph object to be filled.

executor

protected ExecutorService executor

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

busyLock

protected ReentrantLock busyLock

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

Constructor Detail

ModuleControllerImpl

public ModuleControllerImpl(String id)

Creates an instance of ModuleControllerImpl. Sets the internal id to the passed one. Note: the id is unchangeable.

Parameters:

id - identifier of this object. Id can neither be null nor empty.

Method Detail

getId

public String getId()

Returns the id of this object.

Specified by:

getId in interface ModuleController

Returns:

the stable id

getPepperModule

public PepperModule getPepperModule()

Returns the PepperModule object, this controller object is observing.

Specified by:

getPepperModule in interface ModuleController

Returns:

observed object

setPepperModule

public void setPepperModule(PepperModule newPepperModule)

Sets the PepperModule object, this controller object is observing. Also sets the inverse method PepperModule#setPepperModuleController_basic(ModuleControllerImpl)

Specified by:

setPepperModule in interface ModuleController

Parameters:

newPepperModule - new object to observe

setPepperModule_basic

public void setPepperModule_basic(PepperModule newPepperModule)

Sets the PepperModule object, this controller object is observing.

Specified by:

setPepperModule_basic in interface ModuleController

Parameters:

newPepperModule - new object to observe

getJob

public PepperJobImpl getJob()

Returns the PepperJobImpl object reference of this object.

Specified by:

getJob in interface ModuleController

Returns:

containing PepperJobImpl object

setJob

public void setJob(PepperJobImpl job)

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

Specified by:

setJob in interface ModuleController

Parameters:

job - new PepperJobImpl object

setJob_basic

public void setJob_basic(PepperJobImpl job)

Sets the PepperJobImpl object reference of this object.

Specified by:

setJob_basic in interface ModuleController

Parameters:

job - new PepperJobImpl object

getInputDocumentBus

public DocumentBus getInputDocumentBus()

The DocumentBus object working as input for this ModuleControllerImpl. All documents on bus will be processed and set to #outputDocumentBus

Specified by:

getInputDocumentBus in interface ModuleController

Returns:

bus which is input bus

setInputDocumentBus

public void setInputDocumentBus(DocumentBus inputDocumentBus)

The DocumentBus object working as input for this ModuleControllerImpl. All documents on bus will be processed and set to #outputDocumentBus

Specified by:

setInputDocumentBus in interface ModuleController

Parameters:

inputDocumentBus - bus to be used as input bus

getOutputDocumentBus

public 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.

Specified by:

getOutputDocumentBus in interface ModuleController

Returns:

bus, which is output bus

setOutputDocumentBus

public 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.

Specified by:

setOutputDocumentBus in interface ModuleController

Parameters:

outputDocumentBus - bus to be used as input bus

getCorpusGraph

public org.corpus_tools.salt.common.SCorpusGraph 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 ModuleController.importCorpusStructure(SCorpusGraph) was called.

Specified by:

getCorpusGraph in interface ModuleController

Returns:

getExecutor

protected ExecutorService getExecutor()

Returns an executor service for this object. Executor, to create and manage threads for import of corpus structure and import of document structure.

Returns:

importCorpusStructure

public 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). 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.

Specified by:

importCorpusStructure in interface ModuleController

Parameters:

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

processDocumentStructures

public Future<?> processDocumentStructures()

Starts the import of document-structure. When calling this method, the ModuleControllerImpl object will request all DocumentController object waiting in the incoming DocumentBus.

getBusyLock

protected ReentrantLock getBusyLock()

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

Returns:

next

public DocumentController 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.

Specified by:

next in interface ModuleController

Parameters:

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

Returns:

next document controller

next

public DocumentController next()

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

Specified by:

next in interface ModuleController

Returns:

next document controller

complete

public void complete(DocumentController documentController)

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

Specified by:

complete in interface ModuleController

Parameters:

documentController - to be passed to next Pepper module

delete

public 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.

Specified by:

delete in interface ModuleController

getProgress

public 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.

Specified by:

getProgress in interface ModuleController

Parameters:

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

Returns:

progress of process

toString

public String toString()

Returns a String representation of this object.

Overrides:

toString in class Object

Returns:

a String representation of this object.