org.gvsig.scripting.impl

Class DefaultScriptingManager

java.lang.Object

org.gvsig.scripting.impl.DefaultScriptingManager

All Implemented Interfaces:

ScriptingManager, ScriptManager

public class DefaultScriptingManager
extends Object
implements ScriptingManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultScriptingManager.RegisterSystemFolder

Field Summary

Fields

Modifier and Type	Field and Description
protected ScriptEngineManager	engineManager
protected Map<String,ImageIcon>	icons
protected List<DefaultScriptingManager.RegisterSystemFolder>	systemFolders

Fields inherited from interface org.gvsig.scripting.ScriptingManager

DEFAULT_ISOLATION_GROUP, HELP_INSTALLER_PROVIDER_DESCRIPTION, HELP_INSTALLER_PROVIDER_NAME, INSTALLER_PROVIDER_DESCRIPTION, INSTALLER_PROVIDER_NAME, PYTHON_LANGUAGE_NAME, SCALA_LANGUAGE_NAME, UNIT_DIALOG, UNIT_EXTERNALFILE, UNIT_FOLDER, UNIT_SCRIPT

Constructor Summary

Constructors

Constructor and Description
DefaultScriptingManager()
DefaultScriptingManager(ClassLoader classLoader)

Method Summary

Modifier and Type	Method and Description
void	addAlternativeUserFolder(File f, String name, String description)
void	addLibFolder(File lib)
ScriptingDialog	createDialog(ScriptingFolder folder, String id)
ScriptingExternalFile	createExternalFile(ScriptingFolder folder, String id)
ScriptingFolder	createFolder(ScriptingFolder folder, String id)
ScriptingScript	createScript(ScriptingFolder folder, String id)
Script	createScript(String name, String code, String languaje)
ScriptingUnit	createUnit(String unitType, ScriptingFolder folder, String id)
ScriptingUnit	createUnit(String unitType, ScriptingFolder folder, String id, String language)
Object	get(String key) Retrieves a value set in the state of this ScriptingManager
List<ScriptingFolder>	getAlternativeUserFolders()
ScriptEngine	getEngineByLanguage(String langName)
ScriptEngine	getEngineByLanguage(String langName, String isolationGroup)
ScriptEngineFactory	getEngineFactoryByLanguage(String langName)
protected ScriptEngineManager	getEngineManager()
String	getEngineNameByLanguage(String langName)
Set<String>	getEnginesIsolationGroups()
Map	getExtendedProperties() Returns a hash map with all new properties associated to this layer.
String	getExtensionOfLanguage(String langName)
ScriptingFolder	getFolder(File file) Returns the ScriptingFolder associated with the file specified
ProviderFactory	getHelpInstallerFactory()
ScriptingHelpManager	getHelpManager() Gets the Help manager
File	getHomeFolder()
ImageIcon	getIcon(String name)
ProviderFactory	getInstallerFactory()
String	getLanguageOfExtension(String extension)
List<File>	getLibFolders()
Map<String,String>	getLibFoldersVersions() Return a map with the label and suffix of the library versions.
File	getPackagesFolder() Devuelbe la carpeta en la que se encuentran los paquetes de la aplicacion.
Object	getProperty(Object key) Returns a reference to an object (property) associated to this layer.
File	getRootUserFolder()
ScriptingBaseScript	getScript(File file) Returns the ScriptingBaseScript associated with the file specified
ScriptingBaseScript	getScript(String name)
List<String>	getSupportedLanguages()
ScriptingFolder	getSystemFolder() Returns the System's Folder
List<DefaultScriptingManager.RegisterSystemFolder>	getSystemFolders()
ScriptingUnit	getUnit(File file)
List<String>	getUnitTypes()
ScriptingFolder	getUserFolder() Returns the User's Folder
void	loadEngines() Search the available engines and initialize the manager.
Script	locateScript(String name)
void	put(String key, Object value) Sets a key/value pair in the state of the ScriptingManager that may either create a Java Language Binding to be used in the execution of scripts
void	registerSystemFolder(String name, File folder) Registers a File System with ScriptingUnits in the SystemFolder
void	setHomeFolder(File home)
void	setPackagesFolder(File folder) Establece la carpeta en la que se encuentran los paquetes de la aplicacion.
void	setProperty(Object key, Object val) Inserts an object as a property to this layer.
boolean	validateUnitId(ScriptingFolder folder, String id) Checks if an id is unique in a determinate folder

