gate.creole.annotransfer
Class AnnotationSetTransfer

java.lang.Object
  gate.util.AbstractFeatureBearer
      gate.creole.AbstractResource
          gate.creole.AbstractProcessingResource
              gate.creole.AbstractLanguageAnalyser
                  gate.creole.annotransfer.AnnotationSetTransfer

All Implemented Interfaces:

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

public class AnnotationSetTransfer
extends AbstractLanguageAnalyser
implements ProcessingResource, Serializable

This plugin allows the names of annotations and features to be changed as well as transfered from one annotation set to another. Think of it as an extended version of the old AnnotationSet Transfer plugin.

Author:

Mark A. Greenwood

See Also:

Serialized Form

Nested Class Summary

(package private) class

AnnotationSetTransfer.Mapping

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

AbstractProcessingResource.InternalStatusListener, AbstractProcessingResource.IntervalProgressListener

Field Summary

private List<String>	annotationTypes
private AnnotationSet	bodyAnnotations
private URL	configURL
private Boolean	copyAnnotations
private String	inputASName
(package private) Map<String,AnnotationSetTransfer.Mapping>	mappings
private String	outputASName
private String	tagASName
private String	textTagName
private Boolean	transferAllUnlessFound

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

AnnotationSetTransfer()

Method Summary

void	execute() Run the resource.
List<String>	getAnnotationTypes()
URL	getConfigURL()
Boolean	getCopyAnnotations()
String	getInputASName()
String	getOutputASName()
String	getTagASName()
String	getTextTagName()
Boolean	getTransferAllUnlessFound()
Resource	init() Initialise this resource, and return it.
void	setAnnotationTypes(List<String> newTypes)
void	setConfigURL(URL url)
void	setCopyAnnotations(Boolean copyAnnotations)
void	setInputASName(String newInputASName)
void	setOutputASName(String newOutputASName)
void	setTagASName(String newTagASName)
void	setTextTagName(String newTextTagName)
void	setTransferAllUnlessFound(Boolean value)
private void	transferAnnotations(List<Annotation> toTransfer, AnnotationSet to, boolean newID)

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, reInit, 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.ProcessingResource

reInit

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

tagASName

private String tagASName

outputASName

private String outputASName

inputASName

private String inputASName

textTagName

private String textTagName

configURL

private URL configURL

copyAnnotations

private Boolean copyAnnotations

transferAllUnlessFound

private Boolean transferAllUnlessFound

bodyAnnotations

private AnnotationSet bodyAnnotations

annotationTypes

private List<String> annotationTypes

mappings

Map<String,AnnotationSetTransfer.Mapping> mappings

Constructor Detail

AnnotationSetTransfer

public AnnotationSetTransfer()

Method Detail

init

public Resource init()
              throws ResourceInstantiationException

Description copied from class: AbstractProcessingResource

Initialise this resource, and return it.

Specified by:

init in interface Resource

Overrides:

init in class AbstractProcessingResource

Throws:

ResourceInstantiationException

execute

public void execute()
             throws ExecutionException

Description copied from class: AbstractProcessingResource

Run the resource. It doesn't make sense not to override this in subclasses so the default implementation signals an exception.

Specified by:

execute in interface Executable

Overrides:

execute in class AbstractProcessingResource

Throws:

ExecutionException

transferAnnotations

private void transferAnnotations(List<Annotation> toTransfer,
                                 AnnotationSet to,
                                 boolean newID)
                          throws ExecutionException

Throws:

ExecutionException

setTagASName

public void setTagASName(String newTagASName)

getTagASName

public String getTagASName()

setInputASName

public void setInputASName(String newInputASName)

getInputASName

public String getInputASName()

setOutputASName

public void setOutputASName(String newOutputASName)

getOutputASName

public String getOutputASName()

setTextTagName

public void setTextTagName(String newTextTagName)

getTextTagName

public String getTextTagName()

getAnnotationTypes

public List<String> getAnnotationTypes()

setAnnotationTypes

public void setAnnotationTypes(List<String> newTypes)

setConfigURL

public void setConfigURL(URL url)

getConfigURL

public URL getConfigURL()

getCopyAnnotations

public Boolean getCopyAnnotations()

setCopyAnnotations

public void setCopyAnnotations(Boolean copyAnnotations)

getTransferAllUnlessFound

public Boolean getTransferAllUnlessFound()

setTransferAllUnlessFound

public void setTransferAllUnlessFound(Boolean value)