TODO make docu. More...

Inherits org.corpus_tools.pepper.modules.PepperModule, and UncaughtExceptionHandler.

Inherited by org.corpus_tools.pepper.impl.PepperExporterImpl, org.corpus_tools.pepper.impl.PepperImporterImpl, and org.corpus_tools.pepper.impl.PepperManipulatorImpl.

Public Member Functions

PepperModuleDesc getFingerprint ()

Returns a PepperModuleDesc object, which is a kind of a fingerprint of this PepperModule.This fingerprint for instance contains information like the name, the version of this module or information about the supplier.

Returns: fingerprint to this module

String getName ()

Returns the name of this module.In most cases, the name somehow describes the task of the module.

Returns: the value of the 'Name' attribute.

String getVersion ()

Returns the version of this module.

Returns: the value of the 'Version' attribute.

void setVersion (String newVersion)

Sets the version of this module.The version normally is set internally, this method only exists for dependency injection, by the modules project itself. But this method is never called by the pepper framework.

Parameters

value the new value of the 'Version' attribute.

MODULE_TYPE getModuleType ()

Returns the type of this module.

Returns: type of module

More...

String getDesc ()

Returns a short description of this module.Please support some information, for the user, of what task this module does.

Returns: a short description of the task of this module

void setDesc (String desc)

Sets a short description of this module.Please support some information, for the user, of what task this module does.

Parameters

desc	a short description of the task of this module

URI getSupplierContact ()

Returns a uri where to find more information about this module and where to find some contact information to contact the supplier.

Returns: contact address like eMail address or homepage address

void setSupplierContact (URI supplierContact)

Sets a uri where to find more information about this module and where to find some contact information to contact the supplier.

Parameters

uri	contact address like eMail address or homepage address

URI getSupplierHomepage ()

Sets the URI to the homepage describing the functionality of the module. More...

void setSupplierHomepage (URI hp)

Returns the URI to the homepage describing the functionality of the module. More...

PepperModuleProperties getProperties ()

Returns a PepperModuleProperties object containing properties to customize the behavior of this PepperModule.

Returns

void setProperties (PepperModuleProperties properties)

Sets thePepperModuleProperties object containing properties to customize the behavior of this PepperModule.Please make sure, that this method is called in constructor of your module. If not, a general PepperModuleProperties object is created by the pepper framework and will be initialized. This means, when calling this method later, all properties for customizing the module will be overridden.

Parameters

properties

SaltProject getSaltProject ()

Returns the SaltProject object, which is filled, manipulated or exported by the current module.

Returns: the value of the 'Salt Project' attribute.

synchronized void setSaltProject (SaltProject newSaltProject)

Sets the SaltProject object, which is filled, manipulated or exported by the current module.Note: This method only should be called by the pepper framework.

Parameters

value the new value of the 'Salt Project' attribute.

URI getResources ()

Returns the path of the folder which might contain resources for a Pepper module.This is the folder, which is delivered as part of the modules zip. Usually a Pepper module is a zip file containing a jar file and a folder having the same name as the jar file. In default configuration all files of folder "./src/main/resources" are copied to the resource folder.

Returns: path to resources

void setResources (URI newResources)

Sets the resource folder used by getResources().This method should only be invoked by the Pepper framework. The documentation of getResources() for more details.

Parameters

value path to resource folder

URI getTemproraries ()

TODO make docu.

void setTemproraries (URI newTemproraries)

TODO make docu.

String getSymbolicName ()

Returns the symbolic name of this OSGi bundle.

Returns: the value of the 'Symbolic Name' attribute.

void setSymbolicName (String newSymbolicName)

Sets the symbolic name of this OSGi bundle.This value is set automatically inside the activate method, which is implemented in PepperModuleImpl class. If you want to manipulate that method. make sure to set the symbolic name and make sure, that it is set to the bundles symbolic name.

Parameters

value the new value of the 'Symbolic Name' attribute.

ComponentContext getComponentContext ()

Returns the ComponentContext of the OSGi environment the bundle was started in. More...

Collection< String > getStartProblems ()

If isReadyToStart() has returned false, this method returns a list of reasons why this module is not ready to start.

Returns: a list describing the reasons, or an empty list if there were no problems

boolean isReadyToStart () throws PepperModuleNotReadyException

This method is called by the pepper framework after initializing this object and directly before start processing.Initializing means setting properties PepperModuleProperties, setting temporary files, resources etc. . returns false or throws an exception in case of PepperModule instance is not ready for any reason
This method is also called, when Pepper is in self-test mode, to check if module is correctly instantiated.
The default implementation checks:

if a path to resource folder is given
if the MODULE_TYPE is not null
if the name is not null

When overriding this method, please call super.isReadyToStart() first and in case a problem occured add it to the list getStartProblems().