Methods inherited from class java.lang.Object

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

Field Detail

icons

protected Map<String,ImageIcon> icons

systemFolders

protected List<DefaultScriptingManager.RegisterSystemFolder> systemFolders

engineManager

protected ScriptEngineManager engineManager

Constructor Detail

DefaultScriptingManager

public DefaultScriptingManager()

DefaultScriptingManager

public DefaultScriptingManager(ClassLoader classLoader)

Method Detail

getProperty

public Object getProperty(Object key)

Description copied from interface: ScriptingManager

Returns a reference to an object (property) associated to this layer.

For example, you can attach a network definition to key "network" and check if a layer has a network loaded using getAssociatedObject("network") and that it's not null.

Specified by:

getProperty in interface ScriptingManager

Parameters:

key - the key associated to the property

Returns:

null if key is not found

See Also:

ScriptingManager.getExtendedProperties(), ScriptingManager.setProperty(Object, Object)

setProperty

public void setProperty(Object key,
                        Object val)

Description copied from interface: ScriptingManager

Inserts an object as a property to this layer.

Specified by:

setProperty in interface ScriptingManager

Parameters:

key - the key associated to the property

val - the property

See Also:

ScriptingManager.getProperty(Object), ScriptingManager.getExtendedProperties()

getExtendedProperties

public Map getExtendedProperties()

Description copied from interface: ScriptingManager

Returns a hash map with all new properties associated to this layer.

Specified by:

getExtendedProperties in interface ScriptingManager

Returns:

hash table with the added properties

See Also:

ScriptingManager.getProperty(Object), ScriptingManager.setProperty(Object, Object)

getHomeFolder

public File getHomeFolder()

Specified by:

getHomeFolder in interface ScriptingManager

setHomeFolder

public void setHomeFolder(File home)

Specified by:

setHomeFolder in interface ScriptingManager

getEngineManager

protected ScriptEngineManager getEngineManager()

loadEngines

public void loadEngines()

Description copied from interface: ScriptingManager

Search the available engines and initialize the manager.

Specified by:

loadEngines in interface ScriptingManager

getIcon

public ImageIcon getIcon(String name)

getEngineNameByLanguage

public String getEngineNameByLanguage(String langName)

Specified by:

getEngineNameByLanguage in interface ScriptingManager

getEngineByLanguage

public ScriptEngine getEngineByLanguage(String langName)

getEngineByLanguage

public ScriptEngine getEngineByLanguage(String langName,
                                        String isolationGroup)

getEnginesIsolationGroups

public Set<String> getEnginesIsolationGroups()

Specified by:

getEnginesIsolationGroups in interface ScriptingManager

getEngineFactoryByLanguage

public ScriptEngineFactory getEngineFactoryByLanguage(String langName)

validateUnitId

public boolean validateUnitId(ScriptingFolder folder,
                              String id)

Description copied from interface: ScriptingManager

Checks if an id is unique in a determinate folder

Specified by:

validateUnitId in interface ScriptingManager

Parameters:

