gate.plugin.python

Class PythonSlave

java.lang.Object

gate.plugin.python.PythonSlave

public class PythonSlave
extends Object

Run Java/GATE from python through this class.

Author:

Johann Petrak

Field Summary

Fields

Modifier and Type	Field and Description
boolean	keepRunning Indicate if the slave should be kept running.
boolean	logActions If we want to log all commands.
org.slf4j.Logger	LOGGER Logger
protected gate.gui.ResourceHelper	rhBdocApi
protected py4j.GatewayServer	server

Constructor Summary

Constructors

Constructor and Description
PythonSlave() Create an instance.

Method Summary

Modifier and Type	Method and Description
gate.Document	createDocument(String content) Create a new document from the text.
void	deleteResource(gate.Resource res) Delete a GATE resource and release memory.
gate.creole.Plugin.Maven	findMavenPlugin(String group, String artifact) Find and return a loaded Maven plugin instance.
String	gate_build() Return build (short commit id) of GATE.
String	gate_version() Return version of GATE.
String	getBdocJson(gate.Document doc) Get the JSON serialization of the Bdoc representation of a document.
gate.Corpus	getCorpus4Name(String name) Return the corpus with the given name.
List<String>	getCorpusNames() Return list of all known corpus names.
gate.Document	getDocument4BdocJson(String bdocjson) Create a new GATE document from the Bdoc JSON serialization.
gate.Document	getDocument4Name(String name) Return the document with the given name.
List<String>	getDocumentNames() Return list of all known document names.
gate.CorpusController	getPipeline4Name(String name) Return the pipeline with the given name.
List<String>	getPipelineNames() Return list of all known pipeline names.
gate.ProcessingResource	getPr4Name(String name) Return the processing resource with the given name.
List<String>	getPrNames() Return list of all known processing resource names.
List<gate.Resource>	getResources4Name(String name) Return a list of all resources with the given name.
List<gate.Resource>	getResources4Name(String name, String clazz) Return a list of all resources with the given name and class.
boolean	isClosable() Check if the slave is closable.
String	jsonAnnsets4Doc(gate.Document doc)
String	jsonAnnsets4Doc(gate.Document doc, List<List<String>> annsets)
void	kill() Kill the slave.
gate.Document	loadDocumentFromFile(String path) Load document from the file.
gate.Document	loadDocumentFromFile(String path, String mimeType) Load document from the file, using mime type
void	loadMavenPlugin(String group, String artifact, String version) Load a maven plugin.
gate.CorpusController	loadPipelineFromFile(String path) Load a pipeline from a file.
gate.CorpusController	loadPipelineFromPlugin(String group, String artifact, String path) Load a pipeline from the maven plugin resources.
void	logActions(boolean flag) Enable or disable logging the actions.
gate.Corpus	newCorpus() Create a new corpus.
String	pluginBuild() Return build (short commit id) of Python plugin.
String	pluginVersion() Return version of the Python plugin.
void	print2err(String txt) Copy string to standard error.
void	print2out(String txt) Copy string to standard output.
void	run4Corpus(gate.CorpusController pipeline, gate.Corpus corpus) Run the pipeline on the given corpus.
void	run4Document(gate.CorpusController pipeline, gate.Document doc) Run a pipeline for a single document.
void	runExecutionFinished(gate.CorpusController pipeline) Invoke the controller execution finished code.
void	runExecutionStarted(gate.CorpusController pipeline) Invoke the controller execution started code.
void	saveDocumentToFile(gate.Document doc, String path, String mimetype) Save document to a file.
void	showGui() Activate the GUI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

public final transient org.slf4j.Logger LOGGER

Logger

server

protected py4j.GatewayServer server

logActions

public boolean logActions

If we want to log all commands.

keepRunning

public boolean keepRunning

Indicate if the slave should be kept running. This is the case if it was started by the PythonSlaveLr or if the slave running does not clear this.

rhBdocApi

protected gate.gui.ResourceHelper rhBdocApi

Constructor Detail

PythonSlave

