|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--gate.util.AbstractFeatureBearer | +--gate.creole.AbstractResource | +--gate.creole.AbstractProcessingResource | +--gate.creole.AbstractLanguageAnalyser | +--gate.creole.dumpingPR.DumpingPR
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.
Nested Class Summary |
Nested classes 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 |
private static boolean |
DEBUG
|
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
|
private static String |
DUMPING_PR_SET
|
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 |
outputFileUrl
|
protected String |
suffixForDumpFiles
What suffix to use for the dump files. |
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 |
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. |
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 |
setOutputFileUrl(URL file)
|
void |
setSuffixForDumpFiles(String newSuffix)
|
void |
setUseSuffixForDumpFiles(Boolean useOrNot)
|
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, 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 |
public static final String DPR_DOCUMENT_PARAMETER_NAME
public static final String DPR_ANN_SET_PARAMETER_NAME
public static final String DPR_ANN_TYPES_PARAMETER_NAME
public static final String DPR_DUMP_TYPES_PARAMETER_NAME
public static final String DPR_OUTPUR_URL_PARAMETER_NAME
public static final String DPR_INCLUDE_FEAT_PARAMETER_NAME
public static final String DPR_USE_SUFFIX_PARAMETER_NAME
public static final String DPR_FILE_SUFFIX_PARAMETER_NAME
private static final boolean DEBUG
protected List annotationTypes
protected List dumpTypes
protected String annotationSetName
protected boolean includeFeatures
protected String suffixForDumpFiles
protected boolean useSuffixForDumpFiles
protected URL outputFileUrl
private static final String DUMPING_PR_SET
Constructor Detail |
public DumpingPR()
Method Detail |
public Resource init() throws ResourceInstantiationException
init
in interface Resource
init
in class AbstractProcessingResource
ResourceInstantiationException
public void reInit() throws ResourceInstantiationException
reInit
in interface ProcessingResource
reInit
in class AbstractProcessingResource
ResourceInstantiationException
public void execute() throws ExecutionException
execute
in interface Executable
execute
in class AbstractProcessingResource
ExecutionException
protected void write2File(AnnotationSet exportSet)
protected AnnotationSet renameAnnotations(AnnotationSet annots2Export, HashMap renameMap)
public String getAnnotationSetName()
public void setAnnotationSetName(String newAnnotationSetName)
public List getAnnotationTypes()
public void setAnnotationTypes(List newTypes)
public List getDumpTypes()
public void setDumpTypes(List newTypes)
public URL getOutputFileUrl()
public void setOutputFileUrl(URL file)
public void setIncludeFeatures(Boolean inclFeatures)
public Boolean getIncludeFeatures()
public String getSuffixForDumpFiles()
public void setSuffixForDumpFiles(String newSuffix)
public Boolean getUseSuffixForDumpFiles()
public void setUseSuffixForDumpFiles(Boolean useOrNot)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |