gate

Class DocumentExporter

java.lang.Object

gate.util.AbstractFeatureBearer

gate.creole.AbstractResource

gate.DocumentExporter

All Implemented Interfaces:

Resource, FeatureBearer, NameBearer, Serializable

Direct Known Subclasses:

CorpusExporter, GateXMLExporter, InlineXMLExporter

public abstract class DocumentExporter
extends AbstractResource

Adds support for exporting documents from GATE. Subclasses of DocumentExporter now how to export in a given format. These exporters are loaded as Creole resources and made easily available within the GUI, but can also be easily accessed from within the API.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	defaultExtension
protected String	fileType
protected FileFilter	filter
protected String	mimeType

Fields inherited from class gate.creole.AbstractResource

name

Fields inherited from class gate.util.AbstractFeatureBearer

features

Constructor Summary

Constructors

Constructor and Description
DocumentExporter(String fileType, String defaultExtension, String mimeType) Creates a new exporter instance for a given file type with default extension.

Method Summary

Modifier and Type	Method and Description
void	export(Document doc, File file) Equivalent to export(Document,File,FeatureMap) with an empty map of options.
void	export(Document doc, File file, FeatureMap options) Equivalent to export(Document,OutputStream,FeatureMap) using a FileOutputStream instance constructed from the File param.
void	export(Document doc, OutputStream out) Equivalent to export(Document,OutputStream) with an empty map of options.
abstract void	export(Document doc, OutputStream out, FeatureMap options) Exports the provided Document instance to the specified OutputStream using the specified options.
String	getDefaultExtension() The default extension added to files saved in this format
FileFilter	getFileFilter() A filter used in the file chooser to restrict the view to files of this type.
String	getFileType() The name of the file type exported
static DocumentExporter	getInstance(String className)
String	getMimeType()
String	getName() Returns the name of this resource

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

Field Detail

fileType

protected String fileType

defaultExtension

protected String defaultExtension

mimeType

protected String mimeType

filter

protected FileFilter filter

Constructor Detail

DocumentExporter

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

Creates a new exporter instance for a given file type with default extension.

Parameters:

fileType - this is the human readable file type name that will appear on the menu

defaultExtension - the default file extension for this type

Method Detail

getFileType

public String getFileType()

The name of the file type exported

Returns:

the name of the file type exported

getDefaultExtension

public String getDefaultExtension()

The default extension added to files saved in this format

Returns:

the default extension added to files saved in this format

getName

public String getName()

Description copied from class: AbstractResource

Returns the name of this resource

Specified by:

getName in interface NameBearer

Overrides:

getName in class AbstractResource

getMimeType

public String getMimeType()

getFileFilter

public FileFilter getFileFilter()

A filter used in the file chooser to restrict the view to files of this type. The default implementation just uses the default extension as the filter constraint

export

public void export(Document doc,
                   File file)
            throws IOException

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

Throws:

IOException

export

public void export(Document doc,
                   File file,
                   FeatureMap options)
            throws IOException

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

Throws:

IOException

export

public void export(Document doc,
                   OutputStream out)
            throws IOException

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

Throws:

IOException

export

public abstract void export(Document doc,
                            OutputStream out,
                            FeatureMap options)
                     throws IOException

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

Parameters:

doc - the document to export

out - the OutputStream to export the document to

options - DocumentExporter specific options

Throws:

IOException

getInstance

public static DocumentExporter getInstance(String className)