Returns: false, PepperModule instance is not ready for any reason, true, else.

ModuleController getModuleController ()

Returns the container and controller object for the current module.The ModuleController object is a kind of communicator between a PepperModule and the pepper framework.

Returns: the value of the 'Pepper Module Controller' container reference.

void setPepperModuleController (ModuleController newModuleController)

Sets the container and controller object for the current module.The ModuleController object is a kind of communicator between a PepperModule and the pepper framework. Also calls the inverse method ModuleController#setPepperModule_basic(PepperModule) . Note, this method only should be called by pepper framework.

Parameters

value the new value of the 'Pepper Module Controller' container reference.

void setPepperModuleController_basic (ModuleController newModuleController)

Sets the container and controller object for the current module.The ModuleController object is a kind of communicator between a PepperModule and the pepper framework. Note, this method only should be called by pepper framework.

Parameters

value the new value of the 'Pepper Module Controller' container reference.

SCorpusGraph getCorpusGraph ()

Returns the SCorpusGraph object which is filled, manipulated or exported by the current module.The SCorpusGraph object is contained in the salt project getSaltProject().

Returns: the value of the 'SCorpus Graph' attribute.

void setCorpusGraph (SCorpusGraph newSCorpusGraph)

Sets the SCorpusGraph object which is filled, manipulated or exported by the current module.The SCorpusGraph object is contained in the salt project getSaltProject(). Note: This method only should be called by the pepper framework.

Parameters

value the new value of the 'SCorpus Graph' attribute.

void setIsMultithreaded (boolean isMultithreaded)

Sets whether this PepperModule is able to run multithreaded.This method only should be called by the module itself.

Parameters

isThreaded true, if module can run in multithread mode.

boolean isMultithreaded ()

Returns whether this PepperModule is able to run multithreaded.The behavior only should be set by the module itself via calling setIsMultithreaded(boolean).

Returns: true, if module can run in multithread mode.

void start () throws PepperModuleException

Starts the conversion process.This method is the main method of a pepper module. If this method is not overridden, it will call start(Identifier) for each SDocument and SCorpus object being contained in the set SCorpusGraph. This is done in a multithreaded way by default. Note: When your module should not run in multithreaded mode, call setIsMultithreaded(boolean) .

void done (Identifier id, DOCUMENT_STATUS result)

This method is called by a PepperMapperController object to notify the PepperModule object, that the mapping for this object is done.

Parameters

identifier
result

void done (PepperMapperController controller)

This method is called by a PepperMapperController object to notify the PepperModule object, that the mapping is done.

Parameters

controller The object which is done with its job

void start (Identifier sElementId) throws PepperModuleException

This method is called by method start(), if the method was not overridden by the current class. More...

PepperMapper createPepperMapper (Identifier sElementId)

OVERRIDE THIS METHOD FOR CUSTOMIZED MAPPING.This method creates a customized PepperMapper object and returns it. You can here do some additional initialisations. Thinks like setting the Identifier of the SDocument or SCorpus object and the URI resource is done by the framework (or more in detail in method start()). The parameter sElementId, if a PepperMapper object should be created in case of the object to map is either an SDocument object or an SCorpus object of the mapper should be initialized differently.
Note: Override this method.

Parameters

sElementId Identifier of the SCorpus or SDocument to be processed.

Returns: PepperMapper object to do the mapping task for object connected to given Identifier

void end () throws PepperModuleException

Calls method start(Identifier) for every root SCorpus of SaltProject object.

void uncaughtException (Thread t, Throwable e)

Method catches Uncaught exceptions thrown by PepperMapperImpl while running as Thread. More...

Double getProgress (String globalId)

This method is invoked by the Pepper framework, to get the current progress concerning the SDocument object corresponding to the given Identifier in percent.A valid value return must be between 0 and 1.
Note: In case, you have overridden the method start(Identifier) or start(), please also override this method, because it accesses an internal list of all mappers, which initialized in start(Identifier).

Parameters

globalID identifier of the requested SDocument object, note, that this is not the Identifier.

Double getProgress ()

{@inheritDoc PepperModule::getProgress()}

List< Identifier > proposeImportOrder (SCorpusGraph sCorpusGraph)

This method could be overridden, to make a proposal for the import order of SDocument objects.Overriding this method is useful, in case of the order matters in the specific mapping of this PepperModule . In this case a influencing the import order can decrease the processing time. If you do not want to influence the order, just return an empty list, or don't override this method.
In case you want to override this method, you can return a value for each passed SCorpusGraph.
OVERRIDE THIS METHOD FOR CUSTOMIZED MAPPING.

Parameters

sCorpusGraph the SCorpusGraph object for which the order could be proposed

Returns: a list determining the import order of SDocument objects

String toString ()

Returns a string representation of this object. More...

SelfTestDesc getSelfTestDesc ()

