org.gvsig.scripting.impl

Class DefaultScriptingScript

java.lang.Object

org.gvsig.scripting.impl.AbstractUnit

org.gvsig.scripting.impl.AbstractScript

org.gvsig.scripting.impl.DefaultScriptingScript

All Implemented Interfaces:

Unit, ScriptingBaseScript, ScriptingScript, ScriptingText, ScriptingUnit, Observable, WeakReferencingObservable, Script

Direct Known Subclasses:

DefaultScriptingDialog

public class DefaultScriptingScript
extends AbstractScript
implements ScriptingScript

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultScriptingScript.OutputWriter

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.script.CompiledScript	compiledCode
protected javax.script.ScriptEngine	engine
protected java.lang.String	extension
protected java.lang.String	langName
protected java.lang.String	librarySuffix
protected boolean	useSysPath

Fields inherited from class org.gvsig.scripting.impl.AbstractScript

enabled, isolationGroup

Fields inherited from class org.gvsig.scripting.impl.AbstractUnit

changeListener, createdBy, description, id, manager, name, parent, saved, typename, version

Fields inherited from interface org.gvsig.scripting.ScriptingBaseScript

ISOLATION_HIGH, ISOLATION_LOW

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultScriptingScript(ScriptingFolder parent, ScriptingManager manager, java.lang.String id)
	DefaultScriptingScript(ScriptingFolder parent, ScriptingManager manager, java.lang.String id, java.lang.String langName)
protected	DefaultScriptingScript(ScriptingFolder parent, java.lang.String typename, ScriptingManager manager, java.lang.String id)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	__call__()
java.lang.Object	__call__(java.lang.Object[] args)
java.lang.Object	__getattr__(java.lang.String name)
void	__setattr__(java.lang.String name, java.lang.Object value)
void	addDisposable(Disposable disposable)
void	addObserver(Observer o)
void	addStderrWriter(java.io.Writer err)
void	addStdoutWriter(java.io.Writer out)
void	compile()
protected void	console_println(java.lang.String s)
void	create(ScriptingFolder folder, java.lang.String id, java.lang.String language)
void	deleteObserver(Observer o)
void	deleteObservers()
ScriptingUnit	get(java.io.File file)
ScriptingUnit	get(java.lang.String name)
java.lang.String	getCode() Returns the ScriptingScript's code.
protected java.lang.String	getCodeToInitializeEngine()
javax.script.ScriptEngine	getEngine()
java.lang.String	getExtension()
java.util.List<java.io.File>	getFiles() Return a list of the files that use this unit with out the inf file.
java.lang.String[]	getIconNames() Gets the name of the icons associated to the ScriptingUnit type.
java.lang.String	getLangName() Returns the languange in which the ScriptingScript is written.
java.util.List<java.io.File>	getLibFolders()
java.lang.String	getLibrarySuffix()
java.lang.String	getMainName() Returns the name of the main function in the ScriptingScript's code
java.lang.String	getMimeType()
java.util.List<java.lang.String>	getNames() Returns the list of names defined in this script.
java.lang.String	getNewTemplate()
java.io.File	getResource(java.lang.String filename) Return a resource File that is beside this script.
java.io.File	getScriptFile()
DefaultScriptingScript.OutputWriter	getStderr()
DefaultScriptingScript.OutputWriter	getStdout()
java.lang.String	getText() Returns the text associated to this unit.
int	hashCode()
java.lang.Object	invokeFunction(java.lang.String name, java.lang.Object[] args) Executes a function from the Script's code
java.lang.Object	invokeMethod(java.lang.Object obj, java.lang.String name, java.lang.Object[] args) Executes a method from the Script's code
void	load(ScriptingFolder folder, java.lang.String id)
protected void	loadInf(Ini prefs)
java.lang.Object	main() Run the main function of this script.
java.lang.Object	main(java.lang.Object... args) Run the main function of this script.
boolean	move(ScriptingFolder target) Moves a ScriptingUnitfrom the current directory to the new location.
protected void	notifyErrors(java.lang.Exception exception, java.lang.String command)
void	put(java.lang.String name, java.lang.Object value)
boolean	remove()
void	removeStderrWriter(java.io.Writer err)
void	removeStdoutWriter(java.io.Writer out)
boolean	rename(java.lang.String newId) Changes the ID of a ScriptingUnit and the name of the files and/or directories associated
java.lang.Object	run() Executes the code of a ScriptBaseScript.
java.lang.Object	run(java.lang.Object[] args) Executes the code of a ScriptBaseScript.
void	runAsTask(java.lang.Object[] args) Executes the code of a ScriptBaseScript in a separated thread
void	save() Persists the current status of a ScriptingScript with the content associated.
protected void	save(Ini prefs)
void	setCode(java.lang.String code) Sets a the code associated with a ScriptingScript.
void	setExtension(java.lang.String extension)
protected void	setLangName(java.lang.String langName)
void	setLibrarySuffix(java.lang.String librarySuffix)
void	setMainName(java.lang.String mainName) Stablishes a new main main function in the ScriptingScript's code.
void	setText(java.lang.String text) Sets a the text associated to this unit.

