org.corpus_tools.pepper.impl

Class PepperMapperImpl

java.lang.Object

org.corpus_tools.pepper.impl.PepperMapperImpl

All Implemented Interfaces:

PepperMapper

Direct Known Subclasses:

SaltValidator.ValidatorMapper, TextImporter.TextMapper

public class PepperMapperImpl
extends Object
implements PepperMapper

An abstract implementation of PepperMapper to be used for further derivations for specific mapping purposes.

Author:

Florian Zipser

Field Summary

Fields

Modifier and Type	Field and Description
protected PepperMapperController	controller
protected Double	progress Stores the current progress (between 0 and 1)
protected PepperModuleProperties	props PepperModuleProperties object containing user customizations to be observed during the mapping.

Constructor Summary

Constructors

Constructor and Description
PepperMapperImpl()

Method Summary

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.
protected void	initialize() This method initializes this object and is called by the constructor.
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.
protected void	readXMLResource(DefaultHandler2 contentHandler, org.eclipse.emf.common.util.URI documentLocation) Helper method to read an xml file with a DefaultHandler2 implementation given as contentHandler.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

props

protected PepperModuleProperties props

PepperModuleProperties object containing user customizations to be observed during the mapping.

progress

protected volatile Double progress

Stores the current progress (between 0 and 1)

controller

protected PepperMapperController controller

Constructor Detail

PepperMapperImpl

public PepperMapperImpl()

Method Detail

getMappingSubjects

public List<MappingSubject> getMappingSubjects()

Returns a list of all subjects (SDocument or SCorpus) to be merged

Specified by:

getMappingSubjects in interface PepperMapper

Returns:

a list of MappingSubject

getResourceURI

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

Specified by:

getResourceURI in interface PepperMapper

Returns:

uri of resource

setResourceURI

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

Specified by:

setResourceURI in interface PepperMapper

Parameters:

resourceURI - uri of resource

getDocument

public org.corpus_tools.salt.common.SDocument getDocument()

Returns the SDocument object to be mapped by this mapper.

Specified by:

getDocument in interface PepperMapper

Returns:

SDocument object to be mapped

setDocument

public void setDocument(org.corpus_tools.salt.common.SDocument sDocument)

Sets the SDocument object to be mapped by this mapper.

Specified by:

setDocument in interface PepperMapper

Parameters:

sDocument - SDocument object to be mapped

getCorpus

public org.corpus_tools.salt.common.SCorpus getCorpus()

Returns the SCorpus object to be mapped by this mapper.

Specified by:

getCorpus in interface PepperMapper

Returns:

SCorpus object to be mapped

setCorpus

public void setCorpus(org.corpus_tools.salt.common.SCorpus sCorpus)

Sets the SCorpus object to be mapped by this mapper.

Specified by:

setCorpus in interface PepperMapper

Parameters:

sCorpus - SCorpus object to be mapped

getProperties

public PepperModuleProperties getProperties()

Returns the PepperModuleProperties object containing user customizations to be observed during the mapping.

Specified by:

getProperties in interface PepperMapper

Returns:

PepperModuleProperties object to be used

setProperties

public void setProperties(PepperModuleProperties props)

Sets the PepperModuleProperties object containing user customizations to be observed during the mapping.

Specified by:

setProperties in interface PepperMapper

Parameters:

props - PepperModuleProperties object to be used

setMappingResult

public void setMappingResult(DOCUMENT_STATUS mappingResult)

Sets the result of the current mapping, when it is finished.

Specified by:

setMappingResult in interface PepperMapper

getMappingResult

public DOCUMENT_STATUS getMappingResult()

Returns the result of the mapping, when finished.

Specified by:

getMappingResult in interface PepperMapper

Returns:

mapping result

initialize

protected void initialize()

This method initializes this object and is called by the constructor. OVERRIDE THIS METHOD FOR CUSTOMIZED MAPPING.

mapSDocument

public DOCUMENT_STATUS mapSDocument()

Starts to map a given SDocument object, if one is given. OVERRIDE THIS METHOD FOR CUSTOMIZED MAPPING. NOTE: This method is only called if the element to be mapped is of type SDocument, i.e., if this.getDocument() != null!

Specified by:

mapSDocument in interface PepperMapper

mapSCorpus

public DOCUMENT_STATUS mapSCorpus()

Starts to map a given SCorpus object, if one is given. OVERRIDE THIS METHOD FOR CUSTOMIZED MAPPING. NOTE: This method is only called if the element to be mapped is of type SCorpus, i.e., if this.getCorpus() != null!

Specified by:

mapSCorpus in interface PepperMapper

getProgress

public 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 PepperMapper.setProgress(Double).

Specified by:

getProgress in interface PepperMapper

addProgress

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

Specified by:

addProgress in interface PepperMapper

Parameters:

progress - the progress must be a value between 0 for 0% and 1 for 100%

setProgress

public 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. OVERRIDE THIS METHOD FOR CUSTOMIZED MAPPING.

Specified by:

setProgress in interface PepperMapper

Parameters:

progress - the progress must be a value between 0 for 0% and 1 for 100%

readXMLResource

protected void readXMLResource(DefaultHandler2 contentHandler,
                               org.eclipse.emf.common.util.URI documentLocation)

Helper method to read an xml file with a DefaultHandler2 implementation given as contentHandler. It is assumed, that the file encoding is set to UTF-8.

Parameters:

contentHandler - DefaultHandler2 implementation

documentLocation - location of the xml-file

setPepperMapperController

public void setPepperMapperController(PepperMapperController controller)

Sets the controller of this mapper, to grant n access to Pepper via the controller.

Specified by:

setPepperMapperController in interface PepperMapper

Parameters:

controller - controller for this object

getPepperMapperController

public PepperMapperController getPepperMapperController()

Returns the controller of this mapper, to grant n access to Pepper via the controller.

Specified by:

getPepperMapperController in interface PepperMapper

Returns:

controller for this object