org.corpus_tools.pepper.modules.coreModules

Class DoNothingManipulator

java.lang.Object

org.corpus_tools.pepper.impl.PepperModuleImpl

org.corpus_tools.pepper.impl.PepperManipulatorImpl

org.corpus_tools.pepper.modules.coreModules.DoNothingManipulator

All Implemented Interfaces:

Thread.UncaughtExceptionHandler, PepperManipulator, PepperModule

public class DoNothingManipulator
extends PepperManipulatorImpl
implements PepperManipulator

A dummy manipulator, which waves through all documents and corpora.

Author:

florian

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORMAT_NAME
static String	FORMAT_VERSION
static String	MODULE_NAME

Fields inherited from class org.corpus_tools.pepper.impl.PepperModuleImpl

isMultithreaded, logger, moduleController, resources, saltProject, sCorpusGraph, symbolicName, temproraries

Fields inherited from interface org.corpus_tools.pepper.modules.PepperModule

ENDING_ALL_FILES, ENDING_FOLDER, ENDING_LEAF_FOLDER, ENDING_TAB, ENDING_TXT, ENDING_XML

Constructor Summary

Constructors

Constructor and Description
DoNothingManipulator()

Method Summary

Modifier and Type	Method and Description
void	activate(org.osgi.service.component.ComponentContext componentContext) This method is called by OSGi framework and sets the component context, this class is running in.
PepperMapper	createPepperMapper(org.corpus_tools.salt.graph.Identifier identifier) Creates a dummy mapper, which only returns DOCUMENT_STATUS.COMPLETED.
SelfTestDesc	getSelfTestDesc() This method is called by the Pepper framework to run an integration test for module.

Methods inherited from class org.corpus_tools.pepper.impl.PepperModuleImpl

done, done, end, getComponentContext, getCorpusGraph, getDesc, getDocumentId2DC, getFingerprint, getMapperControllers, getMapperThreadGroup, getModuleController, getModuleType, getName, getProgress, getProgress, getProperties, getResources, getSaltProject, getStartProblems, getSupplierContact, getSupplierHomepage, getSymbolicName, getTemproraries, getVersion, isMultithreaded, isReadyToStart, proposeImportOrder, setCorpusGraph, setDesc, setIsMultithreaded, setMapperThreadGroup, setName, setPepperModuleController_basic, setPepperModuleController, setProperties, setResources, setSaltProject, setSupplierContact, setSupplierHomepage, setSymbolicName, setTemproraries, setVersion, start, start, toString, uncaughtException

Methods inherited from class java.lang.Object

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

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

done, done, end, getComponentContext, getCorpusGraph, getDesc, getFingerprint, getModuleController, getModuleType, getName, getProgress, getProgress, getProperties, getResources, getSaltProject, getStartProblems, getSupplierContact, getSupplierHomepage, getSymbolicName, getTemproraries, getVersion, isMultithreaded, isReadyToStart, proposeImportOrder, setCorpusGraph, setDesc, setIsMultithreaded, setPepperModuleController_basic, setPepperModuleController, setProperties, setResources, setSaltProject, setSupplierContact, setSupplierHomepage, setSymbolicName, setTemproraries, setVersion, start, start

Field Detail

MODULE_NAME

public static final String MODULE_NAME

See Also:

Constant Field Values

FORMAT_NAME

public static final String FORMAT_NAME

See Also:

Constant Field Values

FORMAT_VERSION

public static final String FORMAT_VERSION

See Also:

Constant Field Values

Constructor Detail

DoNothingManipulator

public DoNothingManipulator()

Method Detail

activate

public void activate(org.osgi.service.component.ComponentContext componentContext)

Description copied from class: PepperModuleImpl

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 PepperModuleImpl.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 PepperModuleImpl.getComponentContext().

Overrides:

activate in class PepperModuleImpl

getSelfTestDesc

public SelfTestDesc getSelfTestDesc()

Description copied from interface: PepperModule

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.

Specified by:

getSelfTestDesc in interface PepperModule

Overrides:

getSelfTestDesc in class PepperModuleImpl

Returns:

test description

createPepperMapper

public PepperMapper createPepperMapper(org.corpus_tools.salt.graph.Identifier identifier)

Creates a dummy mapper, which only returns DOCUMENT_STATUS.COMPLETED. 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 PepperModule.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.

Specified by:

createPepperMapper in interface PepperModule

Overrides:

createPepperMapper in class PepperModuleImpl

Parameters:

identifier - Identifier of the SCorpus or SDocument to be processed.

Returns:

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