Package 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	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	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	Description
FormatDesc	addSupportedFormat(String formatName, String formatVersion, org.eclipse.emf.common.util.URI formatReference)	{@inheritDoc PepperExporter#addSupportedFormat(String, String, URI)}
org.eclipse.emf.common.util.URI	createFolderStructure(org.corpus_tools.salt.graph.Identifier id)	Deprecated.
void	exportCorpusStructure()	{@inheritDoc PepperExporter#exportCorpusStructure()}
CorpusDesc	getCorpusDesc()	{@inheritDoc PepperExporter#getCorpusDefinition()}
String	getDocumentEnding()	{@inheritDoc PepperExporter#getDocumentEnding()}
PepperExporter.EXPORT_MODE	getExportMode()	{@inheritDoc PepperExporter#getExportMode()}
Map<org.corpus_tools.salt.graph.Identifier,org.eclipse.emf.common.util.URI>	getIdentifier2ResourceTable()	{@inheritDoc PepperImporter#getIdentifier2ResourceTable()}
List<FormatDesc>	getSupportedFormats()	{@inheritDoc PepperExporter#getSupportedFormats()}
void	setCorpusDesc(CorpusDesc newCorpusDefinition)	{@inheritDoc PepperExporter#setCorpusDefinition(CorpusDefinition)}
void	setDocumentEnding(String sDocumentEnding)	{@inheritDoc PepperExporter#setDocumentEnding(String)}
void	setExportMode(PepperExporter.EXPORT_MODE exportMode)	{@inheritDoc PepperExporter#setExportMode(org.corpus_tools.pepper.modules. PepperExporter.EXPORT_MODE)}
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, setPepperModuleController_basic, 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, setPepperModuleController_basic, 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()

{@inheritDoc PepperExporter#getSupportedFormats()}

Specified by:

getSupportedFormats in interface PepperExporter

Returns:

addSupportedFormat

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

{@inheritDoc PepperExporter#addSupportedFormat(String, String, URI)}

Specified by:

addSupportedFormat in interface PepperExporter

getCorpusDesc

public CorpusDesc getCorpusDesc()

{@inheritDoc PepperExporter#getCorpusDefinition()}

Specified by:

getCorpusDesc in interface PepperExporter

Returns:

setCorpusDesc

public void setCorpusDesc(CorpusDesc newCorpusDefinition)

{@inheritDoc PepperExporter#setCorpusDefinition(CorpusDefinition)}

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

{@inheritDoc PepperExporter#getDocumentEnding()}

Specified by:

getDocumentEnding in interface PepperExporter

Returns:

file ending for SDocument objects to be exported.

setDocumentEnding

public void setDocumentEnding(String sDocumentEnding)

{@inheritDoc PepperExporter#setDocumentEnding(String)}

Specified by:

setDocumentEnding in interface PepperExporter

getExportMode

public PepperExporter.EXPORT_MODE getExportMode()

{@inheritDoc PepperExporter#getExportMode()}

Specified by:

getExportMode in interface PepperExporter

Returns:

setExportMode

public void setExportMode(PepperExporter.EXPORT_MODE exportMode)

{@inheritDoc PepperExporter#setExportMode(org.corpus_tools.pepper.modules. PepperExporter.EXPORT_MODE)}

Specified by:

setExportMode in interface PepperExporter

getIdentifier2ResourceTable

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

{@inheritDoc PepperImporter#getIdentifier2ResourceTable()}

Specified by:

getIdentifier2ResourceTable in interface PepperExporter

Returns:

table correspondence between Identifier and a resource.

exportCorpusStructure

public void exportCorpusStructure()

{@inheritDoc PepperExporter#exportCorpusStructure()}

Specified by:

exportCorpusStructure in interface PepperExporter

createFolderStructure

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

Deprecated.

{@inheritDoc PepperExporter#createFolderStructure(Identifier)}

Specified by:

createFolderStructure in interface PepperExporter

Returns:

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