org.corpus_tools.pepper.core.ModuleControllerImpl Class Reference

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

Inherits ModuleController.

Public Member Functions
	ModuleControllerImpl (String id)
	Creates an instance of ModuleControllerImpl.
String	getId ()
PepperModule	getPepperModule ()
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.
PepperJobImpl	getJob ()
void	setJob (PepperJobImpl job)
void	setJob_basic (PepperJobImpl job)
DocumentBus	getInputDocumentBus ()
void	setInputDocumentBus (DocumentBus inputDocumentBus)
DocumentBus	getOutputDocumentBus ()
void	setOutputDocumentBus (DocumentBus outputDocumentBus)
SCorpusGraph	getCorpusGraph ()
synchronized Future<?>	importCorpusStructure (SCorpusGraph sCorpusGraph)
synchronized Future<?>	processDocumentStructures ()
	Starts the import of document-structure.
DocumentController	next (boolean ignorePermissionForDocument)
	{@inheritDoc ModuleController::next(boolean)}
DocumentController	next ()
void	complete (DocumentController documentController)
void	delete (DocumentController documentController)
Double	getProgress (String globalId)
String	toString ()
	Returns a String representation of this object.

Protected Member Functions
ExecutorService	getExecutor ()
	Returns an executor service for this object.
ReentrantLock	getBusyLock ()
	A lock determining, whether this object currently is busy with importing corpus structure or importing document structure.

Protected Attributes
String	id = null
	id of this object
PepperModule	pepperModule
	The PepperModule object, this controller object is observing.
volatile SCorpusGraph	sCorpusGraph = null
	The SCorpusGraph object to be filled.
ExecutorService	executor = null
	Executor, to create and manage threads for import of corpus structure and import of document structure.
ReentrantLock	busyLock = null
	A lock determining, whether this object currently is busy with importing corpus structure or importing document structure.

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

Constructor & Destructor Documentation

ModuleControllerImpl()

org.corpus_tools.pepper.core.ModuleControllerImpl.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.

Member Function Documentation

getBusyLock()

ReentrantLock org.corpus_tools.pepper.core.ModuleControllerImpl.getBusyLock ( )

protected

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

Returns

getExecutor()

ExecutorService org.corpus_tools.pepper.core.ModuleControllerImpl.getExecutor ( )

protected

Returns an executor service for this object.

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

Returns

processDocumentStructures()

synchronized Future<?> org.corpus_tools.pepper.core.ModuleControllerImpl.processDocumentStructures

(

)

Starts the import of document-structure.

When calling this method, the ModuleControllerImpl object will request all DocumentController object waiting in the incoming DocumentBus.

setPepperModule()

void org.corpus_tools.pepper.core.ModuleControllerImpl.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.core.ModuleControllerImpl.setPepperModule_basic

(

PepperModule

newPepperModule

)

Sets the PepperModule object, this controller object is observing.

Parameters

newPepperModule

new object to observe

toString()

String org.corpus_tools.pepper.core.ModuleControllerImpl.toString

(

)

Returns a String representation of this object.

Returns

a String representation of this object.