org.corpus_tools.pepper.core

Class DocumentControllerImpl

java.lang.Object

org.corpus_tools.pepper.core.DocumentControllerImpl

All Implemented Interfaces:

DocumentController

public class DocumentControllerImpl
extends Object
implements DocumentController

Stores the global status of a SDocument. And a list of tuples for all Modules and their current status. Can send SDocumentGraphs contained in given SDocument to sleep and wake them.

Author:

Florian Zipser

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DocumentControllerImpl.DetailedStatus A small helper class, to store the status and the processing a specific PepperModule needed for the SDocument object contained by the container DocumentControllerImpl object.

Field Summary

Fields

Modifier and Type	Field and Description
protected ModuleController	currentModuleController stores the currently active document controller
protected boolean	isStarted Determines, if this object is already 'started', which means if #updateStatus(String, DOCUMENT_STATUS) has been called.
protected List<ModuleControllerImpl>	moduleControllers A list of all ModuleControllerImpl objects, the here contained SDocument object has to pass.
protected int	numberOfProcessingModules Stores the number of PepperModule, currently processing this DocumentControllerImpl.

Constructor Summary

Constructors

Constructor and Description
DocumentControllerImpl() Initializes an object of this class.
DocumentControllerImpl(org.corpus_tools.salt.common.SDocument document) Initializes an object of this class.

Method Summary

Modifier and Type	Method and Description
void	addModuleControllers(ModuleControllerImpl moduleController) Adds a further ModuleControllerImpl to internal list of all ModuleControllerImpl objects, the here contained SDocument object has to pass.
void	awake() Wakes up the contained SDocument, which means, it the SDocumentGraph of the SDocument will be load to main memory again by calling SDocument#loadSDocumentGraph().
ModuleController	getCurrentModuleController() Returns the module controller, which is currently processing this document.
org.corpus_tools.salt.common.SDocument	getDocument() Returns the SDocument object, to which this object belongs to.
org.corpus_tools.salt.graph.Identifier	getDocumentId() Returns the Identifier of the SDocument object, to which this object belongs to.
String	getGlobalId() Returns a global unique (inside one Salt project) id for the contained SDocument object.
DOCUMENT_STATUS	getGlobalStatus() Returns the global status of this object.
org.eclipse.emf.common.util.URI	getLocation() Returns location, where to store SDocumentGraph when #sleep() was called or load when DocumentController.awake() was called
List<ModuleControllerImpl>	getModuleControllers() Returns a list of all ModuleControllerImpl objects, the here contained SDocument object has to pass.
int	getNumOfProcessingModules() Returns the number of PepperModule currently processing the SDocument or more precisly the SDocumentGraph contained by this DocumentControllerImpl object.
Long	getProcessingTime() Returns the processing time of the contained SDocument object, needed by all registered PepperModule, which have already started the process.
double	getProgress() Returns the progress of the contained SDocument for all registered ModuleControllerImpl objects.
int	getSize_nodes() Stores the number of SNodes a document contains, when it ws send to sleep.
int	getSize_relations() Stores the number of SRelations a document contains, when it ws send to sleep.
String	getStatusReport() Returns a formated string containing a report of the progress status of the contained document.
boolean	isAsleep() Returns if the SDocumentGraph of contained SDocument is send to sleep or awake.
void	sendToSleep_FORCE() Sends the DocumentControllerImpl object, that the contained SDocument or more precisely the SDocumentGraph object could be send to sleep as method DocumentController.sendToSleep().
void	sendToSleep() Notifies the DocumentControllerImpl object, that the contained SDocument or more precisely the SDocumentGraph object could be send to sleep.
void	setCallGC(boolean callGC) Sets whether the garbage collector should be called after sending a SDocument object to sleep.
void	setDocument(org.corpus_tools.salt.common.SDocument sDocument) Sets the SDocument object, to which this object belongs to.
void	setLocation(org.eclipse.emf.common.util.URI location) Sets location, where to store SDocumentGraph when #sleep() was called or load when DocumentController.awake() was called.
protected void	sleep() Sends the contained SDocument to sleep, which means, it will be stored to local disk and removed from main memory, by calling SDocument#saveSDocumentGraph(org.eclipse.emf.common.util.URI).
String	toString() Returns a textual representation of this object.
void	updateStatus(ModuleController moduleController, DOCUMENT_STATUS status) Updates the status of a specified of contained SDocument object corresponding to the ModuleControllerImpl matching to the passed id.

Methods inherited from class java.lang.Object

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

Field Detail

moduleControllers

protected volatile List<ModuleControllerImpl> moduleControllers

A list of all ModuleControllerImpl objects, the here contained SDocument object has to pass.

isStarted

protected volatile boolean isStarted

Determines, if this object is already 'started', which means if #updateStatus(String, DOCUMENT_STATUS) has been called.

numberOfProcessingModules

protected volatile int numberOfProcessingModules

Stores the number of PepperModule, currently processing this DocumentControllerImpl. Number is determined by method #updateStatus(String, DOCUMENT_STATUS)

currentModuleController

protected volatile ModuleController currentModuleController

stores the currently active document controller

Constructor Detail

DocumentControllerImpl

public DocumentControllerImpl()

Initializes an object of this class. The default value of DOCUMENT_STATUS will be set to DOCUMENT_STATUS.NOT_STARTED.

DocumentControllerImpl

public DocumentControllerImpl(org.corpus_tools.salt.common.SDocument document)

Initializes an object of this class. The default value of DOCUMENT_STATUS will be set to DOCUMENT_STATUS.NOT_STARTED.

Parameters:

document - SDocument object which is controlled by this object

Method Detail

getDocument

public org.corpus_tools.salt.common.SDocument getDocument()

Returns the SDocument object, to which this object belongs to.

Specified by:

getDocument in interface DocumentController

Returns:

document id

setDocument

public void setDocument(org.corpus_tools.salt.common.SDocument sDocument)

Sets the SDocument object, to which this object belongs to. Computes the globalId ( see: DocumentController.getGlobalId()). Adds the global id as processing instruction to the SDocument object.

Specified by:

setDocument in interface DocumentController

Parameters:

sDocument - SDocument object to which this object belongs to

getDocumentId

public org.corpus_tools.salt.graph.Identifier getDocumentId()

Returns the Identifier of the SDocument object, to which this object belongs to.

Specified by:

getDocumentId in interface DocumentController

Returns:

document id

getGlobalId

public String getGlobalId()

Returns a global unique (inside one Salt project) id for the contained SDocument object. This identifier is computed by mthe number of the SCorpusGraph in list, this SDocument object is contained in and the Identifier of the SDocument. Imagine the number of the SCorpusGraph is 1 and the Identifier.getId() is /corpus1/document1, than the returned global id is /1/corpus1/document1.

Specified by:

getGlobalId in interface DocumentController

Returns:

a global unique (inside one Salt project) id for the contained SDocument object

setCallGC

public void setCallGC(boolean callGC)

Sets whether the garbage collector should be called after sending a SDocument object to sleep.

Parameters:

callGC -

getLocation

public org.eclipse.emf.common.util.URI getLocation()

Returns location, where to store SDocumentGraph when #sleep() was called or load when DocumentController.awake() was called

Specified by:

getLocation in interface DocumentController

Returns:

location

setLocation

public void setLocation(org.eclipse.emf.common.util.URI location)

Sets location, where to store SDocumentGraph when #sleep() was called or load when DocumentController.awake() was called.

Specified by:

setLocation in interface DocumentController

Parameters:

location - location as URI

isAsleep

public boolean isAsleep()

Returns if the SDocumentGraph of contained SDocument is send to sleep or awake.

Specified by:

isAsleep in interface DocumentController

Returns:

true, if SDocumentGraph is asleep, false otherwise.

sleep

protected void sleep()

Sends the contained SDocument to sleep, which means, it will be stored to local disk and removed from main memory, by calling SDocument#saveSDocumentGraph(org.eclipse.emf.common.util.URI). The counterpart to this method is awake(). Both methods are synchronized.

sendToSleep

public void sendToSleep()

Notifies the DocumentControllerImpl object, that the contained SDocument or more precisely the SDocumentGraph object could be send to sleep. If no PepperModule is currently processing it, the SDocumentGraph is send to sleep. This means, the SDocumentGraph will be stored to local disk and removed from main memory, by calling SDocument#saveSDocumentGraph(org.eclipse.emf.common.util.URI). The counterpart to this method is DocumentController.awake(). Both methods are synchronized.

Specified by:

