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
PepperExporterand cannot be instantiated directly. To implement an exporter for Pepper, the easiest way is to derive this class. For further information, read the javadoc ofPepperManipulatorand 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 CorpusDesccorpusDefinitionTODO 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 protectedPepperExporterImpl()Creates aPepperModuleof typeMODULE_TYPE.EXPORTER.protectedPepperExporterImpl(String name)Creates aPepperModuleof typeMODULE_TYPE.EXPORTERand sets is name to the passed one.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FormatDescaddSupportedFormat(String formatName, String formatVersion, org.eclipse.emf.common.util.URI formatReference){@inheritDoc PepperExporter#addSupportedFormat(String, String, URI)}org.eclipse.emf.common.util.URIcreateFolderStructure(org.corpus_tools.salt.graph.Identifier id)Deprecated.voidexportCorpusStructure(){@inheritDoc PepperExporter#exportCorpusStructure()}CorpusDescgetCorpusDesc(){@inheritDoc PepperExporter#getCorpusDefinition()}StringgetDocumentEnding(){@inheritDoc PepperExporter#getDocumentEnding()}PepperExporter.EXPORT_MODEgetExportMode(){@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()}voidsetCorpusDesc(CorpusDesc newCorpusDefinition){@inheritDoc PepperExporter#setCorpusDefinition(CorpusDefinition)}voidsetDocumentEnding(String sDocumentEnding){@inheritDoc PepperExporter#setDocumentEnding(String)}voidsetExportMode(PepperExporter.EXPORT_MODE exportMode){@inheritDoc PepperExporter#setExportMode(org.corpus_tools.pepper.modules. PepperExporter.EXPORT_MODE)}voidstart()Adds the call of method#exportCorpusStructure(SCorpusGraph), than callsPepperModule.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 aPepperModuleof typeMODULE_TYPE.EXPORTER. The name of this module is set to "MyExporter".
We recommend to use the constructorPepperExporterImpl(String)and pass a proper name.
-
PepperExporterImpl
protected PepperExporterImpl(String name)
Creates aPepperModuleof typeMODULE_TYPE.EXPORTERand sets is name to the passed one.
-
-
Method Detail
-
getSupportedFormats
public List<FormatDesc> getSupportedFormats()
{@inheritDoc PepperExporter#getSupportedFormats()}- Specified by:
getSupportedFormatsin interfacePepperExporter- Returns:
-
addSupportedFormat
public FormatDesc addSupportedFormat(String formatName, String formatVersion, org.eclipse.emf.common.util.URI formatReference)
{@inheritDoc PepperExporter#addSupportedFormat(String, String, URI)}- Specified by:
addSupportedFormatin interfacePepperExporter
-
getCorpusDesc
public CorpusDesc getCorpusDesc()
{@inheritDoc PepperExporter#getCorpusDefinition()}- Specified by:
getCorpusDescin interfacePepperExporter- Returns:
-
setCorpusDesc
public void setCorpusDesc(CorpusDesc newCorpusDefinition)
{@inheritDoc PepperExporter#setCorpusDefinition(CorpusDefinition)}- Specified by:
setCorpusDescin interfacePepperExporter
-
start
public void start() throws PepperModuleExceptionAdds the call of method#exportCorpusStructure(SCorpusGraph), than callsPepperModule.start().- Specified by:
startin interfacePepperModule- Overrides:
startin classPepperModuleImpl- Throws:
PepperModuleException
-
getDocumentEnding
public String getDocumentEnding()
{@inheritDoc PepperExporter#getDocumentEnding()}- Specified by:
getDocumentEndingin interfacePepperExporter- Returns:
- file ending for
SDocumentobjects to be exported.
-
setDocumentEnding
public void setDocumentEnding(String sDocumentEnding)
{@inheritDoc PepperExporter#setDocumentEnding(String)}- Specified by:
setDocumentEndingin interfacePepperExporter
-
getExportMode
public PepperExporter.EXPORT_MODE getExportMode()
{@inheritDoc PepperExporter#getExportMode()}- Specified by:
getExportModein interfacePepperExporter- Returns:
-
setExportMode
public void setExportMode(PepperExporter.EXPORT_MODE exportMode)
{@inheritDoc PepperExporter#setExportMode(org.corpus_tools.pepper.modules. PepperExporter.EXPORT_MODE)}- Specified by:
setExportModein interfacePepperExporter
-
getIdentifier2ResourceTable
public Map<org.corpus_tools.salt.graph.Identifier,org.eclipse.emf.common.util.URI> getIdentifier2ResourceTable()
{@inheritDoc PepperImporter#getIdentifier2ResourceTable()}- Specified by:
getIdentifier2ResourceTablein interfacePepperExporter- Returns:
- table correspondence between
Identifierand a resource.
-
exportCorpusStructure
public void exportCorpusStructure()
{@inheritDoc PepperExporter#exportCorpusStructure()}- Specified by:
exportCorpusStructurein interfacePepperExporter
-
createFolderStructure
@Deprecated public org.eclipse.emf.common.util.URI createFolderStructure(org.corpus_tools.salt.graph.Identifier id)
Deprecated.{@inheritDoc PepperExporter#createFolderStructure(Identifier)}- Specified by:
createFolderStructurein interfacePepperExporter- Returns:
- the entire path of
Identifieras file path, which was created on disk
-
-