public PythonSlave()
            throws gate.creole.ResourceInstantiationException

Create an instance.

Throws:

gate.creole.ResourceInstantiationException - error

Method Detail

loadMavenPlugin

public void loadMavenPlugin(String group,
                            String artifact,
                            String version)
                     throws gate.util.GateException

Load a maven plugin.

Parameters:

group - maven group

artifact - maven artifact

version - maven version

Throws:

gate.util.GateException - if error

loadPipelineFromFile

public gate.CorpusController loadPipelineFromFile(String path)

Load a pipeline from a file.

Parameters:

path - gapp/xgapp file

Returns:

the corpus controller

findMavenPlugin

public gate.creole.Plugin.Maven findMavenPlugin(String group,
                                                String artifact)

Find and return a loaded Maven plugin instance.

Parameters:

group - plugin group

artifact - plugin artifact

Returns:

the plugin instance or null of nothing found

loadPipelineFromPlugin

public gate.CorpusController loadPipelineFromPlugin(String group,
                                                    String artifact,
                                                    String path)
                                             throws URISyntaxException

Load a pipeline from the maven plugin resources. Example: "uk.ac.gate.plugins", "annie", "/resources/ANNIE_with_defaults.gapp"

Parameters:

group - the plugin group

artifact - the plugin artifact

path - the path in the plugin resources

Returns:

controller

Throws:

URISyntaxException - exception

loadDocumentFromFile

public gate.Document loadDocumentFromFile(String path)

Load document from the file. This will load the document in the same way as if only the document URL had been specified in the GUI, if a document format is registered for the extension, it is used.

Parameters:

path - file path of the document to load

Returns:

document

createDocument

public gate.Document createDocument(String content)

Create a new document from the text.

Parameters:

content - the document content

Returns:

the document

newCorpus

public gate.Corpus newCorpus()

Create a new corpus.

Returns:

corpus

deleteResource

public void deleteResource(gate.Resource res)

Delete a GATE resource and release memory.

Parameters:

res - the resource to remove

run4Document

public void run4Document(gate.CorpusController pipeline,
                         gate.Document doc)

Run a pipeline for a single document.

Parameters:

pipeline - the pipeline to run

doc - the document to process

runExecutionStarted

public void runExecutionStarted(gate.CorpusController pipeline)

Invoke the controller execution started code. This should be run before documents are run individually using the run4doc method.

Parameters:

pipeline - pipeline

runExecutionFinished

public void runExecutionFinished(gate.CorpusController pipeline)

Invoke the controller execution finished code. This should be run after all documents are run individually using the run4doc method.

Parameters:

pipeline - pipeline

run4Corpus

public void run4Corpus(gate.CorpusController pipeline,
                       gate.Corpus corpus)

Run the pipeline on the given corpus.

Parameters:

pipeline - the pipeline

corpus - the corpus

loadDocumentFromFile

public gate.Document loadDocumentFromFile(String path,
                                          String mimeType)

Load document from the file, using mime type

Parameters:

path - file

mimeType - mime type

Returns:

document

saveDocumentToFile

public void saveDocumentToFile(gate.Document doc,
                               String path,
                               String mimetype)
                        throws IOException,
                               XMLStreamException

Save document to a file. NOTE: currently there is no way in GATE to register a document format for saving a document with a specific mime type.So this function currently only recognizes a few hard-coded mime types and rejects all others. The mime types are: "" (empty string) for the default GATE xml serialization; all mime types supported by the Format_Bdoc plugin and all mime types supported by the Format_FastInfoset plugin. NOTE: for fastinfoset the plugin must first have been loaded with loadMavenPlugin("uk.ac.gate.plugins","format-fastinfoset","8.5") or whatever the wanted version is.

Parameters:

path - file

mimetype - mime type

Throws:

IOException - if something goes wrong saving

XMLStreamException - if something goes wrong when saving

getBdocJson

public String getBdocJson(gate.Document doc)

Get the JSON serialization of the Bdoc representation of a document.

Parameters:

