gate.corpora.export

Class InlineXMLExporter

java.lang.Object

gate.util.AbstractFeatureBearer

gate.creole.AbstractResource

gate.DocumentExporter

gate.corpora.export.InlineXMLExporter

All Implemented Interfaces:

Resource, FeatureBearer, NameBearer, Serializable

@CreoleResource(name="Inline XML Exporter",
                tool=true,
                autoinstances=,
                icon="InlineXML")
public class InlineXMLExporter
extends DocumentExporter

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
InlineXMLExporter()

Method Summary

Modifier and Type	Method and Description
void	export(Document doc, OutputStream out, FeatureMap options) Exports the provided Document instance to the specified OutputStream using the specified options.
String	getAnnotationSetName()
List<String>	getAnnotationTypes()
String	getEncoding()
Boolean	getIncludeFeatures()
Boolean	getIncludeOriginalMarkups()
String	getRootElement()
void	setAnnotationSetName(String annotationSetName)
void	setAnnotationTypes(List<String> annotationTypes)
void	setEncoding(String encoding)
void	setIncludeFeatures(Boolean includeFeatures)
void	setIncludeOriginalMarkups(Boolean includeOriginalMarkups)
void	setRootElement(String rootElement)

Methods inherited from class gate.DocumentExporter

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

InlineXMLExporter

public InlineXMLExporter()

Method Detail

getAnnotationSetName

public String getAnnotationSetName()

getEncoding

public String getEncoding()

setEncoding

@RunTime
 @CreoleParameter(defaultValue="UTF-8")
public void setEncoding(String encoding)

getRootElement

public String getRootElement()

setRootElement

@RunTime
 @Optional
 @CreoleParameter
public void setRootElement(String rootElement)

setAnnotationSetName

@RunTime
 @Optional
 @CreoleParameter
public void setAnnotationSetName(String annotationSetName)

getAnnotationTypes

public List<String> getAnnotationTypes()

setAnnotationTypes

@RunTime
 @CreoleParameter(defaultValue="Person;Location;Organization")
public void setAnnotationTypes(List<String> annotationTypes)

getIncludeOriginalMarkups

public Boolean getIncludeOriginalMarkups()

setIncludeOriginalMarkups

@RunTime
 @CreoleParameter(defaultValue="false")
public void setIncludeOriginalMarkups(Boolean includeOriginalMarkups)

getIncludeFeatures

public Boolean getIncludeFeatures()

setIncludeFeatures

@RunTime
 @CreoleParameter(defaultValue="true")
public void setIncludeFeatures(Boolean includeFeatures)

export

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

Description copied from class: DocumentExporter

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

Specified by:

export in class DocumentExporter

Parameters:

doc - the document to export

out - the OutputStream to export the document to

options - DocumentExporter specific options

Throws:

IOException