Package org.corpus_tools.pepper.modules

Interface DocumentController

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

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

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