Methods inherited from class org.gvsig.scripting.impl.AbstractScript

getIsolationGroup, isEnabled, registerDataFolder, setEnabled, setIsolationGroup

Methods inherited from class org.gvsig.scripting.impl.AbstractUnit

addPropertyChangeListener, create, equals, firePropertyChange, firePropertyChangeListener, getCreatedBy, getDescription, getFile, getFileResource, getId, getInfBoolean, getInfInt, getInfString, getInfValue, getManager, getName, getParent, getProperties, getProperty, getTypeName, getURL, getUserPath, getVersion, isASystemUnit, isSaved, reload, setCreatedBy, setDescription, setId, setName, setParent, setProperty, setSaved, setVersion, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gvsig.scripting.ScriptingScript

registerDataFolder

Methods inherited from interface org.gvsig.scripting.ScriptingBaseScript

getIsolationGroup, isEnabled, setEnabled, setIsolationGroup

Methods inherited from interface org.gvsig.scripting.ScriptingUnit

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

Methods inherited from interface org.gvsig.tools.script.Script

equals, getName, getTypeName, getURL

Field Detail

langName

protected java.lang.String langName

extension

protected java.lang.String extension

librarySuffix

protected java.lang.String librarySuffix

engine

protected javax.script.ScriptEngine engine

compiledCode

protected javax.script.CompiledScript compiledCode

useSysPath

protected boolean useSysPath

Constructor Detail

DefaultScriptingScript

protected DefaultScriptingScript(ScriptingFolder parent,
                                 java.lang.String typename,
                                 ScriptingManager manager,
                                 java.lang.String id)

DefaultScriptingScript

public DefaultScriptingScript(ScriptingFolder parent,
                              ScriptingManager manager,
                              java.lang.String id)

DefaultScriptingScript

public DefaultScriptingScript(ScriptingFolder parent,
                              ScriptingManager manager,
                              java.lang.String id,
                              java.lang.String langName)

Method Detail

hashCode

public int hashCode()

Specified by:

hashCode in interface Script

Overrides:

hashCode in class AbstractUnit

addStdoutWriter

public void addStdoutWriter(java.io.Writer out)

Specified by:

addStdoutWriter in interface ScriptingBaseScript

addStderrWriter

public void addStderrWriter(java.io.Writer err)

Specified by:

addStderrWriter in interface ScriptingBaseScript

removeStdoutWriter

public void removeStdoutWriter(java.io.Writer out)

Specified by:

removeStdoutWriter in interface ScriptingBaseScript

removeStderrWriter

public void removeStderrWriter(java.io.Writer err)

Specified by:

removeStderrWriter in interface ScriptingBaseScript

__getattr__

public java.lang.Object __getattr__(java.lang.String name)

__setattr__

public void __setattr__(java.lang.String name,
                        java.lang.Object value)

__call__

public java.lang.Object __call__()

__call__

