org.corpus_tools.pepper.impl

Class PepperMapperControllerImpl

java.lang.Object

java.lang.Thread

org.corpus_tools.pepper.impl.PepperMapperControllerImpl

All Implemented Interfaces:

Runnable, PepperMapperController

public class PepperMapperControllerImpl
extends Thread
implements PepperMapperController

The class PepperMapperControllerImpl is a communicator class between a PepperModule and a PepperMapper object. The aim of this class is to provide some fields, which can be set by the PepperMapper and be read by the PepperModule object. The PepperModule object should not contain any static or object references to the PepperMapper object. This mechanism is used, to make sure that in case of a forgotten clean up, the PepperMapper object can be removed by the java garbage collector and does not overfill the main memory.

Author:

Florian Zipser

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
org.slf4j.Logger	logger
protected PepperModule	pepperModule PepperModule containing this object
protected Double	progress when getPepperMapper() is set to null, in map(), the progress value has to be stored here.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
PepperMapperControllerImpl(ThreadGroup threadGroup, String threadName) Initializes this object and sets its ThreadGroup and the name of the thread.

Method Summary

Modifier and Type	Method and Description
org.corpus_tools.salt.graph.Identifier	getIdentifier() Returns Identifier object of the SCorpus or SDocument object, which is contained by containing PepperMapper.
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
PepperMapper	getPepperMapper() Returns the PepperMapper, controlled by this object.
PepperModule	getPepperModule() Returns PepperModule object containing this object
boolean	getPermissionForProcessDoument(DocumentController 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.
void	map() This method starts the PepperMapper object.
void	run() This method starts the PepperMapper object in a thread.
void	setIdentifier(org.corpus_tools.salt.graph.Identifier sElementId) Set Identifier object of the SCorpus or SDocument object, which is contained by containing PepperMapper.
void	setPepperMapper(PepperMapper pepperMapper) Sets the mapper, controlled by this object.
void	setPepperModule(PepperModule pepperModule) Sets the PepperModule object, which contains the PepperMapperController as a callback reference.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.corpus_tools.pepper.modules.PepperMapperController

join, setUncaughtExceptionHandler, start

Field Detail

logger

public org.slf4j.Logger logger

progress

protected volatile Double progress

when getPepperMapper() is set to null, in map(), the progress value has to be stored here.

pepperModule

protected PepperModule pepperModule

PepperModule containing this object

Constructor Detail

PepperMapperControllerImpl

public PepperMapperControllerImpl(ThreadGroup threadGroup,
                                  String threadName)

Initializes this object and sets its ThreadGroup and the name of the thread.

Parameters:

threadGroup -

threadName -

Method Detail

setPepperMapper

public void setPepperMapper(PepperMapper pepperMapper)

Sets the mapper, controlled by this object.

Specified by:

setPepperMapper in interface PepperMapperController

Parameters:

pepperMapper -

getPepperMapper

public PepperMapper getPepperMapper()

Returns the PepperMapper, controlled by this object.

Specified by:

getPepperMapper in interface PepperMapperController

Returns:

getMappingSubjects

public List<MappingSubject> getMappingSubjects()

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

Specified by:

getMappingSubjects in interface PepperMapperController

Returns:

a list of MappingSubject

getMappingResult

public DOCUMENT_STATUS getMappingResult()

Returns the result of the mapping, when finished.

Specified by:

getMappingResult in interface PepperMapperController

Returns:

mapping result

getIdentifier

public org.corpus_tools.salt.graph.Identifier getIdentifier()

Returns Identifier object of the SCorpus or SDocument object, which is contained by containing PepperMapper.

Specified by:

getIdentifier in interface PepperMapperController

Returns:

setIdentifier

public void setIdentifier(org.corpus_tools.salt.graph.Identifier sElementId)

Set Identifier object of the SCorpus or SDocument object, which is contained by containing PepperMapper.

Specified by:

setIdentifier in interface PepperMapperController

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 #setProgress(Double).
The call is just delegated to PepperMapper.getProgress()

Specified by:

getProgress in interface PepperMapperController

run

public void run()

This method starts the PepperMapper object in a thread. If #getCorpus() is not null, #mapSCorpus() is called, if #getDocument() is not null, #mapSDocument() is called.
If an exception occurs in this method, it will be caught by PepperModuleImpl.uncaughtException(Thread, Throwable).

Specified by:

run in interface Runnable

Overrides:

run in class Thread

map

public void map()

This method starts the PepperMapper object. If #getCorpus() is not null, #mapSCorpus() is called, if #getDocument() is not null, #mapSDocument() is called.

Specified by:

map in interface PepperMapperController

setPepperModule

public void setPepperModule(PepperModule pepperModule)

Sets the PepperModule object, which contains the PepperMapperController as a callback reference. This is necessary, that the PepperMapperController can notify the containing object that its job is done via calling PepperModule.done(PepperMapperController)

Specified by:

setPepperModule in interface PepperMapperController

Parameters:

pepperModule - containing PepperModule object

getPepperModule

public PepperModule getPepperModule()

Returns PepperModule object containing this object

Returns:

getPermissionForProcessDoument

public boolean getPermissionForProcessDoument(DocumentController controller)

Specified by:

getPermissionForProcessDoument in interface PepperMapperController