gate.creole.annotdelete
Class AnnotationDeletePR

java.lang.Object
  gate.util.AbstractFeatureBearer
      gate.creole.AbstractResource
          gate.creole.AbstractProcessingResource
              gate.creole.AbstractLanguageAnalyser
                  gate.creole.annotdelete.AnnotationDeletePR

All Implemented Interfaces:

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

@CreoleResource(name="Document Reset PR",
                comment="Remove named annotation sets or reset the default annotation set")
public class AnnotationDeletePR
extends AbstractLanguageAnalyser
implements ProcessingResource

This class is the implementation of a processing resource which deletes all annotations and sets other than 'original markups'. If put at the start of an application, it'll ensure that the document is restored to its clean state before being processed.

See Also:

Serialized Form

Nested Class Summary

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

AbstractProcessingResource.InternalStatusListener, AbstractProcessingResource.IntervalProgressListener

Field Summary

protected List	annotationTypes
protected Boolean	keepOriginalMarkupsAS
protected String	markupSetName
protected List	setsToKeep
protected List<String>	setsToRemove
static String	TRANSD_ANNOT_TYPES_PARAMETER_NAME
static String	TRANSD_DOCUMENT_PARAMETER_NAME
static String	TRANSD_SETS_KEEP_ORIGIANL_MARKUPS_ANNOT_SET
static String	TRANSD_SETS_KEEP_PARAMETER_NAME

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

AnnotationDeletePR()

Method Summary

void	execute() Run the resource.
List	getAnnotationTypes()
Boolean	getKeepOriginalMarkupsAS()
String	getMarkupASName()
List	getSetsToKeep()
List<String>	getSetsToRemove()
Resource	init() Initialise this resource, and return it.
void	reInit() Reinitialises the processing resource.
void	setAnnotationTypes(List newTypes)
void	setKeepOriginalMarkupsAS(Boolean emptyDefaultAnnotationSet)
void	setMarkupASName(String newMarkupASName)
void	setSetsToKeep(List newSetNames)
void	setSetsToRemove(List<String> setsToRemove) This parameter specifies the names of sets to remove or reset.

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

TRANSD_DOCUMENT_PARAMETER_NAME

public static final String TRANSD_DOCUMENT_PARAMETER_NAME

See Also:

Constant Field Values

TRANSD_ANNOT_TYPES_PARAMETER_NAME

public static final String TRANSD_ANNOT_TYPES_PARAMETER_NAME

See Also:

Constant Field Values

TRANSD_SETS_KEEP_PARAMETER_NAME

public static final String TRANSD_SETS_KEEP_PARAMETER_NAME

See Also:

Constant Field Values

TRANSD_SETS_KEEP_ORIGIANL_MARKUPS_ANNOT_SET

public static final String TRANSD_SETS_KEEP_ORIGIANL_MARKUPS_ANNOT_SET

See Also:

Constant Field Values

markupSetName

protected String markupSetName

annotationTypes

protected List annotationTypes

setsToKeep

protected List setsToKeep

setsToRemove

protected List<String> setsToRemove

keepOriginalMarkupsAS

protected Boolean keepOriginalMarkupsAS

Constructor Detail

AnnotationDeletePR

public AnnotationDeletePR()

Method Detail

setSetsToRemove

@RunTime
@Optional
@CreoleParameter(comment="A list of annotation set names to reset/remove. If non-empty, ignore the parameters which specify what to keep")
public void setSetsToRemove(List<String> setsToRemove)

This parameter specifies the names of sets to remove or reset. If this list is empty or null, it will be ignored. If this list is not empty, all the other parameters of this PR are ignored. In order to include the default annotation set in this list, add a list entry that is either null or an empty String.

Parameters:

setsToRemove - a List of String that contains the names of annotation sets to remove.

getSetsToRemove

public List<String> getSetsToRemove()

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

setMarkupASName

public void setMarkupASName(String newMarkupASName)

getMarkupASName

public String getMarkupASName()

getAnnotationTypes

public List getAnnotationTypes()

setAnnotationTypes

public void setAnnotationTypes(List newTypes)

getSetsToKeep

public List getSetsToKeep()

setSetsToKeep

public void setSetsToKeep(List newSetNames)

getKeepOriginalMarkupsAS

public Boolean getKeepOriginalMarkupsAS()

setKeepOriginalMarkupsAS

public void setKeepOriginalMarkupsAS(Boolean emptyDefaultAnnotationSet)