Pepper
3.6.0
A highly extensible plattform for conversion and manipulationoflinguisticdata.
|
Stores the global status of a SDocument. More...
Inherits org.corpus_tools.pepper.modules.DocumentController.
Classes | |
class | 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. | |
Public Member Functions | |||||
DocumentControllerImpl () | |||||
Initializes an object of this class. More... | |||||
DocumentControllerImpl (SDocument document) | |||||
Initializes an object of this class. More... | |||||
SDocument | getDocument () | ||||
Returns the SDocument object, to which this object belongs to.
| |||||
void | setDocument (SDocument sDocument) | ||||
Sets the SDocument object, to which this object belongs to.Computes the globalId ( see: getGlobalId()). Adds the global id as processing instruction to the SDocument object.
| |||||
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.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.
| |||||
void | setCallGC (boolean callGC) | ||||
Sets whether the garbage collector should be called after sending a SDocument object to sleep. More... | |||||
URI | getLocation () | ||||
Returns location, where to store SDocumentGraph when sleep() was called or load when awake() was called.
| |||||
void | setLocation (URI location) | ||||
Sets location, where to store SDocumentGraph when sleep() was called or load when awake() was called.
| |||||
boolean | isAsleep () | ||||
Returns if the SDocumentGraph of contained SDocument is send to sleep or awake.
| |||||
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 awake(). Both methods are synchronized. | |||||
void | sendToSleep_FORCE () | ||||
Sends the DocumentControllerImpl object, that the contained SDocument or more precisely the SDocumentGraph object could be send to sleep as method sendToSleep(). But note, this method does not check if the SDocumentGraph is still in use by any other module. Therfore handle with care. | |||||
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. | |||||
String | toString () | ||||
Returns a textual representation of this object. More... | |||||
List< ModuleControllerImpl > | getModuleControllers () | ||||
Returns a list of all ModuleControllerImpl objects, the here contained SDocument object has to pass.
| |||||
synchronized 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.
| |||||
int | getNumOfProcessingModules () | ||||
Returns the number of PepperModule currently processing the SDocument or more precisly the SDocumentGraph contained by this DocumentControllerImpl object.
| |||||
ModuleController | getCurrentModuleController () | ||||
Returns the module controller, which is currently processing this document.
| |||||
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.
| |||||
DOCUMENT_STATUS | getGlobalStatus () | ||||
Returns the global status of this object.The global status is determined by each StepStatus object being contained in this object.
| |||||
double | getProgress () | ||||
Returns the progress of the contained SDocument for all registered ModuleControllerImpl objects.
| |||||
Long | getProcessingTime () | ||||
Returns the processing time of the contained SDocument object, needed by all registered PepperModule, which have already started the process. | |||||
String | getStatusReport () | ||||
Returns a formated string containing a report of the progress status of the contained document. More... | |||||
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.
| |||||
Protected Member Functions | |
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). More... | |
Protected Attributes | |
volatile List< ModuleControllerImpl > | moduleControllers = null |
A list of all ModuleControllerImpl objects, the here contained SDocument object has to pass. | |
volatile boolean | isStarted = false |
Determines, if this object is already 'started', which means if updateStatus(String, DOCUMENT_STATUS) has been called. | |
volatile int | numberOfProcessingModules = 0 |
Stores the number of PepperModule, currently processing this DocumentControllerImpl. More... | |
volatile ModuleController | currentModuleController = null |
stores the currently active document controller | |
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.
org.corpus_tools.pepper.core.DocumentControllerImpl.DocumentControllerImpl | ( | ) |
Initializes an object of this class.
The default value of DOCUMENT_STATUS will be set to DOCUMENT_STATUS#NOT_STARTED.
org.corpus_tools.pepper.core.DocumentControllerImpl.DocumentControllerImpl | ( | SDocument | document | ) |
Initializes an object of this class.
The default value of DOCUMENT_STATUS will be set to DOCUMENT_STATUS#NOT_STARTED.
document | SDocument object which is controlled by this object |
String org.corpus_tools.pepper.core.DocumentControllerImpl.getStatusReport | ( | ) |
Returns a formated string containing a report of the progress status of the contained document.
void org.corpus_tools.pepper.core.DocumentControllerImpl.setCallGC | ( | boolean | callGC | ) |
Sets whether the garbage collector should be called after sending a SDocument object to sleep.
callGC |
|
protected |
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.
String org.corpus_tools.pepper.core.DocumentControllerImpl.toString | ( | ) |
Returns a textual representation of this object.
Note: This representation could not be used for serialization/deserialization purposes.
|
protected |
Stores the number of PepperModule, currently processing this DocumentControllerImpl.
Number is determined by method updateStatus(String, DOCUMENT_STATUS)