gate

Class CorpusExporter

java.lang.Object

gate.util.AbstractFeatureBearer

gate.creole.AbstractResource

gate.DocumentExporter

gate.CorpusExporter

All Implemented Interfaces:

Resource, FeatureBearer, NameBearer, Serializable

public abstract class CorpusExporter
extends DocumentExporter

A DocumentExporter that is also capable of exporting a whole corpus to a single file.

See Also:

Serialized Form

Field Summary

Fields inherited from class gate.DocumentExporter

defaultExtension, fileType, filter, mimeType

Fields inherited from class gate.creole.AbstractResource

name

Fields inherited from class gate.util.AbstractFeatureBearer

features

Constructor Summary

Constructors

Constructor and Description
CorpusExporter(String fileType, String defaultExtension, String mimeType)

Method Summary

Modifier and Type	Method and Description
void	export(Corpus corpus, File file) Equivalent to export(Corpus,File,FeatureMap) with an empty map of options.
void	export(Corpus corpus, File file, FeatureMap options) Equivalent to export(Corpus,OutputStream,FeatureMap) using a FileOutputStream instance constructed from the File param.
void	export(Corpus corpus, OutputStream out) Equivalent to export(Corpus,OutputStream) with an empty map of options.
abstract void	export(Corpus corpus, OutputStream out, FeatureMap options) Exports the provided Corpus instance to the specified OutputStream using the specified options.

Methods inherited from class gate.DocumentExporter

export, export, export, export, getDefaultExtension, getFileFilter, getFileType, getInstance, getMimeType, getName

Methods inherited from class gate.creole.AbstractResource

checkParameterValues, cleanup, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getParameterValue, getParameterValue, getParameterValues, init, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toString

Methods inherited from class gate.util.AbstractFeatureBearer

getFeatures, setFeatures

Methods inherited from class java.lang.Object

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

Methods inherited from interface gate.util.FeatureBearer

getFeatures, setFeatures

Constructor Detail

CorpusExporter

public CorpusExporter(String fileType,
                      String defaultExtension,
                      String mimeType)

Method Detail

export

public void export(Corpus corpus,
                   File file)
            throws IOException

Equivalent to export(Corpus,File,FeatureMap) with an empty map of options.

Throws:

IOException

export

public void export(Corpus corpus,
                   File file,
                   FeatureMap options)
            throws IOException

Equivalent to export(Corpus,OutputStream,FeatureMap) using a FileOutputStream instance constructed from the File param.

Throws:

IOException

export

public void export(Corpus corpus,
                   OutputStream out)
            throws IOException

Equivalent to export(Corpus,OutputStream) with an empty map of options.

Throws:

IOException

export

public abstract void export(Corpus corpus,
                            OutputStream out,
                            FeatureMap options)
                     throws IOException

Exports the provided Corpus instance to the specified OutputStream using the specified options.

Parameters:

corpus - the corpus to export

out - the OutputStream to export the document to

options - DocumentExporter specific options

Throws:

IOException