doc - document

Returns:

json

getDocument4BdocJson

public gate.Document getDocument4BdocJson(String bdocjson)
                                   throws gate.creole.ResourceInstantiationException

Create a new GATE document from the Bdoc JSON serialization.

Parameters:

bdocjson - the JSON

Returns:

a new GATE document built from the bdoc json

Throws:

gate.creole.ResourceInstantiationException - should never occur

print2out

public void print2out(String txt)

Copy string to standard output. Note: no new line character is appended.

Parameters:

txt - the string to copy

print2err

public void print2err(String txt)

Copy string to standard error. Note: no new line character is appended.

Parameters:

txt - the string to copy

showGui

public void showGui()

Activate the GUI. Caution: experimental!

getResources4Name

public List<gate.Resource> getResources4Name(String name)
                                      throws gate.util.GateException

Return a list of all resources with the given name.

Parameters:

name - resource name

Returns:

list of matching resources

Throws:

gate.util.GateException

getResources4Name

public List<gate.Resource> getResources4Name(String name,
                                             String clazz)
                                      throws gate.util.GateException

Return a list of all resources with the given name and class.

Parameters:

name - resource name

clazz - resource class name

Returns:

list of matching resources

Throws:

gate.util.GateException

getDocument4Name

public gate.Document getDocument4Name(String name)
                               throws gate.util.GateException

Return the document with the given name. If there are more than one, return an arbitrary one of those.

Parameters:

name - the document name

Returns:

document matching the name

Throws:

gate.util.GateException

getCorpus4Name

public gate.Corpus getCorpus4Name(String name)
                           throws gate.util.GateException

Return the corpus with the given name. If there are more than one, return an arbitrary one of those.

Parameters:

name - the corpus name

Returns:

corpus matching the name

Throws:

gate.util.GateException

getPipeline4Name

public gate.CorpusController getPipeline4Name(String name)
                                       throws gate.util.GateException

Return the pipeline with the given name. If there are more than one, return an arbitrary one of those.

Parameters:

name - the pipeline name

Returns:

pipeline matching the name

Throws:

gate.util.GateException

getPr4Name

public gate.ProcessingResource getPr4Name(String name)
                                   throws gate.util.GateException

Return the processing resource with the given name. If there are more than one, return an arbitrary one of those.

Parameters:

name - the pr name

Returns:

pr matching the name

Throws:

gate.util.GateException

getDocumentNames

public List<String> getDocumentNames()
                              throws gate.util.GateException

Return list of all known document names.

Returns:

list of names

Throws:

gate.util.GateException

getCorpusNames

public List<String> getCorpusNames()
                            throws gate.util.GateException

Return list of all known corpus names.

Returns:

list of names

Throws:

gate.util.GateException

getPipelineNames

public List<String> getPipelineNames()
                              throws gate.util.GateException

Return list of all known pipeline names.

Returns:

list of names

Throws:

gate.util.GateException

getPrNames

public List<String> getPrNames()
                        throws gate.util.GateException

Return list of all known processing resource names.

Returns:

list of names

Throws:

gate.util.GateException

jsonAnnsets4Doc

public String jsonAnnsets4Doc(gate.Document doc,
                              List<List<String>> annsets)

jsonAnnsets4Doc

public String jsonAnnsets4Doc(gate.Document doc)

logActions

public void logActions(boolean flag)

Enable or disable logging the actions.

Parameters:

flag - true or false

kill

public void kill()

Kill the slave. This may cause data to get lost as the slave may not send something that is expected to the python master.

isClosable

public boolean isClosable()

Check if the slave is closable. It is closable if not started by the Lr.

Returns:

flag

pluginVersion

public String pluginVersion()

Return version of the Python plugin.

Returns:

version

pluginBuild

public String pluginBuild()

Return build (short commit id) of Python plugin.

Returns:

commit id

gate_version

public String gate_version()

Return version of GATE.

Returns:

version

gate_build

public String gate_build()

Return build (short commit id) of GATE.

Returns:

commit id