gate.creole
Class Transducer

java.lang.Object
  gate.util.AbstractFeatureBearer
      gate.creole.AbstractResource
          gate.creole.AbstractProcessingResource
              gate.creole.AbstractLanguageAnalyser
                  gate.creole.Transducer

All Implemented Interfaces:

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

Direct Known Subclasses:

ANNIETransducer, OntologyAwareTransducer, VPChunker

public class Transducer
extends AbstractLanguageAnalyser
implements ActionsPublisher

A cascaded multi-phase transducer using the Jape language which is a variant of the CPSL language.

See Also:

Serialized Form

Nested Class Summary

protected class

Transducer.SerializeTransducerAction Saves the Jape Transuder to the binary file.

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

AbstractProcessingResource.InternalStatusListener, AbstractProcessingResource.IntervalProgressListener

Field Summary

protected List	actionList
protected Batch	batch The actual JapeTransducer used for processing the document(s).
protected URL	binaryGrammarURL The URL to the serialized jape file used as grammar by this transducer.
protected Boolean	enableDebugging A switch used to activate the JAPE debugger.
protected String	encoding The encoding used for reding the grammar file(s).
protected URL	grammarURL The URL to the jape file used as grammar by this transducer.
protected String	inputASName The AnnotationSet used as input for the transducer.
protected Ontology	ontology The ontology that will be available on the RHS of JAPE rules.
protected String	outputASName The AnnotationSet used as output by the transducer.
static String	TRANSD_BINARY_GRAMMAR_URL_PARAMETER_NAME
static String	TRANSD_DOCUMENT_PARAMETER_NAME
static String	TRANSD_ENCODING_PARAMETER_NAME
static String	TRANSD_GRAMMAR_URL_PARAMETER_NAME
static String	TRANSD_INPUT_AS_PARAMETER_NAME
static String	TRANSD_OUTPUT_AS_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, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_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, 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

Transducer()
Default constructor.

Method Summary

void	execute() Implementation of the run() method from Runnable.
List	getActions() Gets the list of actions that can be performed on this resource.
URL	getBinaryGrammarURL()
Boolean	getEnableDebugging()
String	getEncoding() Gets the encoding used for reding the grammar file(s).
URL	getGrammarURL() Gets the URL to the grammar used to build this transducer.
String	getInputASName() Gets the AnnotationSet used as input by this transducer.
Ontology	getOntology() Gets the ontology used by this transducer.
String	getOutputASName() Gets the AnnotationSet used as output by this transducer.
Resource	init() This method is the one responsible for initialising the transducer.
void	interrupt() Notifies all the PRs in this controller that they should stop their execution as soon as possible.
void	setBinaryGrammarURL(URL binaryGrammarURL)
void	setEnableDebugging(Boolean enableDebugging)
void	setEncoding(String newEncoding) Sets the encoding to be used for reding the input file(s) forming the Jape grammar.
void	setGrammarURL(URL newGrammarURL) Sets the grammar to be used for building this transducer.
void	setInputASName(String newInputASName) Sets the AnnotationSet to be used as input for the transducer.
void	setOntology(Ontology ontology) Sets the ontology used by this transducer.
void	setOutputASName(String newOutputASName) Sets the AnnotationSet to be used as output by the transducer.

Methods inherited from class gate.creole.AbstractLanguageAnalyser

getCorpus, getDocument, setCorpus, setDocument

Methods inherited from class gate.creole.AbstractProcessingResource

addProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, 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

isInterrupted

Field Detail

TRANSD_DOCUMENT_PARAMETER_NAME

public static final String TRANSD_DOCUMENT_PARAMETER_NAME

See Also:

Constant Field Values

TRANSD_INPUT_AS_PARAMETER_NAME

public static final String TRANSD_INPUT_AS_PARAMETER_NAME

See Also:

Constant Field Values

TRANSD_OUTPUT_AS_PARAMETER_NAME

public static final String TRANSD_OUTPUT_AS_PARAMETER_NAME

See Also:

Constant Field Values

TRANSD_ENCODING_PARAMETER_NAME

public static final String TRANSD_ENCODING_PARAMETER_NAME

See Also:

Constant Field Values

