at.ofai.gate.scripting
Class PRScripting

java.lang.Object
  extended by gate.util.AbstractFeatureBearer
      extended by gate.creole.AbstractResource
          extended by gate.creole.AbstractProcessingResource
              extended by gate.creole.AbstractLanguageAnalyser
                  extended by at.ofai.gate.scripting.PRScripting
All Implemented Interfaces:
gate.creole.ANNIEConstants, gate.creole.ControllerAwarePR, gate.Executable, gate.LanguageAnalyser, gate.ProcessingResource, gate.Resource, gate.util.FeatureBearer, gate.util.NameBearer, java.io.Serializable
Direct Known Subclasses:
PRScriptingGroovy, PRScriptingJavascript, PRScriptingJRuby

public class PRScripting
extends gate.creole.AbstractLanguageAnalyser
implements gate.creole.ControllerAwarePR

Common superclass for using a script as a PR.

Author:
Johann Petrak
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class gate.creole.AbstractProcessingResource
gate.creole.AbstractProcessingResource.InternalStatusListener, gate.creole.AbstractProcessingResource.IntervalProgressListener
 
Field Summary
protected  java.lang.String callProcessDocument
           
protected  java.lang.String callShutdownCorpus
           
protected  java.lang.String callStartupCorpus
           
protected  javax.script.ScriptEngine scriptEngine
           
protected  java.net.URL scriptFileURL
           
protected  java.lang.String scriptLanguage
           
 
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_INSTANCE_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
PRScripting()
           
 
Method Summary
 void controllerExecutionAborted(gate.Controller c, java.lang.Throwable t)
           
 void controllerExecutionFinished(gate.Controller c)
           
 void controllerExecutionStarted(gate.Controller c)
           
 void execute()
          Run the processDocument() function/method of the script on a document
 java.net.URL getScriptFileURL()
           
protected  void initEngine()
           
 void setScriptFileURL(java.net.URL scriptFileURL)
           
 
Methods inherited from class gate.creole.AbstractLanguageAnalyser
getCorpus, getDocument, setCorpus, setDocument
 
Methods inherited from class gate.creole.AbstractProcessingResource
addProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, init, 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, init, 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

scriptFileURL

protected java.net.URL scriptFileURL

scriptLanguage

protected java.lang.String scriptLanguage

scriptEngine

protected javax.script.ScriptEngine scriptEngine

callStartupCorpus

protected java.lang.String callStartupCorpus

callShutdownCorpus

protected java.lang.String callShutdownCorpus

callProcessDocument

protected java.lang.String callProcessDocument
Constructor Detail

PRScripting

public PRScripting()
Method Detail

setScriptFileURL

public void setScriptFileURL(java.net.URL scriptFileURL)

getScriptFileURL

public java.net.URL getScriptFileURL()

controllerExecutionStarted

public void controllerExecutionStarted(gate.Controller c)
                                throws gate.creole.ExecutionException
Specified by:
controllerExecutionStarted in interface gate.creole.ControllerAwarePR
Throws:
gate.creole.ExecutionException

controllerExecutionFinished

public void controllerExecutionFinished(gate.Controller c)
                                 throws gate.creole.ExecutionException
Specified by:
controllerExecutionFinished in interface gate.creole.ControllerAwarePR
Throws:
gate.creole.ExecutionException

controllerExecutionAborted

public void controllerExecutionAborted(gate.Controller c,
                                       java.lang.Throwable t)
                                throws gate.creole.ExecutionException
Specified by:
controllerExecutionAborted in interface gate.creole.ControllerAwarePR
Throws:
gate.creole.ExecutionException

initEngine

protected void initEngine()
                   throws gate.creole.ResourceInstantiationException
Throws:
gate.creole.ResourceInstantiationException

execute

public void execute()
             throws gate.creole.ExecutionException
Run the processDocument() function/method of the script on a document

Specified by:
execute in interface gate.Executable
Overrides:
execute in class gate.creole.AbstractProcessingResource
Throws:
gate.creole.ExecutionException