PythonPr (Python 2.4 API)

java.lang.Object
- gate.util.AbstractFeatureBearer
- - gate.creole.AbstractResource
  - - gate.creole.AbstractProcessingResource
    - - gate.creole.AbstractLanguageAnalyser
      - gate.plugin.python.PythonPr

All Implemented Interfaces:

gate.creole.ANNIEConstants, gate.creole.ControllerAwarePR, gate.Executable, gate.LanguageAnalyser, PythonCodeDriven, gate.ProcessingResource, gate.Resource, gate.util.FeatureBearer, gate.util.NameBearer, Serializable
```
@CreoleResource(name="PythonPr",
                helpURL="http://gatenlp.github.io/gateplugin-Python/",
                comment="Use a Python program as a processing resource")
public class PythonPr
extends gate.creole.AbstractLanguageAnalyser
implements gate.creole.ControllerAwarePR, PythonCodeDriven
```
Processing resource for running a python program on a document. This allows to edit and run python code using the gatenlp python package on documents.

Author:

Johann Petrak

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`PythonPr.ExecuteResponse`
`protected static class`	`PythonPr.FinishResponse`
`static class`	`PythonPr.LoggingLevel` Possible python side logging level values.

Nested classes/interfaces inherited from class gate.creole.AbstractProcessingResource
gate.creole.AbstractProcessingResource.InternalStatusListener, gate.creole.AbstractProcessingResource.IntervalProgressListener

Field Summary

Fields
Modifier and Type	Field and Description
`protected URL`	`configFile`
`protected int`	`duplicateId`
`boolean`	`isCompileOk` Last syntax check status.
`protected Boolean`	`isConfigured`
`org.slf4j.Logger`	`logger` Our logger instance.
`protected PythonPr.LoggingLevel`	`loggingLevel`
`protected AtomicInteger`	`nrDuplicates`
`protected PythonPrResult`	`outputResultResource`
`protected gate.lib.interaction.process.pipes.Process4StringStream`	`process` This field contains the currently active process for the python program.
`protected gate.FeatureMap`	`programParams`
`protected String`	`pythonBinary`
`protected String`	`pythonBinaryCommand`
`protected URL`	`pythonBinaryUrl`
`protected gate.creole.ResourceReference`	`pythonProgram`
`protected File`	`pythonProgramFile`
`protected String`	`pythonProgramFileInJar`
`protected boolean`	`pythonProgramIsJar`
`protected boolean`	`pythonProgramIsReadonly`
`protected String`	`pythonProgramModuleInJar`
`protected String`	`pythonProgramPathInJar`
`protected URL`	`pythonProgramUrl`
`protected List<Object>`	`resultList`
`protected gate.gui.ResourceHelper`	`rhBdocApi`
`protected AtomicInteger`	`runningDuplicates`
`protected Set<String>`	`setsToUse`
`protected Boolean`	`usePluginGatenlpPackage`
`String`	`usePythonPackagePath` The python package path to use when running Python.

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

PythonPr()

