org.corpus_tools.peppermodules.PTBModules

Class PTBExporter

java.lang.Object

org.corpus_tools.pepper.impl.PepperModuleImpl

org.corpus_tools.pepper.impl.PepperExporterImpl

org.corpus_tools.peppermodules.PTBModules.PTBExporter

All Implemented Interfaces:

Thread.UncaughtExceptionHandler, org.corpus_tools.pepper.modules.PepperExporter, org.corpus_tools.pepper.modules.PepperModule

public class PTBExporter
extends org.corpus_tools.pepper.impl.PepperExporterImpl
implements org.corpus_tools.pepper.modules.PepperExporter

This exporter transforms a Salt model into the Penn Trebank format (ptb).

Version:

1.0

Author:

Amir Zeldes

Nested Class Summary

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

org.corpus_tools.pepper.modules.PepperExporter.EXPORT_MODE

Field Summary

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
PTBExporter() OVERRIDE THIS METHOD FOR CUSTOMIZATION A constructor for your module.

Method Summary

Methods

Modifier and Type	Method and Description
org.corpus_tools.pepper.modules.PepperMapper	createPepperMapper(org.corpus_tools.salt.graph.Identifier sElementId) OVERRIDE THIS METHOD FOR CUSTOMIZATION This method creates a customized PepperMapper object and returns it.
boolean	isReadyToStart() OVERRIDE THIS METHOD FOR CUSTOMIZATION This method is called by the pepper framework after initializing this object and directly before start processing.

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, 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, proposeImportOrder, setCorpusGraph, setDesc, setIsMultithreaded, setPepperModuleController_basic, setPepperModuleController, setProperties, setResources, setSaltProject, setSupplierContact, setSupplierHomepage, setSymbolicName, setTemproraries, setVersion, start, start

Constructor Detail

PTBExporter

public PTBExporter()

OVERRIDE THIS METHOD FOR CUSTOMIZATION A constructor for your module. Set the coordinates, with which your module shall be registered. The coordinates (modules name, version and supported formats) are a kind of a fingerprint, which should make your module unique.

Method Detail

createPepperMapper

public org.corpus_tools.pepper.modules.PepperMapper createPepperMapper(org.corpus_tools.salt.graph.Identifier sElementId)

OVERRIDE THIS METHOD FOR CUSTOMIZATION This method creates a customized PepperMapper object and returns it. You can here do some additional initialisations. Things 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 PepperExporterImpl.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.

Specified by:

createPepperMapper in interface org.corpus_tools.pepper.modules.PepperModule

Overrides:

createPepperMapper in class org.corpus_tools.pepper.impl.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

isReadyToStart

public boolean isReadyToStart()
                       throws org.corpus_tools.pepper.modules.exceptions.PepperModuleNotReadyException

OVERRIDE THIS METHOD FOR CUSTOMIZATION This method is called by the pepper framework after initializing this object and directly before start processing. Initializing means setting properties PepperModuleProperties, setting temprorary files, resources etc. . returns false or throws an exception in case of PepperModule instance is not ready for any reason.

Specified by:

isReadyToStart in interface org.corpus_tools.pepper.modules.PepperModule

Overrides:

isReadyToStart in class org.corpus_tools.pepper.impl.PepperModuleImpl

Returns:

false, PepperModule instance is not ready for any reason, true, else.

Throws:

org.corpus_tools.pepper.modules.exceptions.PepperModuleNotReadyException