gate.plugin.python

Class PythonPrResult

java.lang.Object

gate.util.AbstractFeatureBearer

gate.creole.AbstractResource

gate.creole.AbstractLanguageResource

gate.plugin.python.PythonPrResult

All Implemented Interfaces:

gate.LanguageResource, gate.Resource, gate.util.FeatureBearer, gate.util.NameBearer, Serializable

@CreoleResource(name="PythonPrResult",
                comment="Language Resource to represent a PythonPr over corpus result.",
                helpURL="")
public class PythonPrResult
extends gate.creole.AbstractLanguageResource

Represents the result of PythonPr processing. This represents the result of processing a whole corpus with some PythonPr. All data is stored in the feature map of the LR.

Author:

Johann Petrak

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected URL	fileUrl
protected Boolean	logFeatures
org.apache.log4j.Logger	logger Our logger instance.

Fields inherited from class gate.creole.AbstractLanguageResource

dataStore, lrPersistentId

Fields inherited from class gate.creole.AbstractResource

name

Fields inherited from class gate.util.AbstractFeatureBearer

features

Constructor Summary

Constructors

Constructor and Description
PythonPrResult()

Method Summary

Modifier and Type	Method and Description
URL	getFileUrl() Get the file URL.
Boolean	getLogFeatures() Get the log features flag.
Map<String,Object>	getResultData() Get the current result data stored in the features.
gate.Resource	init() Initialize resource.
protected void	loadFromFile()
void	outputFeaturesToLog() Log the current features to the logger.
protected void	saveToFile()
void	setFileUrl(URL value) Set the file URL
void	setLogFeatures(Boolean value) Set log features flag.
void	setResultData(Map<String,Object> resultData) Set or update the result data.

Methods inherited from class gate.creole.AbstractLanguageResource

cleanup, getDataStore, getLRPersistenceId, getParent, isModified, setDataStore, setLRPersistenceId, setParent, sync

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

Field Detail

logger

public transient org.apache.log4j.Logger logger

Our logger instance.

logFeatures

protected Boolean logFeatures

fileUrl

protected URL fileUrl

Constructor Detail

PythonPrResult

public PythonPrResult()

Method Detail

setLogFeatures

@Optional
 @CreoleParameter(comment="If true, log the current features whenever the result is updated.")
public void setLogFeatures(Boolean value)

Set log features flag. If true, features will get logged whenever updated.

Parameters:

value - flag

getLogFeatures

public Boolean getLogFeatures()

Get the log features flag.

Returns:

flag

setFileUrl

@Optional
 @CreoleParameter(comment="File to use for saving/loading the result. Nothing saved/loaded if missing.")
public void setFileUrl(URL value)

Set the file URL

Parameters:

value - file URL

getFileUrl

public URL getFileUrl()

Get the file URL.

Returns:

file URL

init

public gate.Resource init()

Initialize resource.

Specified by:

init in interface gate.Resource

Overrides:

init in class gate.creole.AbstractResource

Returns:

this resource

saveToFile

protected void saveToFile()

loadFromFile

protected void loadFromFile()

outputFeaturesToLog

public void outputFeaturesToLog()

Log the current features to the logger.

setResultData

public void setResultData(Map<String,Object> resultData)

Set or update the result data. Updates the resource with the passed result data. Existing features are cleared first.

Parameters:

resultData - the result data to set

getResultData

public Map<String,Object> getResultData()

Get the current result data stored in the features.

Returns:

current result data