Constructors
Constructor and Description
`PythonPr()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cleanup()` Cleanup resource.
`void`	`controllerExecutionAborted(gate.Controller controller, Throwable throwable)` Callback when running over a wholr corpus terminates with an exception.
`void`	`controllerExecutionFinished(gate.Controller controller)` Callback when running over a whole corpus finishes.
`void`	`controllerExecutionStarted(gate.Controller controller)` Callback when running over a whole corpus starts.
`static void`	`copyResource(String source, File targetPath)` Copy resource from plugin jar to target path.
`void`	`ensurePythonProgramCommand()` Make sure the python program command is set.
`void`	`execute()` Process document.
`void`	`figureOutPythonFile(URL pythonProgramUrl)` Figure out what kind of python file we use.
`URL`	`getConfigFile()` Get the config file URL.
`int`	`getDuplicateId()` Return the duplicate id of the PR instance.
`Boolean`	`getIsConfigured()`
`PythonPr.LoggingLevel`	`getLoggingLevel()` Get python logging level.
`AtomicInteger`	`getNrDuplicates()` Shared duplicates counter, getter.
`PythonPrResult`	`getOutputResultResource()` Result language resource, accessor.
`gate.FeatureMap`	`getProgramParams()` Get the program parameters.
`String`	`getPythonBinary()` Get the python interpreter command.
`URL`	`getPythonBinaryUrl()` Get the python interpreter file URL.
`static String`	`getPythonpathInZip()` Find the location of where the gatenlp package is in the jar or, for the tests, in the classes directory.
`gate.creole.ResourceReference`	`getPythonProgram()` Get the python program path parameter.
`File`	`getPythonProgramFile()` Return the python file or null if in JAR.
`String`	`getPythonProgramString()` Return the python program as String.
`URL`	`getPythonProgramUrl()` Return URL of the python program we determined.
`protected String`	`getResponseError(Map<String,Object> response)`
`List<Object>`	`getResultList()` Result list getter.
`AtomicInteger`	`getRunningDuplicates()` Return the value of the currently running duplicates counter.
`Set<String>`	`getSetsToUse()` Get which annotation set names to use.
`Boolean`	`getUsePluginGatenlpPackage()` Get the ownGatenlpPackage parameter value.
`gate.Resource`	`init()` Initialise resource.
`static boolean`	`isOsWindows()` Check if we are running on windows.
`static String[]`	`jarUrl2PythonPathAndModule(URL jarUrl)` Return the path and module from a JAR URL.
`protected String`	`makeExecuteRequest(gate.Document doc)` Create and return the JSON String representing an execute request.
`protected String`	`makeFinishRequest()`
`protected String`	`makeReduceRequest()`
`protected String`	`makeStartRequest()`
`boolean`	`pythonFileCanBeEdited()` Return flag indicating if the python file can be edited.
`void`	`registerEditorVR(PythonEditorVr vr)` Register the visual resource.
`void`	`reInit()` Re-initialize resource.
`static String`	`removeValidProtocols(String urlString)` Given a jar/file URL, remove the valid protocol parts.
`void`	`setConfigFile(URL value)` URL of a config file.
`void`	`setIsConfigured(Boolean value)`
`void`	`setLoggingLevel(PythonPr.LoggingLevel value)` Select log level on the python side.
`void`	`setNrDuplicates(AtomicInteger value)` Shared duplicates counter, setter.
`void`	`setOutputResultResource(PythonPrResult value)` Result language resource to store any corpus processing results.
`void`	`setProgramParams(gate.FeatureMap parms)` Set parameters to send to the python program.
`void`	`setPythonBinary(String value)` Set the python interpreter command name.
`void`	`setPythonBinaryUrl(URL value)` The file URL for a python interpreter to use.
`void`	`setPythonProgram(gate.creole.ResourceReference value)` Set the location of the python program.
`void`	`setResultList(List<Object> value)` Result list setter.
`void`	`setRunningDuplicates(AtomicInteger value)` Number of duplicates running on a corpus.
`void`	`setSetsToUse(Set<String> val)` Set the annotation set names to use.
`void`	`setUsePluginGatenlpPackage(Boolean value)` If we should use our own (the plugin's) copy of the Python gatenlp package.
`boolean`	`tryCompileProgram()` Rough check if the program can be compiled.
`protected void`	`whenFinishing()`
`protected void`	`whenStarting()` This will run whenever a corpus gets run.

Methods inherited from class gate.creole.AbstractLanguageAnalyser
getCorpus, getDocument, setCorpus, setDocument

Methods inherited from class gate.creole.AbstractProcessingResource
addProgressListener, addStatusListener, 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
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
  - pythonProgram
```
protected gate.creole.ResourceReference pythonProgram
```
  - configFile
```
protected URL configFile
```
  - pythonProgramIsJar
```
protected boolean pythonProgramIsJar
```
  - pythonProgramIsReadonly
```
protected boolean pythonProgramIsReadonly
```
  - pythonProgramFile
```
protected File pythonProgramFile
```
  - pythonProgramPathInJar
```
protected String pythonProgramPathInJar
```
  - pythonProgramModuleInJar
```
protected String pythonProgramModuleInJar
```
  - pythonProgramFileInJar
```
protected String pythonProgramFileInJar
```
  - pythonProgramUrl
```
protected URL pythonProgramUrl
```
  - programParams
```
protected gate.FeatureMap programParams
```
  - pythonBinary
```
protected String pythonBinary
```
  - pythonBinaryUrl
```
protected URL pythonBinaryUrl
```
  - pythonBinaryCommand
```
protected String pythonBinaryCommand
```
  - isConfigured
```
protected Boolean isConfigured
```
  - loggingLevel
```
protected PythonPr.LoggingLevel loggingLevel
```
  - usePluginGatenlpPackage
```
protected Boolean usePluginGatenlpPackage
```
  - outputResultResource
```
protected PythonPrResult outputResultResource
```
  - setsToUse
```
protected Set<String> setsToUse
```
  - process
```
protected transient gate.lib.interaction.process.pipes.Process4StringStream process
```
    This field contains the currently active process for the python program. Otherwise, the field should be null.
  - logger
```
public transient org.slf4j.Logger logger
```
    Our logger instance.
  - nrDuplicates
```
protected AtomicInteger nrDuplicates
```
  - resultList
```
protected List<Object> resultList
```
  - runningDuplicates
```
protected AtomicInteger runningDuplicates
```
  - duplicateId
```
protected int duplicateId
```
  - isCompileOk
```
public boolean isCompileOk
```
    Last syntax check status. Initially, this is true.
  - usePythonPackagePath
```
public String usePythonPackagePath
```
    The python package path to use when running Python. So that the gatenlp package is properly found.
  - rhBdocApi
```
protected gate.gui.ResourceHelper rhBdocApi
```
- Constructor Detail
  - PythonPr
```
public PythonPr()
```
- Method Detail
  - setPythonProgram
```
@Optional
 @CreoleParameter(comment="The (file or jar) URL of the Python program to run",
                 suffixes=".py")
public void setPythonProgram(gate.creole.ResourceReference value)
```
    Set the location of the python program. This parameter allows to set the location of the python program as either a file URL for files on a local disk or as an URL that points into the plugin's jar. If the URL points to a file in a JAR or a local file that is not writable, the file cannot be edited in the editor. If the local file does not exist, it gets created with a template content.
    
    Parameters:
    
    value - the URL pointing to the python file.
  - getPythonProgram
```
public gate.creole.ResourceReference getPythonProgram()
```
    Get the python program path parameter.
    
    Returns:
    
    the value of the parameter
  - setConfigFile
```
@Optional
 @RunTime
 @CreoleParameter(comment="The (file or jar) URL of the Python program to run")
public void setConfigFile(URL value)
```
    URL of a config file. The absolute path to the config file gets passed to the python start method as _config_file kw parameter.
    
    Parameters:
    
    value - the config file URL
  - getConfigFile
```
public URL getConfigFile()
```
    Get the config file URL.
    
    Returns:
    
    config file URL
  - setProgramParams
```
@Optional
 @RunTime
 @CreoleParameter(comment="Extra parameters to pass on to the Python program")
public void setProgramParams(gate.FeatureMap parms)
```
    Set parameters to send to the python program. The given parameters are passed on to all python functions as kwargs. This expects a FeatureMap because we have a GUI for that but it should really be a map with String keys and values which can be serialized as JSON.
    
    Parameters:
    
    parms - a FeatureMap of parameters
  - getProgramParams
```
public gate.FeatureMap getProgramParams()
```
    Get the program parameters.
    
    Returns:
    
    program parameters
  - setPythonBinary
```
@Optional
 @RunTime
 @CreoleParameter(comment="Python interpreter name (on system PATH)",
                 disjunction="pythonbin",
                 priority=1,
                 defaultValue="python")
public void setPythonBinary(String value)
```
    Set the python interpreter command name. This expects the name of the python interpreter as it can be found on the binary path. This must be a python version 3 interpreter!
    
    Parameters:
    
    value - the python interpreter command
  - getPythonBinary
```
public String getPythonBinary()
```
    Get the python interpreter command.
    
    Returns:
    
    python interpreter command
  - setPythonBinaryUrl
```
@Optional
 @RunTime
 @CreoleParameter(comment="Python interpreter file URL. If provided overrides pythonBinary.",
                 priority=10,
                 disjunction="pythonbin")
public void setPythonBinaryUrl(URL value)
```
    The file URL for a python interpreter to use. This can be used as an alternative to the pythonBinary parameter and runs the specified file as a python interpreter.
    
    Parameters:
    
    value - python interpreter program file
  - getPythonBinaryUrl
```
public URL getPythonBinaryUrl()
```
    Get the python interpreter file URL.
    
    Returns:
    
    python interpreter URL
  - setIsConfigured
```
@CreoleParameter(defaultValue="false")
 @HiddenCreoleParameter
public void setIsConfigured(Boolean value)
```
  - getIsConfigured
```
public Boolean getIsConfigured()
```
  - setLoggingLevel
```
@Optional
 @RunTime
 @CreoleParameter(comment="Logging level to use on the python side",
                 defaultValue="INFO")
public void setLoggingLevel(PythonPr.LoggingLevel value)
```
    Select log level on the python side.
    
    Parameters:
    
    value - one of the LoggingLevel enum values
  - getLoggingLevel
```
public PythonPr.LoggingLevel getLoggingLevel()
```
    Get python logging level.
    
    Returns:
    
    logging level.
  - setUsePluginGatenlpPackage
```
@Optional
 @RunTime
 @CreoleParameter(comment="Use Python gatenlp package included in the plugin, not the system one.",
                 defaultValue="true")
public void setUsePluginGatenlpPackage(Boolean value)
```
    If we should use our own (the plugin's) copy of the Python gatenlp package. If this is true (the default), the specific version of gatenlp that is included in the plugin will be used, otherwise, the version installed for the python environment is used.
    
    Parameters:
    
    value - Flag inidicating if own gatenlp package should be used
  - getUsePluginGatenlpPackage
```
public Boolean getUsePluginGatenlpPackage()
```
    Get the ownGatenlpPackage parameter value.
    
    Returns:
    
    value of the parameter
  - setOutputResultResource
```
@Optional
 @RunTime
 @CreoleParameter(comment="Result object.")
public void setOutputResultResource(PythonPrResult value)
```
    Result language resource to store any corpus processing results.
    
    Parameters:
    
    value - a PythonPrResult language resource
  - getOutputResultResource
```
public PythonPrResult getOutputResultResource()
```
    Result language resource, accessor.
    
    Returns:
    
    the result resource
  - setSetsToUse
```
@Optional
 @RunTime
 @CreoleParameter(comment="Annotation set names to send and use in Python, *=all, null/space=default set",
                 defaultValue="*")
public void setSetsToUse(Set<String> val)
```
    Set the annotation set names to use. If the special name "*" is included in the set, all sets are used. Otherwise only sets with the given names are included. To include the default annotation set add a null value or a value that only consists of spaces.
    
    Parameters:
    
    val - the set of set names to use.
  - getSetsToUse
```
public Set<String> getSetsToUse()
```
    Get which annotation set names to use.
    
    Returns:
    
    set of set names.
  - setNrDuplicates
```
@Sharable
public void setNrDuplicates(AtomicInteger value)
```
    Shared duplicates counter, setter.
    
    Parameters:
    
    value - the counter
  - getNrDuplicates
```
public AtomicInteger getNrDuplicates()
```
    Shared duplicates counter, getter.
    
    Returns:
    
    the counter
  - setResultList
```
@Sharable
public void setResultList(List<Object> value)
```
    Result list setter.
    
    Parameters:
    
    value - should be a synchronized list
  - getResultList
```
public List<Object> getResultList()
```
    Result list getter.
    
    Returns:
    
    the list
  - setRunningDuplicates
```
@Sharable
public void setRunningDuplicates(AtomicInteger value)
```
    Number of duplicates running on a corpus. This gets incremented for each duplicate that receives a controllerExecutionStarted callback and decremented for each duplicate that receives a controllerExecutionFinished or controllerExecutionAborted callback.
    
    Parameters:
    
    value - the value
  - getRunningDuplicates
```
public AtomicInteger getRunningDuplicates()
```
    Return the value of the currently running duplicates counter.
    
    Returns:
    
    number of running duplicates.
  - getDuplicateId
```
public int getDuplicateId()
```
    Return the duplicate id of the PR instance. When this PR gets duplicated, each instance will have its own duplicate ID set, with the very first instance having id 0.
    
    Returns:
    
    the duplicate id of the PR.
  - ensurePythonProgramCommand
```
public void ensurePythonProgramCommand()
```
    Make sure the python program command is set. Or we complain about missing parameters.
  - figureOutPythonFile
```
public void figureOutPythonFile(URL pythonProgramUrl)
```
    Figure out what kind of python file we use. We allow two kinds of locations: on the local file system, i.e. a file: URL, and from within a JAR. This program determines which of those we have and sets the fields pythonProgramXXXX.
    
    Parameters:
    
    pythonProgramUrl - python progrsam url
  - pythonFileCanBeEdited
```
public boolean pythonFileCanBeEdited()
```
    Return flag indicating if the python file can be edited.
    
    Returns:
    
    true if it can be edited
  - getPythonProgramUrl
```
public URL getPythonProgramUrl()
```
    Return URL of the python program we determined.
    
    Returns:
    
    python program URL
  - getPythonProgramString
```
public String getPythonProgramString()
```
    Return the python program as String.
    
    Returns:
    
    python program as String
  - getPythonProgramFile
```
public File getPythonProgramFile()
```
    Return the python file or null if in JAR.
    
    Returns:
    
    file or null
  - tryCompileProgram
```
public boolean tryCompileProgram()
```
    Rough check if the program can be compiled. This invokes the program with the --mode check parameters to check for syntax errors, import erros and anything that will be detected without actually running the class and interchaning data.
    The python program is run as a normal program if it is a normal file, if it is in the jar, it gets invoked by loading it as a library.
    
    Returns:
    
    true if compilation went ok, false otherwise
  - registerEditorVR
```
public void registerEditorVR(PythonEditorVr vr)
```
    Register the visual resource. This gets called by the visual resource as part of the code that is run when setTarget is invoked. If setTarget finds out we should not have VR in the first place, it does not call back and our registeredEditorVR remains null.
    
    Parameters:
    
    vr - visual resource
  - jarUrl2PythonPathAndModule
```
public static String[] jarUrl2PythonPathAndModule(URL jarUrl)
```
    Return the path and module from a JAR URL.
    
    Parameters:
    
    jarUrl - expected to point to a python file inside a jar
    
    Returns:
    
    array with two elements, the pythonpath and the module name
  - removeValidProtocols
```
public static String removeValidProtocols(String urlString)
```
    Given a jar/file URL, remove the valid protocol parts.
    
    Parameters:
    
    urlString - the URL string
    
    Returns:
    
    url string with protocols removed
  - getPythonpathInZip
```
public static String getPythonpathInZip()
```
    Find the location of where the gatenlp package is in the jar or, for the tests, in the classes directory. This returns the absolute path we need to specify in the PYTHONPATH environment variable in order to put the included gatenlp package on the python path. This first figures out which location our own class got loaded from which is either the plugin JAR or the classes directory during building and testing. Then converts any of these locations into the full path needed for python to find the directory, ither as a zip import or from the ordinary file system.
    
    Returns:
    
    location of containing folder
  - init
```
public gate.Resource init()
                   throws gate.creole.ResourceInstantiationException
```
    Initialise resource.
    
    Specified by:
    
    init in interface gate.Resource
    
    Overrides:
    
    init in class gate.creole.AbstractProcessingResource
    
    Returns:
    
    resource the PR instance
    
    Throws:
    
    gate.creole.ResourceInstantiationException - could not initialise
  - whenStarting
```
protected void whenStarting()
```
    This will run whenever a corpus gets run. We start the python process for every new run on a corpus and stop it when the corpus is finished.
  - whenFinishing
```
protected void whenFinishing()
```
  - reInit
```
public void reInit()
            throws gate.creole.ResourceInstantiationException
```
    Re-initialize resource.
    
    Specified by:
    
    reInit in interface gate.ProcessingResource
    
    Overrides:
    
    reInit in class gate.creole.AbstractProcessingResource
    
    Throws:
    
    gate.creole.ResourceInstantiationException - exception if initialisation fails
  - cleanup
```
public void cleanup()
```
    Cleanup resource.
    
    Specified by:
    
    cleanup in interface gate.Resource
    
    Overrides:
    
    cleanup in class gate.creole.AbstractProcessingResource
  - execute
```
public void execute()
             throws gate.creole.ExecutionException
```
    Process document.
    
    Specified by:
    
    execute in interface gate.Executable
    
    Overrides:
    
    execute in class gate.creole.AbstractProcessingResource
    
    Throws:
    
    gate.creole.ExecutionException - exception when processing fails
  - controllerExecutionStarted
```
public void controllerExecutionStarted(gate.Controller controller)
```
    Callback when running over a whole corpus starts.
    
    Specified by:
    
    controllerExecutionStarted in interface gate.creole.ControllerAwarePR
    
    Parameters:
    
    controller - the controller used
  - controllerExecutionFinished
```
public void controllerExecutionFinished(gate.Controller controller)
```
    Callback when running over a whole corpus finishes.
    
    Specified by:
    
    controllerExecutionFinished in interface gate.creole.ControllerAwarePR
    
    Parameters:
    
    controller - the controller used
  - controllerExecutionAborted
```
public void controllerExecutionAborted(gate.Controller controller,
                                       Throwable throwable)
```
    Callback when running over a wholr corpus terminates with an exception.
    
    Specified by:
    
    controllerExecutionAborted in interface gate.creole.ControllerAwarePR
    
    Parameters:
    
    controller - the controller used
    
    throwable - the throwable from the exception
  - getResponseError
```
protected String getResponseError(Map<String,Object> response)
```
  - makeExecuteRequest
```
protected String makeExecuteRequest(gate.Document doc)
```
    Create and return the JSON String representing an execute request.
    
    Parameters:
    
    doc - the document to send over
    
    Returns:
    
    JSON string
  - makeStartRequest
```
protected String makeStartRequest()
```
  - makeFinishRequest
```
protected String makeFinishRequest()
```
  - makeReduceRequest
```
protected String makeReduceRequest()
```
  - copyResource
```
public static void copyResource(String source,
                                File targetPath)
```
    Copy resource from plugin jar to target path. NOTE: normally this copies from whatever JAR file the creole.xml for this PR is in, but when running the gapploading test, the creole.xml is in the target classes directory instead and we then need to copy in a different way.
    
    Parameters:
    
    source - the path of the resource to copy
    
    targetPath - where to copy to, must not already exist
  - isOsWindows
```
public static boolean isOsWindows()
```
    Check if we are running on windows.
    
    Returns:
    
    true if on Windows, false otherwise

Class PythonPr

Nested Class Summary

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

Field Summary

Fields inherited from class gate.creole.AbstractLanguageAnalyser

Fields inherited from class gate.creole.AbstractProcessingResource

Fields inherited from class gate.creole.AbstractResource

Fields inherited from class gate.util.AbstractFeatureBearer

Fields inherited from interface gate.creole.ANNIEConstants

Constructor Summary

Method Summary

Methods inherited from class gate.creole.AbstractLanguageAnalyser

Methods inherited from class gate.creole.AbstractProcessingResource

Methods inherited from class gate.creole.AbstractResource

Methods inherited from class gate.util.AbstractFeatureBearer

Methods inherited from class java.lang.Object

Methods inherited from interface gate.Resource

Methods inherited from interface gate.util.FeatureBearer

Methods inherited from interface gate.util.NameBearer

Methods inherited from interface gate.Executable

Field Detail

pythonProgram

configFile

pythonProgramIsJar

pythonProgramIsReadonly

pythonProgramFile

pythonProgramPathInJar

pythonProgramModuleInJar

pythonProgramFileInJar

pythonProgramUrl

programParams

pythonBinary

pythonBinaryUrl

pythonBinaryCommand

isConfigured

loggingLevel

usePluginGatenlpPackage

outputResultResource

setsToUse

process

logger

nrDuplicates

resultList

runningDuplicates

duplicateId

isCompileOk

usePythonPackagePath

rhBdocApi

Constructor Detail

PythonPr

Method Detail

setPythonProgram

getPythonProgram

setConfigFile

getConfigFile

setProgramParams

getProgramParams

setPythonBinary

getPythonBinary

setPythonBinaryUrl

getPythonBinaryUrl

setIsConfigured

getIsConfigured

setLoggingLevel

getLoggingLevel

setUsePluginGatenlpPackage

getUsePluginGatenlpPackage

setOutputResultResource

getOutputResultResource

setSetsToUse

getSetsToUse

setNrDuplicates

getNrDuplicates

setResultList

getResultList

setRunningDuplicates

getRunningDuplicates

getDuplicateId

ensurePythonProgramCommand

figureOutPythonFile