TRANSD_GRAMMAR_URL_PARAMETER_NAME

public static final String TRANSD_GRAMMAR_URL_PARAMETER_NAME

See Also:

Constant Field Values

TRANSD_BINARY_GRAMMAR_URL_PARAMETER_NAME

public static final String TRANSD_BINARY_GRAMMAR_URL_PARAMETER_NAME

See Also:

Constant Field Values

actionList

protected List actionList

grammarURL

protected URL grammarURL

The URL to the jape file used as grammar by this transducer.

binaryGrammarURL

protected URL binaryGrammarURL

The URL to the serialized jape file used as grammar by this transducer.

batch

protected Batch batch

The actual JapeTransducer used for processing the document(s).

encoding

protected String encoding

The encoding used for reding the grammar file(s).

inputASName

protected String inputASName

The AnnotationSet used as input for the transducer.

outputASName

protected String outputASName

The AnnotationSet used as output by the transducer.

ontology

protected Ontology ontology

The ontology that will be available on the RHS of JAPE rules.

enableDebugging

protected Boolean enableDebugging

A switch used to activate the JAPE debugger.

Constructor Detail

Transducer

public Transducer()

Default constructor. Does nothing apart from calling the default constructor from the super class. The actual object initialisation is done via the init() method.

Method Detail

init

public Resource init()
              throws ResourceInstantiationException

This method is the one responsible for initialising the transducer. It assumes that all the needed parameters have been already set using the appropiate setXXX() methods.

Specified by:

init in interface Resource

Overrides:

init in class AbstractProcessingResource

Returns:

a reference to this

Throws:

ResourceInstantiationException

execute

public void execute()
             throws ExecutionException

Implementation of the run() method from Runnable. This method is responsible for doing all the processing of the input document.

Specified by:

execute in interface Executable

Overrides:

execute in class AbstractProcessingResource

Throws:

ExecutionException

getActions

public List getActions()

Gets the list of actions that can be performed on this resource.

Specified by:

getActions in interface ActionsPublisher

Returns:

a List of Action objects (or null values)

interrupt

public void interrupt()

Notifies all the PRs in this controller that they should stop their execution as soon as possible.

Specified by:

interrupt in interface Executable

Overrides:

interrupt in class AbstractProcessingResource

setGrammarURL

public void setGrammarURL(URL newGrammarURL)

Sets the grammar to be used for building this transducer.

Parameters:

newGrammarURL - an URL to a file containing a Jape grammar.

getGrammarURL

public URL getGrammarURL()

Gets the URL to the grammar used to build this transducer.

Returns:

a URL pointing to the grammar file.

setEncoding

public void setEncoding(String newEncoding)

Sets the encoding to be used for reding the input file(s) forming the Jape grammar. Note that if the input grammar is a multi-file one than the same encoding will be used for reding all the files. Multi file grammars with different encoding across the composing files are not supported!

Parameters:

newEncoding - a {link String} representing the encoding.

getEncoding

public String getEncoding()

Gets the encoding used for reding the grammar file(s).

setInputASName

public void setInputASName(String newInputASName)

Sets the AnnotationSet to be used as input for the transducer.

Parameters:

newInputASName - a AnnotationSet

getInputASName

public String getInputASName()

Gets the AnnotationSet used as input by this transducer.

Returns:

a AnnotationSet

setOutputASName

public void setOutputASName(String newOutputASName)

Sets the AnnotationSet to be used as output by the transducer.

Parameters:

newOutputASName - a AnnotationSet

getOutputASName

public String getOutputASName()

Gets the AnnotationSet used as output by this transducer.

Returns:

a AnnotationSet

getEnableDebugging

public Boolean getEnableDebugging()

setEnableDebugging

public void setEnableDebugging(Boolean enableDebugging)

getOntology

public Ontology getOntology()

Gets the ontology used by this transducer.

Returns:

an Ontology value.

setOntology

public void setOntology(Ontology ontology)

Sets the ontology used by this transducer.

Parameters:

ontology - an Ontology value.

getBinaryGrammarURL

public URL getBinaryGrammarURL()

setBinaryGrammarURL

public void setBinaryGrammarURL(URL binaryGrammarURL)