public java.lang.Object __call__(java.lang.Object[] args)

getStdout

public DefaultScriptingScript.OutputWriter getStdout()

getStderr

public DefaultScriptingScript.OutputWriter getStderr()

notifyErrors

protected void notifyErrors(java.lang.Exception exception,
                            java.lang.String command)

getCode

public java.lang.String getCode()

Description copied from interface: ScriptingScript

Returns the ScriptingScript's code.

Specified by:

getCode in interface ScriptingScript

Specified by:

getCode in interface Script

Returns:

a String with the code of the script.

setCode

public void setCode(java.lang.String code)

Description copied from interface: ScriptingScript

Sets a the code associated with a ScriptingScript.

Specified by:

setCode in interface ScriptingScript

Specified by:

setCode in interface Script

Parameters:

code - String that contains the new code.

getLibrarySuffix

public java.lang.String getLibrarySuffix()

Specified by:

getLibrarySuffix in interface ScriptingBaseScript

setLibrarySuffix

public void setLibrarySuffix(java.lang.String librarySuffix)

Specified by:

setLibrarySuffix in interface ScriptingBaseScript

getLibFolders

public java.util.List<java.io.File> getLibFolders()

getCodeToInitializeEngine

protected java.lang.String getCodeToInitializeEngine()

getEngine

public javax.script.ScriptEngine getEngine()

loadInf

protected void loadInf(Ini prefs)

Overrides:

loadInf in class AbstractScript

load

public void load(ScriptingFolder folder,
                 java.lang.String id)

Specified by:

load in interface Unit

Specified by:

load in class AbstractUnit

save

public void save()

Description copied from interface: ScriptingScript

Persists the current status of a ScriptingScript with the content associated.

Specified by:

save in interface ScriptingScript

Specified by:

save in interface ScriptingText

save

protected void save(Ini prefs)

Overrides:

save in class AbstractScript

getLangName

public java.lang.String getLangName()

Description copied from interface: ScriptingScript

Returns the languange in which the ScriptingScript is written.

Specified by:

getLangName in interface ScriptingScript

Returns:

a String containing the name of the language

setLangName

protected void setLangName(java.lang.String langName)

getIconNames

public java.lang.String[] getIconNames()

Description copied from interface: ScriptingUnit

Gets the name of the icons associated to the ScriptingUnit type.

Specified by:

getIconNames in interface ScriptingUnit

Returns:

a String array with the identificators of the icons associated.

getMainName

public java.lang.String getMainName()

Description copied from interface: ScriptingScript

Returns the name of the main function in the ScriptingScript's code

Specified by:

getMainName in interface ScriptingScript

Returns:

a String with main function (default main name is 'main').

setMainName

public void setMainName(java.lang.String mainName)

Description copied from interface: ScriptingScript

Stablishes a new main main function in the ScriptingScript's code.

Specified by:

setMainName in interface ScriptingScript

Parameters:

mainName - String that contains the new main function name.

getFiles

public java.util.List<java.io.File> getFiles()

Description copied from interface: ScriptingUnit

Return a list of the files that use this unit with out the inf file.

Specified by:

getFiles in interface ScriptingUnit

Returns:

list of files of the unit.

getExtension

public java.lang.String getExtension()

setExtension

public void setExtension(java.lang.String extension)

addObserver

public void addObserver(Observer o)

Specified by:

addObserver in interface Observable

deleteObserver

public void deleteObserver(Observer o)

Specified by:

deleteObserver in interface Observable

deleteObservers

public void deleteObservers()

Specified by:

deleteObservers in interface Observable

put

public void put(java.lang.String name,
                java.lang.Object value)

Specified by:

put in interface ScriptingBaseScript

Specified by:

put in interface Script

compile

public void compile()

Specified by:

compile in interface ScriptingBaseScript

addDisposable

public void addDisposable(Disposable disposable)

main

public java.lang.Object main()

Run the main function of this script. This method is created by familiarity when running the script from another script.

Returns:

main

public java.lang.Object main(java.lang.Object... args)