folder - {

id - String with the id to validate

Returns:

true if there isn't another ScriptingUnit with the same id, and false in the other case

createScript

public ScriptingScript createScript(ScriptingFolder folder,
                                    String id)

createScript

public Script createScript(String name,
                           String code,
                           String languaje)

Specified by:

createScript in interface ScriptManager

createDialog

public ScriptingDialog createDialog(ScriptingFolder folder,
                                    String id)

createFolder

public ScriptingFolder createFolder(ScriptingFolder folder,
                                    String id)

createExternalFile

public ScriptingExternalFile createExternalFile(ScriptingFolder folder,
                                                String id)

getScript

public ScriptingBaseScript getScript(File file)

Description copied from interface: ScriptingManager

Returns the ScriptingBaseScript associated with the file specified

Specified by:

getScript in interface ScriptingManager

Parameters:

file - File where is contained the ScriptingBaseScript's information

Returns:

ScriptingBaseScript

getFolder

public ScriptingFolder getFolder(File file)

Description copied from interface: ScriptingManager

Returns the ScriptingFolder associated with the file specified

Specified by:

getFolder in interface ScriptingManager

Parameters:

file - File where is contained the ScriptingFolder's information

Returns:

ScriptingFolder

getUnit

public ScriptingUnit getUnit(File file)

getSystemFolder

public ScriptingFolder getSystemFolder()

Description copied from interface: ScriptingManager

Returns the System's Folder

Specified by:

getSystemFolder in interface ScriptingManager

Returns:

a ScriptingFolder with the System's Folder.

getUserFolder

public ScriptingFolder getUserFolder()

Description copied from interface: ScriptingManager

Returns the User's Folder

Specified by:

getUserFolder in interface ScriptingManager

Returns:

a ScriptingFolder with the User's Folder.

getScript

public ScriptingBaseScript getScript(String name)

Specified by:

getScript in interface ScriptingManager

locateScript

public Script locateScript(String name)

Specified by:

locateScript in interface ScriptManager

getRootUserFolder

public File getRootUserFolder()

Specified by:

getRootUserFolder in interface ScriptingManager

registerSystemFolder

public void registerSystemFolder(String name,
                                 File folder)

Description copied from interface: ScriptingManager

Registers a File System with ScriptingUnits in the SystemFolder

Specified by:

registerSystemFolder in interface ScriptingManager

Parameters:

name - String with the identificator name of the File System registered

folder - File with the root of the File System to register

getSystemFolders

public List<DefaultScriptingManager.RegisterSystemFolder> getSystemFolders()

getAlternativeUserFolders

public List<ScriptingFolder> getAlternativeUserFolders()

Specified by:

getAlternativeUserFolders in interface ScriptingManager

addAlternativeUserFolder

public void addAlternativeUserFolder(File f,
                                     String name,
                                     String description)

Specified by:

addAlternativeUserFolder in interface ScriptingManager

getExtensionOfLanguage

public String getExtensionOfLanguage(String langName)

Specified by:

getExtensionOfLanguage in interface ScriptingManager

getSupportedLanguages

public List<String> getSupportedLanguages()

Specified by:

getSupportedLanguages in interface ScriptingManager

getLanguageOfExtension

public String getLanguageOfExtension(String extension)

get

public Object get(String key)

Description copied from interface: ScriptingManager

Retrieves a value set in the state of this ScriptingManager

Specified by:

get in interface ScriptingManager

Parameters:

key - The key whose value is to be returned

Returns:

an Object with the value corresponding to the key

put

public void put(String key,
                Object value)

Description copied from interface: ScriptingManager

Sets a key/value pair in the state of the ScriptingManager that may either create a Java Language Binding to be used in the execution of scripts

Specified by:

put in interface ScriptingManager

Parameters:

key - The name of named value to add

value - The value of named value to add.

getHelpManager

public ScriptingHelpManager getHelpManager()

Description copied from interface: ScriptingManager

Gets the Help manager

Specified by:

getHelpManager in interface ScriptingManager

Returns:

a ScriptingHelpManager

See Also:

ScriptingHelpManager

createUnit

public ScriptingUnit createUnit(String unitType,
                                ScriptingFolder folder,
                                String id)

Specified by:

createUnit in interface ScriptingManager

createUnit

public ScriptingUnit createUnit(String unitType,
                                ScriptingFolder folder,
                                String id,
                                String language)

Specified by:

createUnit in interface ScriptingManager

getUnitTypes

public List<String> getUnitTypes()

Specified by:

getUnitTypes in interface ScriptingManager

addLibFolder

public void addLibFolder(File lib)

Specified by:

addLibFolder in interface ScriptingManager

getLibFolders

public List<File> getLibFolders()

Specified by:

getLibFolders in interface ScriptingManager

getLibFoldersVersions

public Map<String,String> getLibFoldersVersions()

Description copied from interface: ScriptingManager

Return a map with the label and suffix of the library versions. For each value of map, the value is the name of the version (a label) and the key is the suffix for that version.

Specified by:

getLibFoldersVersions in interface ScriptingManager

Returns:

a map with suffix and labels of library versions.

getInstallerFactory

public ProviderFactory getInstallerFactory()

Specified by:

getInstallerFactory in interface ScriptingManager

getHelpInstallerFactory

public ProviderFactory getHelpInstallerFactory()

Specified by:

getHelpInstallerFactory in interface ScriptingManager

getPackagesFolder

public File getPackagesFolder()

Description copied from interface: ScriptingManager

Devuelbe la carpeta en la que se encuentran los paquetes de la aplicacion.

Specified by:

getPackagesFolder in interface ScriptingManager

Returns:

setPackagesFolder

public void setPackagesFolder(File folder)

Description copied from interface: ScriptingManager

Establece la carpeta en la que se encuentran los paquetes de la aplicacion.

Specified by:

setPackagesFolder in interface ScriptingManager