This method is called by the Pepper framework to run an integration test for module. More...

Protected Member Functions
	PepperModuleImpl ()
	Creates a PepperModule object, which is either a MODULE_TYPE#IMPORTER, a MODULE_TYPE#MANIPULATOR or a MODULE_TYPE#EXPORTER. More...

	PepperModuleImpl (String name)
	Creates a PepperModule object, which is either a MODULE_TYPE#IMPORTER, a MODULE_TYPE#MANIPULATOR or a MODULE_TYPE#EXPORTER. More...

void	setName (String name)
	Sets the name of this PepperModule. More...

void	activate (ComponentContext componentContext)
	This method is called by OSGi framework and sets the component context, this class is running in. More...

Map< String, PepperMapperController >	getMapperControllers ()
	Returns a threadsafe map of all PepperMapperController objects which are connected with a started PepperMapper corresponding to their. More...

ThreadGroup	getMapperThreadGroup ()
	Returns a ThreadGroup where PepperMapper objects and the corresponding threads are supposed to run in. More...

void	setMapperThreadGroup (ThreadGroup mapperThreadGroup)
	Sets a ThreadGroup where PepperMapper objects and the corresponding threads are supposed to run in. More...

Map< String, DocumentController >	getDocumentId2DC ()
	Returns the map relating Identifier belonging to SDocument objects to their DocumentController container. More...

Protected Attributes
Logger	logger = LoggerFactory.getLogger("Pepper")

SaltProject	saltProject = null
	Salt project which is processed by module.

URI	resources = null
	TODO make docu.

URI	temproraries = null
	TODO make docu.

String	symbolicName = null
	TODO make docu.

ModuleController	moduleController = null
	the controller object, which acts as bridge between Pepper framework and Pepper module.

SCorpusGraph	sCorpusGraph = null
	The SCorpusGraph object which should be processed by this module.

boolean	isMultithreaded = true

Additional Inherited Members
Static Public Attributes inherited from org.corpus_tools.pepper.modules.PepperModule
static final String	ENDING_FOLDER = "FOLDER"
	A string specifying a value for a folder as ending. More...

static final String	ENDING_LEAF_FOLDER = "LEAF_FOLDER"
	A string specifying a value for a leaf folder as ending. More...

static final String	ENDING_XML = "xml"
	Ending for an xml file. More...

static final String	ENDING_TXT = "txt"
	Ending for an txt file. More...

static final String	ENDING_TAB = "tab"
	Ending for an tab file. More...

static final String	ENDING_ALL_FILES = "ALL_FILES"
	All kinds of file endings.

Detailed Description

TODO make docu.

Author: Florian Zipser

Constructor & Destructor Documentation

◆ PepperModuleImpl() [1/2]

org.corpus_tools.pepper.impl.PepperModuleImpl.PepperModuleImpl ( )

protected

Creates a PepperModule object, which is either a MODULE_TYPE#IMPORTER, a MODULE_TYPE#MANIPULATOR or a MODULE_TYPE#EXPORTER.

The name of this module is set to "MyModule".
We recommend to use the constructor PepperModuleImpl#PepperModuleImpl(String) and pass a proper name.

◆ PepperModuleImpl() [2/2]

org.corpus_tools.pepper.impl.PepperModuleImpl.PepperModuleImpl ( String name )

protected

Creates a PepperModule object, which is either a MODULE_TYPE#IMPORTER, a MODULE_TYPE#MANIPULATOR or a MODULE_TYPE#EXPORTER.

The passed name is set as the modules name.

Member Function Documentation

◆ activate()

void org.corpus_tools.pepper.impl.PepperModuleImpl.activate ( ComponentContext componentContext )

protected

This method is called by OSGi framework and sets the component context, this class is running in.

This method scans the given ComponentContext object for symbolic name and version and initializes its values symbolicName and version with it. When running this class in OSGi context, you do not have to set both values by hand. With the given architecture, the symbolic name and the bundle version will be given by pom.xml, via MANIFEST.MF and finally read by this method. Also sets the internal field storing the ComponentContext which can be retrieved via getComponentContext().

Parameters

componentContext

Reimplemented in org.corpus_tools.pepper.modules.coreModules.DoNothingManipulator, and org.corpus_tools.pepper.modules.coreModules.DoNothingExporter.

◆ getComponentContext()

ComponentContext org.corpus_tools.pepper.impl.PepperModuleImpl.getComponentContext ( )

Returns the ComponentContext of the OSGi environment the bundle was started in.

Returns

Implements org.corpus_tools.pepper.modules.PepperModule.

◆ getDocumentId2DC()

Map<String, DocumentController> org.corpus_tools.pepper.impl.PepperModuleImpl.getDocumentId2DC ( )

protected

Returns the map relating Identifier belonging to SDocument objects to their DocumentController container.