Run the main function of this script. This method is created by familiarity when running the script from another script.

Parameters:

args -

Returns:

run

public java.lang.Object run()

Description copied from interface: ScriptingBaseScript

Executes the code of a ScriptBaseScript.

Specified by:

run in interface ScriptingBaseScript

Returns:

run

public java.lang.Object run(java.lang.Object[] args)

Description copied from interface: ScriptingBaseScript

Executes the code of a ScriptBaseScript.

Specified by:

run in interface ScriptingBaseScript

Parameters:

args - Contains the input parameters to run the ScriptBaseScript.

Returns:

invokeFunction

public java.lang.Object invokeFunction(java.lang.String name,
                                       java.lang.Object[] args)

Description copied from interface: ScriptingScript

Executes a function from the Script's code

Specified by:

invokeFunction in interface ScriptingScript

Specified by:

invokeFunction in interface Script

Parameters:

name - method's name to execute

args - input parameters of the method

Returns:

An Object that represents the execution

getScriptFile

public java.io.File getScriptFile()

Specified by:

getScriptFile in interface ScriptingBaseScript

invokeMethod

public java.lang.Object invokeMethod(java.lang.Object obj,
                                     java.lang.String name,
                                     java.lang.Object[] args)
                              throws java.lang.NoSuchMethodException

Description copied from interface: ScriptingScript

Executes a method from the Script's code

Specified by:

invokeMethod in interface ScriptingScript

Parameters:

obj - this Object represents the script's code

name - method's name to execute

args - input parameters of the method

Returns:

An Object that represents the execution

Throws:

java.lang.NoSuchMethodException - If there isn't a main function to begin the execution

getResource

public java.io.File getResource(java.lang.String filename)

Description copied from interface: ScriptingBaseScript

Return a resource File that is beside this script.

Specified by:

getResource in interface ScriptingBaseScript

Returns:

the file which is beside this script

getMimeType

public java.lang.String getMimeType()

Specified by:

getMimeType in interface ScriptingScript

Specified by:

getMimeType in interface ScriptingText

console_println

protected void console_println(java.lang.String s)

Overrides:

console_println in class AbstractUnit

runAsTask

public void runAsTask(java.lang.Object[] args)

Description copied from interface: ScriptingBaseScript

Executes the code of a ScriptBaseScript in a separated thread

Specified by:

runAsTask in interface ScriptingBaseScript

Parameters:

args - Contains the input parameters to run the ScriptBaseScript.

remove

public boolean remove()

Specified by:

remove in interface ScriptingUnit

create

public void create(ScriptingFolder folder,
                   java.lang.String id,
                   java.lang.String language)

Specified by:

create in interface Unit

getNewTemplate

public java.lang.String getNewTemplate()

get

public ScriptingUnit get(java.lang.String name)

get

public ScriptingUnit get(java.io.File file)

move

public boolean move(ScriptingFolder target)

Description copied from interface: ScriptingUnit

Moves a ScriptingUnitfrom the current directory to the new location.

Specified by:

move in interface ScriptingUnit

Parameters:

target - ScriptingFolder that represents the destination..

Returns:

true if it's succesful, false if not.

rename

public boolean rename(java.lang.String newId)

Description copied from interface: ScriptingUnit

Changes the ID of a ScriptingUnit and the name of the files and/or directories associated

Specified by:

rename in interface ScriptingUnit

Parameters:

newId - String that contains the new Id.

Returns:

true if it's succesful, false if not.

getNames

public java.util.List<java.lang.String> getNames()

Description copied from interface: Script

Returns the list of names defined in this script. Returns null if this functionality is not supported.

Specified by:

getNames in interface Script

Returns:

getText

public java.lang.String getText()

Description copied from interface: ScriptingText

Returns the text associated to this unit.

Specified by:

getText in interface ScriptingText

Returns:

a String of this unit.

setText

public void setText(java.lang.String text)

Description copied from interface: ScriptingText

Sets a the text associated to this unit.

Specified by:

setText in interface ScriptingText

Parameters:

text - String to assign to this unit.