org.corpus_tools.annis.gui.exporter

Class GeneralTextExporter

java.lang.Object

org.corpus_tools.annis.gui.exporter.GeneralTextExporter

All Implemented Interfaces:

Serializable, ExporterPlugin

Direct Known Subclasses:

GridExporter, SimpleTextExporter, TokenExporter

public abstract class GeneralTextExporter
extends Object
implements ExporterPlugin, Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GeneralTextExporter()

Method Summary

Modifier and Type	Method and Description
void	appendMetaData(Writer out, List<String> metaKeys, String toplevelCorpus, String documentName, Map<String,Map<String,org.corpus_tools.salt.core.SMetaAnnotation>> metadataCache, com.vaadin.ui.UI ui)
void	convertText(org.corpus_tools.salt.common.SaltProject queryResult, List<String> keys, Map<String,String> args, Writer out, int offset, com.vaadin.ui.UI ui)
Exception	convertText(String queryAnnisQL, QueryLanguage queryLanguage, int contextLeft, int contextRight, Set<String> corpora, List<String> keys, String argsAsString, boolean alignmc, Writer out, com.google.common.eventbus.EventBus eventBus, Map<String,CorpusConfiguration> corpusConfigs, com.vaadin.ui.UI ui)
protected List<String>	getAllAnnotationsAsExporterKey(Collection<String> corpora, CorporaApi api) Queries all annotations for the given corpora.
String	getFileEnding()
boolean	isCancelable()
boolean	needsContext()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.corpus_tools.annis.gui.exporter.ExporterPlugin

getHelpMessage, isAlignable

Constructor Detail

GeneralTextExporter

public GeneralTextExporter()

Method Detail

appendMetaData

public void appendMetaData(Writer out,
                           List<String> metaKeys,
                           String toplevelCorpus,
                           String documentName,
                           Map<String,Map<String,org.corpus_tools.salt.core.SMetaAnnotation>> metadataCache,
                           com.vaadin.ui.UI ui)
                    throws IOException

Throws:

IOException

convertText

public void convertText(org.corpus_tools.salt.common.SaltProject queryResult,
                        List<String> keys,
                        Map<String,String> args,
                        Writer out,
                        int offset,
                        com.vaadin.ui.UI ui)
                 throws IOException

Throws:

IOException

convertText

public Exception convertText(String queryAnnisQL,
                             QueryLanguage queryLanguage,
                             int contextLeft,
                             int contextRight,
                             Set<String> corpora,
                             List<String> keys,
                             String argsAsString,
                             boolean alignmc,
                             Writer out,
                             com.google.common.eventbus.EventBus eventBus,
                             Map<String,CorpusConfiguration> corpusConfigs,
                             com.vaadin.ui.UI ui)

Specified by:

convertText in interface ExporterPlugin

getFileEnding

public String getFileEnding()

Specified by:

getFileEnding in interface ExporterPlugin

isCancelable

public boolean isCancelable()

Specified by:

isCancelable in interface ExporterPlugin

needsContext

public boolean needsContext()

Specified by:

needsContext in interface ExporterPlugin

getAllAnnotationsAsExporterKey

protected List<String> getAllAnnotationsAsExporterKey(Collection<String> corpora,
                                                      CorporaApi api)
                                               throws ApiException

Queries all annotations for the given corpora.

Parameters:

corpora - The corpora to query

api - An API object used to perform the lookup

Returns:

A list of annotation names.

Throws:

ApiException