org.corpus_tools.pepper.modules.coreModules

Class TextExporter

java.lang.Object

org.corpus_tools.pepper.impl.PepperModuleImpl

org.corpus_tools.pepper.impl.PepperExporterImpl

org.corpus_tools.pepper.modules.coreModules.TextExporter

All Implemented Interfaces:

Thread.UncaughtExceptionHandler, PepperExporter, PepperModule

public class TextExporter
extends PepperExporterImpl
implements PepperExporter

This is a PepperExporter which extracts and exports the primary text of a Salt model and stores it into a text file.

Version:

1.0

Author:

Florian Zipser

Nested Class Summary

Nested classes/interfaces inherited from interface org.corpus_tools.pepper.modules.PepperExporter

PepperExporter.EXPORT_MODE

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

corpusDefinition

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
TextExporter()

Method Summary

Modifier and Type	Method and Description
PepperMapper	createPepperMapper(org.corpus_tools.salt.graph.Identifier sElementId) Creates a mapper to export primary texts.
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.PepperExporterImpl

addSupportedFormat, createFolderStructure, exportCorpusStructure, getCorpusDesc, getDocumentEnding, getExportMode, getIdentifier2ResourceTable, getSupportedFormats, setCorpusDesc, setDocumentEnding, setExportMode, start

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

activate, 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, 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.PepperExporter

addSupportedFormat, createFolderStructure, exportCorpusStructure, getCorpusDesc, getDocumentEnding, getExportMode, getIdentifier2ResourceTable, getSupportedFormats, setCorpusDesc, setDocumentEnding, setExportMode

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

TextExporter

public TextExporter()

Method Detail

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 sElementId)

Creates a mapper to export primary texts.

Specified by:

createPepperMapper in interface PepperModule

Overrides:

createPepperMapper in class PepperModuleImpl

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