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, FeatureBearer, LanguageAnalyser, NameBearer, ProcessingResource, Resource, 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

Field Summary
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_OUTPUR_URL_PARAMETER_NAME
           
static String DPR_USE_SUFFIX_PARAMETER_NAME
           
 
Fields inherited from interface gate.creole.ANNIEConstants
ANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DOCUMENT_COREF_FEATURE_NAME, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, 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()
           
 Boolean getIncludeFeatures()
           
 URL getOutputFileUrl()
           
 String getSuffixForDumpFiles()
           
 Boolean getUseSuffixForDumpFiles()
           
 Resource init()
          Initialise this resource, and return it.
 void reInit()
          Reinitialises the processing resource.
 void setAnnotationSetName(String newAnnotationSetName)
          set the annotation set name
 void setAnnotationTypes(List newTypes)
           
 void setDumpTypes(List newTypes)
           
 void setIncludeFeatures(Boolean inclFeatures)
           
 void setOutputFileUrl(URL file)
           
 void setSuffixForDumpFiles(String newSuffix)
           
 void setUseSuffixForDumpFiles(Boolean useOrNot)
           
 
Methods inherited from class gate.creole.AbstractLanguageAnalyser
getCorpus, getDocument, setCorpus, setDocument
 
Methods inherited from class gate.creole.AbstractProcessingResource
addProgressListener, addStatusListener, cleanup, interrupt, isInterrupted, removeProgressListener, removeStatusListener
 
Methods inherited from class gate.creole.AbstractResource
checkParameterValues, 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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface gate.ProcessingResource
interrupt, isInterrupted
 
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
 

Field Detail

DPR_DOCUMENT_PARAMETER_NAME

public static final String DPR_DOCUMENT_PARAMETER_NAME

DPR_ANN_SET_PARAMETER_NAME

public static final String DPR_ANN_SET_PARAMETER_NAME

DPR_ANN_TYPES_PARAMETER_NAME

public static final String DPR_ANN_TYPES_PARAMETER_NAME

DPR_DUMP_TYPES_PARAMETER_NAME

public static final String DPR_DUMP_TYPES_PARAMETER_NAME

DPR_OUTPUR_URL_PARAMETER_NAME

public static final String DPR_OUTPUR_URL_PARAMETER_NAME

DPR_INCLUDE_FEAT_PARAMETER_NAME

public static final String DPR_INCLUDE_FEAT_PARAMETER_NAME

DPR_USE_SUFFIX_PARAMETER_NAME

public static final String DPR_USE_SUFFIX_PARAMETER_NAME

DPR_FILE_SUFFIX_PARAMETER_NAME

public static final String DPR_FILE_SUFFIX_PARAMETER_NAME
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

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

execute

public void execute()
             throws ExecutionException
Run the resource.
Specified by:
execute in interface Executable
Overrides:
execute in class AbstractProcessingResource

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)

getOutputFileUrl

public URL getOutputFileUrl()

setOutputFileUrl

public void setOutputFileUrl(URL file)

setIncludeFeatures

public void setIncludeFeatures(Boolean inclFeatures)

getIncludeFeatures

public Boolean getIncludeFeatures()

getSuffixForDumpFiles

public String getSuffixForDumpFiles()

setSuffixForDumpFiles

public void setSuffixForDumpFiles(String newSuffix)

getUseSuffixForDumpFiles

public Boolean getUseSuffixForDumpFiles()

setUseSuffixForDumpFiles

public void setUseSuffixForDumpFiles(Boolean useOrNot)