org.corpus_tools.pepper.impl.PepperMapperImpl Class Reference

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

Inherits org.corpus_tools.pepper.modules.PepperMapper.

Inherited by org.corpus_tools.pepper.modules.coreModules.SaltValidator.ValidatorMapper, and org.corpus_tools.pepper.modules.coreModules.TextImporter.TextMapper.

Public Member Functions
List< MappingSubject >	getMappingSubjects ()
	Returns a list of all subjects (SDocument or SCorpus) to be merged. More...
URI	getResourceURI ()
	{@inheritDoc PepperMapper::getResourceURI()}
void	setResourceURI (URI resourceURI)
	{@inheritDoc PepperMapper::setResourceURI(URI)}
SDocument	getDocument ()
	{@inheritDoc PepperMapper::getDocument()}
void	setDocument (SDocument sDocument)
	{@inheritDoc PepperMapper::setDocument(SDocument)}
SCorpus	getCorpus ()
	{@inheritDoc PepperMapper::getCorpus()}
void	setCorpus (SCorpus sCorpus)
	{@inheritDoc PepperMapper::setCorpus(SCorpus)}
PepperModuleProperties	getProperties ()
	{@inheritDoc PepperMapper::getProperties()}
void	setProperties (PepperModuleProperties props)
	{@inheritDoc PepperMapper::setProperties(PepperModuleProperties)}
synchronized void	setMappingResult (DOCUMENT_STATUS mappingResult)
	{@inheritDoc PepperMapperConnector::setMappingResult(DOCUMENT_STATUS)}
DOCUMENT_STATUS	getMappingResult ()
	{@inheritDoc PepperMapperConnector::getMappingResult()}
DOCUMENT_STATUS	mapSDocument ()
	{@inheritDoc PepperMapper::mapSDocument()} More...
DOCUMENT_STATUS	mapSCorpus ()
	{@inheritDoc PepperMapper::mapSCorpus()} More...
Double	getProgress ()
	{@inheritDoc PepperMapper::getProgress()}
void	addProgress (Double progress)
	{@inheritDoc PepperMapper::addProgress(Double)}
void	setProgress (Double progress)
	{@inheritDoc PepperMapper::setProgress(Double)} OVERRIDE THIS METHOD FOR CUSTOMIZED MAPPING.
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
PepperMapperController	getPepperMapperController ()
	Returns the controller of this mapper, to grant n access to Pepper via the controller. Returns controller for this object

Protected Member Functions
void	initialize ()
	This method initializes this object and is called by the constructor. More...
void	readXMLResource (DefaultHandler2 contentHandler, URI documentLocation)
	Helper method to read an xml file with a DefaultHandler2 implementation given as contentHandler. More...

Protected Attributes
PepperModuleProperties	props = null
	PepperModuleProperties object containing user customizations to be observed during the mapping.
volatile Double	progress = 0d
	Stores the current progress (between 0 and 1)
PepperMapperController	controller = null

Detailed Description

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

Author

Florian Zipser

Member Function Documentation

getMappingSubjects()

List<MappingSubject> org.corpus_tools.pepper.impl.PepperMapperImpl.getMappingSubjects

(

)

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

Returns

a list of MappingSubject

Implements org.corpus_tools.pepper.modules.PepperMapper.

initialize()

void org.corpus_tools.pepper.impl.PepperMapperImpl.initialize ( )

protected

This method initializes this object and is called by the constructor.

OVERRIDE THIS METHOD FOR CUSTOMIZED MAPPING.

mapSCorpus()

DOCUMENT_STATUS org.corpus_tools.pepper.impl.PepperMapperImpl.mapSCorpus

(

)

{@inheritDoc PepperMapper::mapSCorpus()}

OVERRIDE THIS METHOD FOR CUSTOMIZED MAPPING.

<emph>NOTE: This method is only called if the element to be mapped is of type SCorpus, i.e., if this.getCorpus() != null!</emph>

Implements org.corpus_tools.pepper.modules.PepperMapper.

mapSDocument()

DOCUMENT_STATUS org.corpus_tools.pepper.impl.PepperMapperImpl.mapSDocument

(

)

{@inheritDoc PepperMapper::mapSDocument()}

OVERRIDE THIS METHOD FOR CUSTOMIZED MAPPING.

<emph>NOTE: This method is only called if the element to be mapped is of type SDocument, i.e., if this.getDocument() != null!</emph>

Implements org.corpus_tools.pepper.modules.PepperMapper.

readXMLResource()

void org.corpus_tools.pepper.impl.PepperMapperImpl.readXMLResource ( DefaultHandler2  contentHandler, URI  documentLocation  )

protected

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