DocumentController (pepper-framework 3.4.1 API)

All Known Implementing Classes:

DocumentControllerImpl
```
public interface DocumentController
```

Method Summary

All Methods Instance Methods Abstract Methods
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 `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 `SNode`s a document contains, when it ws send to sleep.
`int`	`getSize_relations()` Stores the number of `SRelation`s a document contains, when it ws send to sleep.
`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 `sendToSleep()`.
`void`	`sendToSleep()` Notifies the `DocumentControllerImpl` object, that the contained `SDocument` or more precisely the `SDocumentGraph` object could be send 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 `awake()` was called.
`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.

- Method Detail
  - getDocument
```
org.corpus_tools.salt.common.SDocument getDocument()
```
    Returns the SDocument object, to which this object belongs to.
    
    Returns:
    
    document id
  - setDocument
```
void setDocument(org.corpus_tools.salt.common.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.
    
    Parameters:
    
    sDocument - SDocument object to which this object belongs to
  - getDocumentId
```
org.corpus_tools.salt.graph.Identifier getDocumentId()
```
    Returns the Identifier of the SDocument object, to which this object belongs to.
    
    Returns:
    
    document id
  - getGlobalId
```
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.
    
    Returns:
    
    a global unique (inside one Salt project) id for the contained SDocument object
  - getLocation
```
org.eclipse.emf.common.util.URI getLocation()
```
    Returns location, where to store SDocumentGraph when #sleep() was called or load when awake() was called
    
    Returns:
    
    location
  - setLocation
```
void setLocation(org.eclipse.emf.common.util.URI location)
```
    Sets location, where to store SDocumentGraph when #sleep() was called or load when awake() was called.
    
    Parameters:
    
    location - location as URI
  - getSize_nodes
```
int getSize_nodes()
```
    Stores the number of SNodes a document contains, when it ws send to sleep.
    
    Returns:
    
    number of SNode of the contained document
  - getSize_relations
```
int getSize_relations()
```
    Stores the number of SRelations a document contains, when it ws send to sleep.
    
    Returns:
    
    number of SRelation of the contained document
  - isAsleep
```
boolean isAsleep()
```
    Returns if the SDocumentGraph of contained SDocument is send to sleep or awake.
    
    Returns:
    
    true, if SDocumentGraph is asleep, false otherwise.
  - sendToSleep
```
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.
  - sendToSleep_FORCE
```
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.
  - awake
```
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.
  - getModuleControllers
```
List<ModuleControllerImpl> getModuleControllers()
```
    Returns a list of all ModuleControllerImpl objects, the here contained SDocument object has to pass.
    
    Returns:
    
    a list of all ModuleControllerImpl objects
  - getCurrentModuleController
```
ModuleController getCurrentModuleController()
```
    Returns the module controller, which is currently processing this document.
    
    Returns:
    
    the currently active ModuleController
  - addModuleControllers
```
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.
    
    Parameters:
    
    moduleController - ModuleControllerImpl the SDocument also has to pass
  - getNumOfProcessingModules
```
int getNumOfProcessingModules()
```
    Returns the number of PepperModule currently processing the SDocument or more precisly the SDocumentGraph contained by this DocumentControllerImpl object.
    
    Returns:
    
    number of processing PepperModule objects
  - updateStatus
```
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.
    
    Parameters:
    
    pModuleController - determines the StepStatus object
    
    status - the status to which the StepStatus shall be set to.
  - getGlobalStatus
```
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.
    Returns:
  - getProgress
```
double getProgress()
```
    Returns the progress of the contained SDocument for all registered ModuleControllerImpl objects.
    
    Returns:
    
    percentage value between 0 and 1.
  - getProcessingTime
```
Long getProcessingTime()
```
    Returns the processing time of the contained SDocument object, needed by all registered PepperModule, which have already started the process.

Interface DocumentController

Method Summary

Method Detail

getDocument

setDocument

getDocumentId

getGlobalId

getLocation

setLocation

getSize_nodes

getSize_relations

isAsleep

sendToSleep

sendToSleep_FORCE

awake

getModuleControllers

getCurrentModuleController

addModuleControllers

getNumOfProcessingModules

updateStatus

getGlobalStatus

getProgress

getProcessingTime