gate.creole.coref

Class NominalCoref

java.lang.Object

gate.util.AbstractFeatureBearer

gate.creole.AbstractResource

gate.creole.AbstractProcessingResource

gate.creole.AbstractLanguageAnalyser

gate.creole.coref.AbstractCoreferencer

gate.creole.coref.NominalCoref

All Implemented Interfaces:

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

@CreoleResource(name="ANNIE Nominal Coreferencer",
                comment="Nominal Coreference resolution component",
                helpURL="http://gate.ac.uk/userguide/sec:annie:pronom-coref",
                icon="nominal-coreferencer")
public class NominalCoref
extends AbstractCoreferencer
implements ProcessingResource, ANNIEConstants

See Also:

Serialized Form

Nested Class Summary

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

AbstractProcessingResource.InternalStatusListener, AbstractProcessingResource.IntervalProgressListener

Field Summary

Fields

Modifier and Type	Field and Description
static String	COREF_ANN_SET_PARAMETER_NAME
static String	COREF_DOCUMENT_PARAMETER_NAME

Fields inherited from class gate.creole.coref.AbstractCoreferencer

COREF_ANTECEDENT_FEATURE_NAME, COREF_TYPE_FEATURE_NAME, coreferenceType

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, 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

Constructors

Constructor and Description
NominalCoref() ---

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() This method runs the coreferencer.
String	getAnnotationSetName() ---
Map<Annotation,Annotation>	getResolvedAnaphora() ---
Resource	init() Initialise this resource, and return it.
void	reInit() Reinitialises the processing resource.
void	setAnnotationSetName(String annotationSetName) ---
void	setDocument(Document newDocument) Set the document to run on.

Methods inherited from class gate.creole.coref.AbstractCoreferencer

generateCorefChains

Methods inherited from class gate.creole.AbstractLanguageAnalyser

getCorpus, getDocument, setCorpus

Methods inherited from class gate.creole.AbstractProcessingResource

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

Methods inherited from class gate.creole.AbstractResource

checkParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toString

Methods inherited from class gate.util.AbstractFeatureBearer

getFeatures, setFeatures

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

COREF_DOCUMENT_PARAMETER_NAME

public static final String COREF_DOCUMENT_PARAMETER_NAME

See Also:

Constant Field Values

COREF_ANN_SET_PARAMETER_NAME

public static final String COREF_ANN_SET_PARAMETER_NAME

See Also:

Constant Field Values

Constructor Detail

NominalCoref

public NominalCoref()

---

Method Detail

init

public Resource init()
              throws ResourceInstantiationException

Initialise this resource, and return it.

Specified by:

init in interface Resource

Overrides:

init in class AbstractCoreferencer

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 AbstractCoreferencer

Throws:

ResourceInstantiationException

setDocument

public void setDocument(Document newDocument)

Set the document to run on.

Specified by:

setDocument in interface LanguageAnalyser

Overrides:

setDocument in class AbstractCoreferencer

setAnnotationSetName

@RunTime
@Optional
@CreoleParameter(comment="The annotation set to be used for the generated annotations")
public void setAnnotationSetName(String annotationSetName)

---

Specified by:

setAnnotationSetName in class AbstractCoreferencer

getAnnotationSetName

public String getAnnotationSetName()

---

Specified by:

getAnnotationSetName in class AbstractCoreferencer

execute

public void execute()
             throws ExecutionException

This method runs the coreferencer. It assumes that all the needed parameters are set. If they are not, an exception will be fired. The process goes like this: - Create a sorted list of Person and JobTitle annotations. - Loop through the annotations If it is a Person, we add it to the top of a stack. If it is a job title, we subject it to a series of tests. If it passes, we associate it with the Person annotation at the top of the stack

Specified by:

execute in interface Executable

Overrides:

execute in class AbstractProcessingResource

Throws:

ExecutionException

getResolvedAnaphora

public Map<Annotation,Annotation> getResolvedAnaphora()

---