Package org.corpus_tools.pepper.modules

Interface PepperMapper

    • Method Detail

      • setPepperMapperController

        void setPepperMapperController​(PepperMapperController controller)
        Sets the controller of this mapper, to grant n access to Pepper via the controller.
        Parameters:
        controller - controller for this object

      • getPepperMapperController

        PepperMapperController getPepperMapperController()
        Returns the controller of this mapper, to grant n access to Pepper via the controller.
        Returns:
        controller for this object

      • setResourceURI

        void setResourceURI​(org.eclipse.emf.common.util.URI resourceURI)
        Sets URI of resource. The URI could refer a directory or a file, which can be a corpus or a document.
        Parameters:
        resourceURI - uri of resource

      • getResourceURI

        org.eclipse.emf.common.util.URI getResourceURI()
        Returns URI of resource. The URI could refer a directory or a file, which can be a corpus or a document.
        Returns:
        uri of resource

      • getDocument

        org.corpus_tools.salt.common.SDocument getDocument()
        Returns the SDocument object to be mapped by this mapper.
        Returns:
        SDocument object to be mapped

      • getMappingSubjects

        List<MappingSubject> getMappingSubjects()
        Returns a list of all subjects (SDocument or SCorpus) to be merged
        Returns:
        a list of MappingSubject

      • setDocument

        void setDocument​(org.corpus_tools.salt.common.SDocument sDocument)
        Sets the SDocument object to be mapped by this mapper.
        Parameters:
        sDocument - SDocument object to be mapped

      • getCorpus

        org.corpus_tools.salt.common.SCorpus getCorpus()
        Returns the SCorpus object to be mapped by this mapper.
        Returns:
        SCorpus object to be mapped

      • setCorpus

        void setCorpus​(org.corpus_tools.salt.common.SCorpus sCorpus)
        Sets the SCorpus object to be mapped by this mapper.
        Parameters:
        sCorpus - SCorpus object to be mapped

      • setMappingResult

        void setMappingResult​(DOCUMENT_STATUS mappingResult)
        Sets the result of the current mapping, when it is finished.
        Parameters:
        status - of mapping

      • getMappingResult

        DOCUMENT_STATUS getMappingResult()
        Returns the result of the mapping, when finished.
        Returns:
        mapping result

      • mapSDocument

        DOCUMENT_STATUS mapSDocument()
        Starts to map a given SDocument object, if one is given.

      • mapSCorpus

        DOCUMENT_STATUS mapSCorpus()
        Starts to map a given SCorpus object, if one is given.

      • getProgress

        Double getProgress()
        This method is invoked by the containing PepperModule object, to get the current progress concerning the SDocument or SCorpus object handled by this object. A valid value return must be between 0 and 1 or null if method the PepperModule does not call the method setProgress(Double).
        Parameters:
        sDocumentId - identifier of the requested SDocument object.

      • addProgress

        void addProgress​(Double progress)
        Adds the given progress to the already existing progress of the current handled SDocument or SCorpus object. This method should be called by the PepperMapper containing this connector object.
        Parameters:
        progress - the progress must be a value between 0 for 0% and 1 for 100%

      • setProgress

        void setProgress​(Double progress)
        Sets the progress of the current handled SDocument or SCorpus object. This method should be called by the PepperMapper containing this connector object.
        Parameters:
        progress - the progress must be a value between 0 for 0% and 1 for 100%