public interface PepperMapper
PepperModule
is used for delegating thread jobs, and a set of
PepperMappers are mapping one SDocument
or SCorpus
object.Modifier and Type | Method and Description |
---|---|
void |
addProgress(Double progress)
Adds the given progress to the already existing progress of the current
handled
SDocument or SCorpus object. |
org.corpus_tools.salt.common.SCorpus |
getCorpus()
Returns the
SCorpus object to be mapped by this mapper. |
org.corpus_tools.salt.common.SDocument |
getDocument()
Returns the
SDocument object to be mapped by this mapper. |
DOCUMENT_STATUS |
getMappingResult()
Returns the result of the mapping, when finished.
|
List<MappingSubject> |
getMappingSubjects()
Returns a list of all subjects (
SDocument or SCorpus ) to
be merged |
PepperMapperController |
getPepperMapperController()
Returns the controller of this mapper, to grant n access to Pepper via
the controller.
|
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. |
PepperModuleProperties |
getProperties()
Returns the
PepperModuleProperties object containing user
customizations to be observed during the mapping. |
org.eclipse.emf.common.util.URI |
getResourceURI()
Returns
URI of resource. |
DOCUMENT_STATUS |
mapSCorpus()
Starts to map a given
SCorpus object, if one is given. |
DOCUMENT_STATUS |
mapSDocument()
Starts to map a given
SDocument object, if one is given. |
void |
setCorpus(org.corpus_tools.salt.common.SCorpus sCorpus)
Sets the
SCorpus object to be mapped by this mapper. |
void |
setDocument(org.corpus_tools.salt.common.SDocument sDocument)
Sets the
SDocument object to be mapped by this mapper. |
void |
setMappingResult(DOCUMENT_STATUS mappingResult)
Sets the result of the current mapping, when it is finished.
|
void |
setPepperMapperController(PepperMapperController controller)
Sets the controller of this mapper, to grant n access to Pepper via the
controller.
|
void |
setProgress(Double progress)
Sets the progress of the current handled
SDocument or
SCorpus object. |
void |
setProperties(PepperModuleProperties props)
Sets the
PepperModuleProperties object containing user
customizations to be observed during the mapping. |
void |
setResourceURI(org.eclipse.emf.common.util.URI resourceURI)
Sets
URI of resource. |
void setPepperMapperController(PepperMapperController controller)
controller
- controller for this objectPepperMapperController getPepperMapperController()
void setResourceURI(org.eclipse.emf.common.util.URI resourceURI)
URI
of resource. The URI could refer a directory or a file,
which can be a corpus or a document.resourceURI
- uri of resourceorg.eclipse.emf.common.util.URI getResourceURI()
URI
of resource. The URI could refer a directory or a
file, which can be a corpus or a document.org.corpus_tools.salt.common.SDocument getDocument()
SDocument
object to be mapped by this mapper.SDocument
object to be mappedList<MappingSubject> getMappingSubjects()
SDocument
or SCorpus
) to
be mergedMappingSubject
void setDocument(org.corpus_tools.salt.common.SDocument sDocument)
SDocument
object to be mapped by this mapper.sDocument
- SDocument
object to be mappedorg.corpus_tools.salt.common.SCorpus getCorpus()
SCorpus
object to be mapped by this mapper.SCorpus
object to be mappedvoid setCorpus(org.corpus_tools.salt.common.SCorpus sCorpus)
SCorpus
object to be mapped by this mapper.sCorpus
- SCorpus
object to be mappedPepperModuleProperties getProperties()
PepperModuleProperties
object containing user
customizations to be observed during the mapping.PepperModuleProperties
object to be usedvoid setProperties(PepperModuleProperties props)
PepperModuleProperties
object containing user
customizations to be observed during the mapping.props
- PepperModuleProperties
object to be usedvoid setMappingResult(DOCUMENT_STATUS mappingResult)
status
- of mappingDOCUMENT_STATUS getMappingResult()
DOCUMENT_STATUS mapSDocument()
SDocument
object, if one is given.DOCUMENT_STATUS mapSCorpus()
SCorpus
object, if one is given.Double getProgress()
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)
.sDocumentId
- identifier of the requested SDocument
object.void addProgress(Double progress)
SDocument
or SCorpus
object. This method should
be called by the PepperMapper
containing this connector object.progress
- the progress must be a value between 0 for 0% and 1 for 100%void setProgress(Double progress)
SDocument
or
SCorpus
object. This method should be called by the
PepperMapper
containing this connector object.progress
- the progress must be a value between 0 for 0% and 1 for 100%Copyright © 2009–2019 Humboldt-Universität zu Berlin, INRIA. All rights reserved.