org.corpus_tools.pepper.impl

Class PepperExporterImpl

java.lang.Object

org.corpus_tools.pepper.impl.PepperModuleImpl

org.corpus_tools.pepper.impl.PepperExporterImpl

All Implemented Interfaces:

Thread.UncaughtExceptionHandler, PepperExporter, PepperModule

Direct Known Subclasses:

DoNothingExporter, DOTExporter, SaltXMLExporter, TextExporter

public abstract class PepperExporterImpl
extends PepperModuleImpl
implements PepperExporter

This class is an abstract implementation of PepperExporter and cannot be instantiated directly. To implement an exporter for Pepper, the easiest way is to derive this class. For further information, read the javadoc of PepperManipulator and the documentation of u.hu-berlin.de/saltnpepper.

Author:

Florian Zipser

See Also:

PepperManipulator

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
protected CorpusDesc	corpusDefinition TODO make docu

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

Modifier	Constructor and Description
protected	PepperExporterImpl() Creates a PepperModule of type MODULE_TYPE.EXPORTER.
protected	PepperExporterImpl(String name) Creates a PepperModule of type MODULE_TYPE.EXPORTER and sets is name to the passed one.

Method Summary

Modifier and Type	Method and Description
FormatDesc	addSupportedFormat(String formatName, String formatVersion, org.eclipse.emf.common.util.URI formatReference)
org.eclipse.emf.common.util.URI	createFolderStructure(org.corpus_tools.salt.graph.Identifier id) Deprecated.
void	exportCorpusStructure() This method is called by PepperModule.start() to export the corpus-structure into a folder-structure.
CorpusDesc	getCorpusDesc() TODO docu
String	getDocumentEnding() Returns the format ending for files to be exported and related to SDocument objects.
PepperExporter.EXPORT_MODE	getExportMode() Returns how corpus-structure is exported.
Map<org.corpus_tools.salt.graph.Identifier,org.eclipse.emf.common.util.URI>	getIdentifier2ResourceTable() Returns table correspondence between Identifier and a resource.
List<FormatDesc>	getSupportedFormats() TODO docu
void	setCorpusDesc(CorpusDesc newCorpusDefinition) TODO docu
void	setDocumentEnding(String sDocumentEnding) Sets the format ending for files to be exported and related to SDocument objects.
void	setExportMode(PepperExporter.EXPORT_MODE exportMode) {@inheritDoc PepperExporter#setExportMode(org.corpus_tools.pepper.modules.
void	start() Adds the call of method #exportCorpusStructure(SCorpusGraph), than calls PepperModule.start().

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

activate, createPepperMapper, done, done, end, getComponentContext, getCorpusGraph, getDesc, getDocumentId2DC, getFingerprint, getMapperControllers, getMapperThreadGroup, getModuleController, getModuleType, getName, getProgress, getProgress, getProperties, getResources, getSaltProject, getSelfTestDesc, 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.PepperModule

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

Field Detail

corpusDefinition

protected CorpusDesc corpusDefinition

TODO make docu

Constructor Detail

PepperExporterImpl

protected PepperExporterImpl()

Creates a PepperModule of type MODULE_TYPE.EXPORTER. The name of this module is set to "MyExporter".
We recommend to use the constructor PepperExporterImpl(String) and pass a proper name.

PepperExporterImpl

protected PepperExporterImpl(String name)

Creates a PepperModule of type MODULE_TYPE.EXPORTER and sets is name to the passed one.

Method Detail

getSupportedFormats

public List<FormatDesc> getSupportedFormats()

TODO docu

Specified by:

getSupportedFormats in interface PepperExporter

Returns:

addSupportedFormat

public FormatDesc addSupportedFormat(String formatName,
                                     String formatVersion,
                                     org.eclipse.emf.common.util.URI formatReference)

Specified by:

addSupportedFormat in interface PepperExporter

getCorpusDesc

public CorpusDesc getCorpusDesc()

TODO docu

Specified by:

getCorpusDesc in interface PepperExporter

Returns:

setCorpusDesc

public void setCorpusDesc(CorpusDesc newCorpusDefinition)

TODO docu

Specified by:

setCorpusDesc in interface PepperExporter

start

public void start()
           throws PepperModuleException

Adds the call of method #exportCorpusStructure(SCorpusGraph), than calls PepperModule.start().

Specified by:

start in interface PepperModule

Overrides:

start in class PepperModuleImpl

Throws:

PepperModuleException

getDocumentEnding

public String getDocumentEnding()

Returns the format ending for files to be exported and related to SDocument objects.

Specified by:

getDocumentEnding in interface PepperExporter

Returns:

file ending for SDocument objects to be exported.

setDocumentEnding

public void setDocumentEnding(String sDocumentEnding)

Sets the format ending for files to be exported and related to SDocument objects.

Specified by:

setDocumentEnding in interface PepperExporter

getExportMode

public PepperExporter.EXPORT_MODE getExportMode()

Returns how corpus-structure is exported.

Specified by:

getExportMode in interface PepperExporter

Returns:

setExportMode

public void setExportMode(PepperExporter.EXPORT_MODE exportMode)

Determines how the corpus-structure should be exported.

• EXPORT_MODE#NO_EXPORT - corpus-structure should not be exported
• EXPORT_MODE#CORPORA_ONLY SCorpus objects are exported into a folder structure, but SDocument objects are not exported
• EXPORT_MODE#DOCUMENTS_IN_FILES - SCorpus objects are exported into a folder structure and SDocument objects are stored in files having the ending determined by PepperExporter#getDocumentEnding()

Specified by:

setExportMode in interface PepperExporter

getIdentifier2ResourceTable

public Map<org.corpus_tools.salt.graph.Identifier,org.eclipse.emf.common.util.URI> getIdentifier2ResourceTable()

Returns table correspondence between Identifier and a resource. Stores Identifier objects corresponding to either a SDocument or a SCorpus object, which has been created during the run of #importCorpusStructure(SCorpusGraph). Corresponding to the Identifier object this table stores the resource from where the element shall be imported.
For instance:

corpus_1	/home/me/corpora/myCorpus
corpus_2	/home/me/corpora/myCorpus/subcorpus
doc_1	/home/me/corpora/myCorpus/subcorpus/document1.xml
doc_2	/home/me/corpora/myCorpus/subcorpus/document2.xml

Specified by:

getIdentifier2ResourceTable in interface PepperExporter

Returns:

table correspondence between Identifier and a resource.

exportCorpusStructure

public void exportCorpusStructure()

This method is called by PepperModule.start() to export the corpus-structure into a folder-structure. That means, each Identifier belonging to a SDocument or SCorpus object is stored PepperExporter.getIdentifier2ResourceTable() together with thze corresponding file-structure object (file or folder) located by a URI. The URI object corresponding to files will get the file ending determined by #getDocumentEnding(String), which could be set by PepperExporter.setDocumentEnding(String).
To adapt the creation of URIs set the export mode via PepperExporter.setExportMode(EXPORT_MODE).

Specified by:

exportCorpusStructure in interface PepperExporter

createFolderStructure

@Deprecated
public org.eclipse.emf.common.util.URI createFolderStructure(org.corpus_tools.salt.graph.Identifier id)

Deprecated.

Creates a folder structure basing on the passed corpus path in ( CorpusDesc.getCorpusPath()). For each segment in Identifier a folder is created.

Specified by:

createFolderStructure in interface PepperExporter

Returns:

the entire path of Identifier as file path, which was created on disk