gate.creole.dumpingPR
Class DumpingPR

java.lang.Object
  gate.util.AbstractFeatureBearer
      gate.creole.AbstractResource
          gate.creole.AbstractProcessingResource
              gate.creole.AbstractLanguageAnalyser
                  gate.creole.dumpingPR.DumpingPR

All Implemented Interfaces:

ANNIEConstants, Executable, LanguageAnalyser, ProcessingResource, Resource, FeatureBearer, NameBearer, Serializable

public class DumpingPR
extends AbstractLanguageAnalyser
implements ProcessingResource

This class implements a DumpingPR which exports a given set of annotation types + the original markup, back into the document's native format. The export might also include the GATE features of those annotations or not (the default). One can also control whether the export files have a new suffix (useSuffixForDumpFiles) and what this suffix is (suffixForDumpFiles). By default, a suffix is used and it is .gate.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class gate.creole.AbstractProcessingResource

AbstractProcessingResource.InternalStatusListener, AbstractProcessingResource.IntervalProgressListener

Field Summary

protected String	annotationSetName the name of the annotation set from which to take the annotations for dumping
protected List	annotationTypes A list of annotation types, which are to be dumped into the output file
static String	DPR_ANN_SET_PARAMETER_NAME
static String	DPR_ANN_TYPES_PARAMETER_NAME
static String	DPR_DOCUMENT_PARAMETER_NAME
static String	DPR_DUMP_TYPES_PARAMETER_NAME
static String	DPR_FILE_SUFFIX_PARAMETER_NAME
static String	DPR_INCLUDE_FEAT_PARAMETER_NAME
static String	DPR_OUTPUT_URL_PARAMETER_NAME
static String	DPR_USE_SUFFIX_PARAMETER_NAME
protected List	dumpTypes A list of strings specifying new names to be used instead of the original annotation types given in the annotationTypes parameter.
protected boolean	includeFeatures Whether or not to include the annotation features during export
protected URL	outputDirectoryUrl
protected String	suffixForDumpFiles What suffix to use for the dump files. .gate by default, but can be changed via the set method.
protected boolean	useStandOffXML Whether or not to include the annotation features during export
protected boolean	useSuffixForDumpFiles Whether or not to use the special suffix fo the dump files.

Fields inherited from class gate.creole.AbstractLanguageAnalyser

corpus, document

Fields inherited from class gate.creole.AbstractProcessingResource

interrupted

Fields inherited from class gate.creole.AbstractResource

name

Fields inherited from class gate.util.AbstractFeatureBearer

features

Fields inherited from interface gate.creole.ANNIEConstants

ANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DATE_POSTED_ANNOTATION_TYPE, DEFAULT_FILE, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_FEATURE_NAME, LOOKUP_INSTANCE_FEATURE_NAME, LOOKUP_LANGUAGE_FEATURE_NAME, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, LOOKUP_ONTOLOGY_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, PLUGIN_DIR, PR_NAMES, SENTENCE_ANNOTATION_TYPE, SPACE_TOKEN_ANNOTATION_TYPE, TOKEN_ANNOTATION_TYPE, TOKEN_CATEGORY_FEATURE_NAME, TOKEN_KIND_FEATURE_NAME, TOKEN_LENGTH_FEATURE_NAME, TOKEN_ORTH_FEATURE_NAME, TOKEN_STRING_FEATURE_NAME

Constructor Summary

DumpingPR()

Method Summary

void	execute() Run the resource.
String	getAnnotationSetName() get the name of the annotation set
List	getAnnotationTypes()
List	getDumpTypes()
protected String	getFileName(URL url)
Boolean	getIncludeFeatures()
protected String	getNewFileName(URL dir, String file)
URL	getOutputDirectoryUrl()
String	getSuffixForDumpFiles()
Boolean	getUseStandOffXML()
Boolean	getUseSuffixForDumpFiles()
Resource	init() Initialise this resource, and return it.
void	reInit() Reinitialises the processing resource.
protected AnnotationSet	renameAnnotations(AnnotationSet annots2Export, HashMap renameMap)
void	setAnnotationSetName(String newAnnotationSetName) set the annotation set name
void	setAnnotationTypes(List newTypes)
void	setDumpTypes(List newTypes)
void	setIncludeFeatures(Boolean inclFeatures)
void	setOutputDirectoryUrl(URL file)
void	setSuffixForDumpFiles(String newSuffix)
void	setUseStandOffXML(Boolean newValue)
void	setUseSuffixForDumpFiles(Boolean useOrNot)
protected void	write2File()
protected void	write2File(AnnotationSet exportSet)

Methods inherited from class gate.creole.AbstractLanguageAnalyser

getCorpus, getDocument, setCorpus, setDocument

Methods inherited from class gate.creole.AbstractProcessingResource

addProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, interrupt, isInterrupted, removeProgressListener, removeStatusListener

Methods inherited from class gate.creole.AbstractResource

checkParameterValues, getBeanInfo, getName, getParameterValue, getParameterValue, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners

Methods inherited from class gate.util.AbstractFeatureBearer

getFeatures, setFeatures

Methods inherited from class java.lang.Object

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

