This interface can be used in a threaded environment, where the PepperModule is used for delegating thread jobs, and a set of PepperMappers are mapping one SDocument or SCorpus object. More...

Inherited by org.corpus_tools.pepper.impl.PepperMapperImpl.

Public Member Functions
void	setPepperMapperController (PepperMapperController controller)
	Sets the controller of this mapper, to grant n access to Pepper via the controller. More...

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

void	setResourceURI (URI resourceURI)
	Sets URI of resource. More...

URI	getResourceURI ()
	Returns URI of resource. More...

SDocument	getDocument ()
	Returns the SDocument object to be mapped by this mapper. More...

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

void	setDocument (SDocument sDocument)
	Sets the SDocument object to be mapped by this mapper. More...

SCorpus	getCorpus ()
	Returns the SCorpus object to be mapped by this mapper. More...

void	setCorpus (SCorpus sCorpus)
	Sets the SCorpus object to be mapped by this mapper. More...

PepperModuleProperties	getProperties ()
	Returns the PepperModuleProperties object containing user customizations to be observed during the mapping. More...

void	setProperties (PepperModuleProperties props)
	Sets the PepperModuleProperties object containing user customizations to be observed during the mapping. More...

void	setMappingResult (DOCUMENT_STATUS mappingResult)
	Sets the result of the current mapping, when it is finished. More...

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

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

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

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

void	addProgress (Double progress)
	Adds the given progress to the already existing progress of the current handled SDocument or SCorpus object. More...

void	setProgress (Double progress)
	Sets the progress of the current handled SDocument or SCorpus object. More...

Detailed Description

This interface can be used in a threaded environment, where the PepperModule is used for delegating thread jobs, and a set of PepperMappers are mapping one SDocument or SCorpus object.

Author: Florian Zipser

Member Function Documentation

◆ addProgress()

void org.corpus_tools.pepper.modules.PepperMapper.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%

Implemented in org.corpus_tools.pepper.impl.PepperMapperImpl.

◆ getCorpus()

SCorpus org.corpus_tools.pepper.modules.PepperMapper.getCorpus ( )

Returns the SCorpus object to be mapped by this mapper.

Returns: SCorpus object to be mapped

Implemented in org.corpus_tools.pepper.impl.PepperMapperImpl.

◆ getDocument()

SDocument org.corpus_tools.pepper.modules.PepperMapper.getDocument ( )

Returns the SDocument object to be mapped by this mapper.

Returns: SDocument object to be mapped

Implemented in org.corpus_tools.pepper.impl.PepperMapperImpl.

◆ getMappingResult()

DOCUMENT_STATUS org.corpus_tools.pepper.modules.PepperMapper.getMappingResult ( )

Returns the result of the mapping, when finished.

Returns: mapping result

Implemented in org.corpus_tools.pepper.impl.PepperMapperImpl.

◆ getMappingSubjects()

List<MappingSubject> org.corpus_tools.pepper.modules.PepperMapper.getMappingSubjects ( )

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

Returns: a list of MappingSubject

Implemented in org.corpus_tools.pepper.impl.PepperMapperImpl.

◆ getPepperMapperController()

PepperMapperController org.corpus_tools.pepper.modules.PepperMapper.getPepperMapperController ( )

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

Returns: controller for this object

Implemented in org.corpus_tools.pepper.impl.PepperMapperImpl.

◆ getProgress()

Double org.corpus_tools.pepper.modules.PepperMapper.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.

Implemented in org.corpus_tools.pepper.impl.PepperMapperImpl.

◆ getProperties()

PepperModuleProperties org.corpus_tools.pepper.modules.PepperMapper.getProperties ( )

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

Returns: PepperModuleProperties object to be used

Implemented in org.corpus_tools.pepper.impl.PepperMapperImpl.

◆ getResourceURI()

URI org.corpus_tools.pepper.modules.PepperMapper.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

Implemented in org.corpus_tools.pepper.impl.PepperMapperImpl.

◆ setCorpus()

void org.corpus_tools.pepper.modules.PepperMapper.setCorpus ( SCorpus sCorpus )

Sets the SCorpus object to be mapped by this mapper.

Parameters

sCorpus SCorpus object to be mapped

Implemented in org.corpus_tools.pepper.impl.PepperMapperImpl.

◆ setDocument()

void org.corpus_tools.pepper.modules.PepperMapper.setDocument ( SDocument sDocument )

Sets the SDocument object to be mapped by this mapper.

Parameters

sDocument SDocument object to be mapped

Implemented in org.corpus_tools.pepper.impl.PepperMapperImpl.

◆ setMappingResult()

void org.corpus_tools.pepper.modules.PepperMapper.setMappingResult ( DOCUMENT_STATUS mappingResult )

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

Parameters

status of mapping

Implemented in org.corpus_tools.pepper.impl.PepperMapperImpl.

◆ setPepperMapperController()

void org.corpus_tools.pepper.modules.PepperMapper.setPepperMapperController ( PepperMapperController controller )

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

Parameters

controller controller for this object

Implemented in org.corpus_tools.pepper.impl.PepperMapperImpl.

◆ setProgress()

void org.corpus_tools.pepper.modules.PepperMapper.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%

Implemented in org.corpus_tools.pepper.impl.PepperMapperImpl.

◆ setProperties()

void org.corpus_tools.pepper.modules.PepperMapper.setProperties ( PepperModuleProperties props )

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

Parameters

props PepperModuleProperties object to be used

Implemented in org.corpus_tools.pepper.impl.PepperMapperImpl.

◆ setResourceURI()

void org.corpus_tools.pepper.modules.PepperMapper.setResourceURI ( 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

Implemented in org.corpus_tools.pepper.impl.PepperMapperImpl.

Public Member Functions

Detailed Description

Member Function Documentation

◆ addProgress()

◆ getCorpus()

◆ getDocument()

◆ getMappingResult()

◆ getMappingSubjects()

◆ getPepperMapperController()

◆ getProgress()

◆ getProperties()

◆ getResourceURI()

◆ setCorpus()

◆ setDocument()

◆ setMappingResult()

◆ setPepperMapperController()

◆ setProgress()

◆ setProperties()

◆ setResourceURI()