Returns: map

◆ getMapperControllers()

Map<String, PepperMapperController> org.corpus_tools.pepper.impl.PepperModuleImpl.getMapperControllers ( )

protected

Returns a threadsafe map of all PepperMapperController objects which are connected with a started PepperMapper corresponding to their.

Returns

◆ getMapperThreadGroup()

ThreadGroup org.corpus_tools.pepper.impl.PepperModuleImpl.getMapperThreadGroup ( )

protected

Returns a ThreadGroup where PepperMapper objects and the corresponding threads are supposed to run in.

Returns

◆ getModuleType()

MODULE_TYPE org.corpus_tools.pepper.impl.PepperModuleImpl.getModuleType ( )

Returns the type of this module.

Returns: type of module

Returns

Implements org.corpus_tools.pepper.modules.PepperModule.

◆ getSelfTestDesc()

SelfTestDesc org.corpus_tools.pepper.impl.PepperModuleImpl.getSelfTestDesc ( )

This method is called by the Pepper framework to run an integration test for module.

When the method returns null, it means that no integration test is supported. Otherwise, the SelfTestDesc object needs to provide an input corpus path and an output corpus path.

When this module is:

an importer: SelfTestDesc#getInputCorpusPath() should contain the format to be imported. SelfTestDesc#getExpectedCorpusPath() should contain the expected salt project (for control).
a manipulator: SelfTestDesc#getInputCorpusPath() should contain a salt project which is the module's input. SelfTestDesc#getExpectedCorpusPath() should contain the expected salt project (for control).
an exporter: SelfTestDesc#getInputCorpusPath() should contain a salt project which is the module's input. SelfTestDesc#getExpectedCorpusPath() should contain the expected corpus in output format.

The simplest way to create a test description is:

return new IntegrationTestDesc(inputPath, outputPath);

When this module is an importer or a manipulator the method SelfTestDesc#compare(SaltProject, SaltProject) is called to compare output salt project with expected salt project. When the module is an exporter the method SelfTestDesc#compare(URI, URI) is called to compare the created output folder with an expected one. By default this method checks whether the file structure and each file is equal.

Returns: test description

Implements org.corpus_tools.pepper.modules.PepperModule.

◆ getSupplierHomepage()

URI org.corpus_tools.pepper.impl.PepperModuleImpl.getSupplierHomepage ( )

Sets the URI to the homepage describing the functionality of the module.

Returns: URI to the homepage

Implements org.corpus_tools.pepper.modules.PepperModule.

◆ setMapperThreadGroup()

void org.corpus_tools.pepper.impl.PepperModuleImpl.setMapperThreadGroup ( ThreadGroup mapperThreadGroup )

protected

Sets a ThreadGroup where PepperMapper objects and the corresponding threads are supposed to run in.

Parameters

mapperThreadGroup

◆ setName()

void org.corpus_tools.pepper.impl.PepperModuleImpl.setName ( String name )

protected

Sets the name of this PepperModule.

Note, that a name can only be set once and not be changed again.

Parameters

name	name of this module.

◆ setSupplierHomepage()

void org.corpus_tools.pepper.impl.PepperModuleImpl.setSupplierHomepage ( URI hp )

Returns the URI to the homepage describing the functionality of the module.

Parameters

hp	URI to the homepage

Implements org.corpus_tools.pepper.modules.PepperModule.

◆ start()

void org.corpus_tools.pepper.impl.PepperModuleImpl.start ( Identifier sElementId ) throws PepperModuleException

This method is called by method start(), if the method was not overridden by the current class.

If this is not the case, this method will be called for every document which has to be processed.

Parameters

sElementId the id value for the current document or corpus to process

Implements org.corpus_tools.pepper.modules.PepperModule.

◆ toString()

String org.corpus_tools.pepper.impl.PepperModuleImpl.toString ( )

Returns a string representation of this object.

Note: This representation cannot be used for serialization/ deserialization purposes.

◆ uncaughtException()

void org.corpus_tools.pepper.impl.PepperModuleImpl.uncaughtException	(	Thread	t,
		Throwable	e
	)

Method catches Uncaught exceptions thrown by PepperMapperImpl while running as Thread.

This method just logs the exception. It is assumed, that the PepperMapperImpl itself notifies the Pepper framework about the unsuccessful process.

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PepperModuleImpl() [1/2]

◆ PepperModuleImpl() [2/2]

Member Function Documentation

◆ activate()

◆ getComponentContext()

◆ getDocumentId2DC()

◆ getMapperControllers()

◆ getMapperThreadGroup()

◆ getModuleType()

◆ getSelfTestDesc()

◆ getSupplierHomepage()

◆ setMapperThreadGroup()

◆ setName()

◆ setSupplierHomepage()

◆ start()

◆ toString()

◆ uncaughtException()