sendToSleep in interface DocumentController

sendToSleep_FORCE

public void sendToSleep_FORCE()

Sends the DocumentControllerImpl object, that the contained SDocument or more precisely the SDocumentGraph object could be send to sleep as method DocumentController.sendToSleep().
But note, this method does not check if the SDocumentGraph is still in use by any other module. Therfore handle with care.

Specified by:

sendToSleep_FORCE in interface DocumentController

awake

public void awake()

Wakes up the contained SDocument, which means, it the SDocumentGraph of the SDocument will be load to main memory again by calling SDocument#loadSDocumentGraph(). The counterpart to this method is #sleep(). Both methods are synchronized.

Specified by:

awake in interface DocumentController

toString

public String toString()

Returns a textual representation of this object. Note: This representation could not be used for serialization/deserialization purposes.

Overrides:

toString in class Object

Returns:

textual representation

getModuleControllers

public List<ModuleControllerImpl> getModuleControllers()

Returns a list of all ModuleControllerImpl objects, the here contained SDocument object has to pass.

Specified by:

getModuleControllers in interface DocumentController

Returns:

a list of all ModuleControllerImpl objects

addModuleControllers

public void addModuleControllers(ModuleControllerImpl moduleController)

Adds a further ModuleControllerImpl to internal list of all ModuleControllerImpl objects, the here contained SDocument object has to pass.
Note: You cannot call this method anymore, if the process has already been started. Which means that the methods #updateStatus(String, DOCUMENT_STATUS) has been called.

Specified by:

addModuleControllers in interface DocumentController

Parameters:

moduleController - ModuleControllerImpl the SDocument also has to pass

getNumOfProcessingModules

public int getNumOfProcessingModules()

Returns the number of PepperModule currently processing the SDocument or more precisly the SDocumentGraph contained by this DocumentControllerImpl object.

Specified by:

getNumOfProcessingModules in interface DocumentController

Returns:

number of processing PepperModule objects

getCurrentModuleController

public ModuleController getCurrentModuleController()

Returns the module controller, which is currently processing this document.

Specified by:

getCurrentModuleController in interface DocumentController

Returns:

the currently active ModuleController

updateStatus

public void updateStatus(ModuleController moduleController,
                         DOCUMENT_STATUS status)

Updates the status of a specified of contained SDocument object corresponding to the ModuleControllerImpl matching to the passed id.

Specified by:

updateStatus in interface DocumentController

status - the status to which the StepStatus shall be set to.

getGlobalStatus

public DOCUMENT_STATUS getGlobalStatus()

Returns the global status of this object. The global status is determined by each StepStatus object being contained in this object.

• If one of the contained StepStatus objects status value is set to DOCUMENT_STATUS.IN_PROGRESS, the global status will be DOCUMENT_STATUS.IN_PROGRESS.
• If one of the contained StepStatus objects status value is set to DOCUMENT_STATUS.DELETED, the global status will be DOCUMENT_STATUS.DELETED.
• If one of the contained StepStatus objects status value is set to DOCUMENT_STATUS.FAILED, the global status will be DOCUMENT_STATUS.FAILED.
• Only if each contained StepStatus objects status value is set to DOCUMENT_STATUS.COMPLETED, the global status will be DOCUMENT_STATUS.COMPLETED.

Specified by:

getGlobalStatus in interface DocumentController

Returns:

getProgress

public double getProgress()

Returns the progress of the contained SDocument for all registered ModuleControllerImpl objects.

Specified by:

getProgress in interface DocumentController

Returns:

percentage value between 0 and 1.

getProcessingTime

public Long getProcessingTime()

Returns the processing time of the contained SDocument object, needed by all registered PepperModule, which have already started the process.

Specified by:

getProcessingTime in interface DocumentController

getStatusReport

public String getStatusReport()

Returns a formated string containing a report of the progress status of the contained document.

Returns:

a report of the progress status

getSize_nodes

public int getSize_nodes()

Stores the number of SNodes a document contains, when it ws send to sleep.

Specified by:

getSize_nodes in interface DocumentController

Returns:

number of SNode of the contained document

getSize_relations

public int getSize_relations()

Stores the number of SRelations a document contains, when it ws send to sleep.

Specified by:

getSize_relations in interface DocumentController

Returns:

number of SRelation of the contained document