Methods inherited from interface gate.Resource

cleanup, getParameterValue, setParameterValue, setParameterValues

Methods inherited from interface gate.util.FeatureBearer

getFeatures, setFeatures

Methods inherited from interface gate.util.NameBearer

getName, setName

Methods inherited from interface gate.Executable

interrupt, isInterrupted

Field Detail

DPR_DOCUMENT_PARAMETER_NAME

public static final String DPR_DOCUMENT_PARAMETER_NAME

See Also:

Constant Field Values

DPR_ANN_SET_PARAMETER_NAME

public static final String DPR_ANN_SET_PARAMETER_NAME

See Also:

Constant Field Values

DPR_ANN_TYPES_PARAMETER_NAME

public static final String DPR_ANN_TYPES_PARAMETER_NAME

See Also:

Constant Field Values

DPR_DUMP_TYPES_PARAMETER_NAME

public static final String DPR_DUMP_TYPES_PARAMETER_NAME

See Also:

Constant Field Values

DPR_OUTPUT_URL_PARAMETER_NAME

public static final String DPR_OUTPUT_URL_PARAMETER_NAME

See Also:

Constant Field Values

DPR_INCLUDE_FEAT_PARAMETER_NAME

public static final String DPR_INCLUDE_FEAT_PARAMETER_NAME

See Also:

Constant Field Values

DPR_USE_SUFFIX_PARAMETER_NAME

public static final String DPR_USE_SUFFIX_PARAMETER_NAME

See Also:

Constant Field Values

DPR_FILE_SUFFIX_PARAMETER_NAME

public static final String DPR_FILE_SUFFIX_PARAMETER_NAME

See Also:

Constant Field Values

annotationTypes

protected List annotationTypes

A list of annotation types, which are to be dumped into the output file

dumpTypes

protected List dumpTypes

A list of strings specifying new names to be used instead of the original annotation types given in the annotationTypes parameter. For example, if annotationTypes was set to [Location, Date], then if dumpTypes is set to [Place, Date-expr], then the labels and will be inserted instead of and .

annotationSetName

protected String annotationSetName

the name of the annotation set from which to take the annotations for dumping

includeFeatures

protected boolean includeFeatures

Whether or not to include the annotation features during export

useStandOffXML

protected boolean useStandOffXML

Whether or not to include the annotation features during export

suffixForDumpFiles

protected String suffixForDumpFiles

What suffix to use for the dump files. .gate by default, but can be changed via the set method.

useSuffixForDumpFiles

protected boolean useSuffixForDumpFiles

Whether or not to use the special suffix fo the dump files. True by default.

outputDirectoryUrl

protected URL outputDirectoryUrl

Constructor Detail

DumpingPR

public DumpingPR()

Method Detail

init

public Resource init()
              throws ResourceInstantiationException

Initialise this resource, and return it.

Specified by:

init in interface Resource

Overrides:

init in class AbstractProcessingResource

Throws:

ResourceInstantiationException

reInit

public void reInit()
            throws ResourceInstantiationException

Reinitialises the processing resource. After calling this method the resource should be in the state it is after calling init. If the resource depends on external resources (such as rules files) then the resource will re-read those resources. If the data used to create the resource has changed since the resource has been created then the resource will change too after calling reInit().

Specified by:

reInit in interface ProcessingResource

Overrides:

reInit in class AbstractProcessingResource

Throws:

ResourceInstantiationException

execute

public void execute()
             throws ExecutionException

Run the resource.

Specified by:

execute in interface Executable

Overrides:

execute in class AbstractProcessingResource

Throws:

ExecutionException

write2File

protected void write2File(AnnotationSet exportSet)

write2File

protected void write2File()

getFileName

protected String getFileName(URL url)

getNewFileName

protected String getNewFileName(URL dir,
                                String file)

renameAnnotations

protected AnnotationSet renameAnnotations(AnnotationSet annots2Export,
                                          HashMap renameMap)

getAnnotationSetName

public String getAnnotationSetName()

get the name of the annotation set

setAnnotationSetName

public void setAnnotationSetName(String newAnnotationSetName)

set the annotation set name

getAnnotationTypes

public List getAnnotationTypes()

setAnnotationTypes

public void setAnnotationTypes(List newTypes)

getDumpTypes

public List getDumpTypes()

setDumpTypes

public void setDumpTypes(List newTypes)

getOutputDirectoryUrl

public URL getOutputDirectoryUrl()

setOutputDirectoryUrl

public void setOutputDirectoryUrl(URL file)

setIncludeFeatures

public void setIncludeFeatures(Boolean inclFeatures)

getIncludeFeatures

public Boolean getIncludeFeatures()

setUseStandOffXML

public void setUseStandOffXML(Boolean newValue)

getUseStandOffXML

public Boolean getUseStandOffXML()

getSuffixForDumpFiles

public String getSuffixForDumpFiles()

setSuffixForDumpFiles

public void setSuffixForDumpFiles(String newSuffix)

getUseSuffixForDumpFiles

public Boolean getUseSuffixForDumpFiles()

setUseSuffixForDumpFiles

public void setUseSuffixForDumpFiles(Boolean useOrNot)