Package org.gvsig.scripting

Interface ScriptingBaseScript

All Superinterfaces:

org.gvsig.tools.observer.Observable, ScriptingUnit, org.gvsig.tools.observer.WeakReferencingObservable

All Known Subinterfaces:

ScriptingDialog, ScriptingScript

public interface ScriptingBaseScript
extends ScriptingUnit, org.gvsig.tools.observer.WeakReferencingObservable

Interface that represents Scripting elements.

See Also:

• ScriptingUnit
• ScriptingScript
• ScriptingDialog
• invalid reference

  ScriptingProject

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ISOLATION_HIGH
static final int	ISOLATION_LOW

Method Summary

Modifier and Type	Method	Description
void	addStderrWriter(Writer err)
void	addStdoutWriter(Writer out)
void	compile()
String	getIsolationGroup()
String	getLibrarySuffix()
File	getResource(String filename)	Return a resource File that is beside this script.
File	getScriptFile()
boolean	isEnabled()	Check if the script execution is enabled.
void	put(String name, Object value)
void	removeStderrWriter(Writer err)
void	removeStdoutWriter(Writer out)
Object	run()	Executes the code of a ScriptBaseScript.
Object	run(Object[] args)	Executes the code of a ScriptBaseScript.
void	runAsTask(Object[] args)	Executes the code of a ScriptBaseScript in a separated thread
void	setEnabled(boolean enabled)	Enable or disable the sript execution.
void	setIsolationGroup(String group)
void	setLibrarySuffix(String librarySuffix)

Methods inherited from interface org.gvsig.tools.observer.Observable

addObserver, deleteObserver, deleteObservers

Methods inherited from interface org.gvsig.scripting.ScriptingUnit

addPropertyChangeListener, getCreatedBy, getDescription, getFile, getFileResource, getFiles, getIconNames, getId, getName, getParent, getProperties, getProperty, getTypeName, getUserPath, getVersion, isASystemUnit, isSaved, move, reload, remove, rename, setCreatedBy, setDescription, setName, setProperty, setSaved, setVersion

Field Details

ISOLATION_LOW

static final int ISOLATION_LOW

See Also:

• Constant Field Values

ISOLATION_HIGH

static final int ISOLATION_HIGH

See Also:

• Constant Field Values

Method Details

isEnabled

boolean isEnabled()

Check if the script execution is enabled.

Returns:

if the script is enabled.

setEnabled

void setEnabled(boolean enabled)

Enable or disable the sript execution.

Parameters:

enabled -

run

Object run()

Executes the code of a ScriptBaseScript.

Returns:

run

Object run(Object[] args)

Executes the code of a ScriptBaseScript.

Parameters:

args - Contains the input parameters to run the ScriptBaseScript.

Returns:

runAsTask

void runAsTask(Object[] args)

Executes the code of a ScriptBaseScript in a separated thread

Parameters:

args - Contains the input parameters to run the ScriptBaseScript.

compile

void compile()
      throws ScriptingRunningException

Throws:

ScriptingRunningException

put

void put(String name,
 Object value)

getResource

File getResource(String filename)

Return a resource File that is beside this script.

Parameters:

filename -

Returns:

the file which is beside this script

getScriptFile

File getScriptFile()

getLibrarySuffix

String getLibrarySuffix()

setLibrarySuffix

void setLibrarySuffix(String librarySuffix)

addStdoutWriter

void addStdoutWriter(Writer out)

addStderrWriter

void addStderrWriter(Writer err)

removeStdoutWriter

void removeStdoutWriter(Writer out)

removeStderrWriter

void removeStderrWriter(Writer err)

setIsolationGroup

void setIsolationGroup(String group)

getIsolationGroup

String getIsolationGroup()