ScriptingManager

All Superinterfaces:

ScriptManager

All Known Implementing Classes:

DefaultScriptingManager
```
public interface ScriptingManager
extends ScriptManager
```
There are two top level management roles within ScriptingFramework: logical and User's Interface (UI) management. This class is responsible of the logical role. It provides all the services to manage the information used in ScriptingFramework.

See Also:

ScriptingUIManager, ScriptingHelpManager

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_ISOLATION_GROUP`
`static String`	`HELP_INSTALLER_PROVIDER_DESCRIPTION`
`static String`	`HELP_INSTALLER_PROVIDER_NAME`
`static String`	`INSTALLER_PROVIDER_DESCRIPTION`
`static String`	`INSTALLER_PROVIDER_NAME`
`static String`	`PYTHON_LANGUAGE_NAME`
`static String`	`SCALA_LANGUAGE_NAME`
`static String`	`UNIT_DIALOG`
`static String`	`UNIT_EXTERNALFILE`
`static String`	`UNIT_FOLDER`
`static String`	`UNIT_SCRIPT`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addAlternativeUserFolder(File f, String name, String description)`
`void`	`addLibFolder(File lib)`
`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()`
`String`	`getEngineNameByLanguage(String langName)`
`Set<String>`	`getEnginesIsolationGroups()`
`Map`	`getExtendedProperties()` Returns a hash map with all new properties associated to this layer.
`String`	`getExtensionOfLanguage(String language)`
`ScriptingFolder`	`getFolder(File file)` Returns the `ScriptingFolder` associated with the file specified
`ProviderFactory`	`getHelpInstallerFactory()`
`ScriptingHelpManager`	`getHelpManager()` Gets the Help manager
`File`	`getHomeFolder()`
`ProviderFactory`	`getInstallerFactory()`
`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<String>`	`getUnitTypes()`
`ScriptingFolder`	`getUserFolder()` Returns the User's Folder
`void`	`loadEngines()` Search the available engines and initialize the manager.
`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 `ScriptingUnit`s 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 obj)` 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 interface org.gvsig.tools.script.ScriptManager
createScript, locateScript

- Field Detail
  - INSTALLER_PROVIDER_NAME
```
static final String INSTALLER_PROVIDER_NAME
```
    See Also:
    
    Constant Field Values
  - INSTALLER_PROVIDER_DESCRIPTION
```
static final String INSTALLER_PROVIDER_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - HELP_INSTALLER_PROVIDER_NAME
```
static final String HELP_INSTALLER_PROVIDER_NAME
```
    See Also:
    
    Constant Field Values
  - HELP_INSTALLER_PROVIDER_DESCRIPTION
```
static final String HELP_INSTALLER_PROVIDER_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - PYTHON_LANGUAGE_NAME
```
static final String PYTHON_LANGUAGE_NAME
```
    See Also:
    
    Constant Field Values
  - SCALA_LANGUAGE_NAME
```
static final String SCALA_LANGUAGE_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ISOLATION_GROUP
```
static final String DEFAULT_ISOLATION_GROUP
```
    See Also:
    
    Constant Field Values
  - UNIT_SCRIPT
```
static final String UNIT_SCRIPT
```
    See Also:
    
    Constant Field Values
  - UNIT_DIALOG
```
static final String UNIT_DIALOG
```
    See Also:
    
    Constant Field Values
  - UNIT_FOLDER
```
static final String UNIT_FOLDER
```
    See Also:
    
    Constant Field Values
  - UNIT_EXTERNALFILE
```
static final String UNIT_EXTERNALFILE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - setHomeFolder
```
void setHomeFolder(File home)
```
  - getHomeFolder
```
File getHomeFolder()
```
  - getSystemFolder
```
ScriptingFolder getSystemFolder()
```
    Returns the System's Folder
    
    Returns:
    
    a ScriptingFolder with the System's Folder.
  - getUserFolder
```
ScriptingFolder getUserFolder()
```
    Returns the User's Folder
    
    Returns:
    
    a ScriptingFolder with the User's Folder.
  - getAlternativeUserFolders
```
List<ScriptingFolder> getAlternativeUserFolders()
```
  - addAlternativeUserFolder
```
void addAlternativeUserFolder(File f,
                              String name,
                              String description)
```
  - createUnit
```
ScriptingUnit createUnit(String unitType,
                         ScriptingFolder folder,
                         String id)
```
  - createUnit
```
ScriptingUnit createUnit(String unitType,
                         ScriptingFolder folder,
                         String id,
                         String language)
```
  - getUnitTypes
```
List<String> getUnitTypes()
```
  - getScript
```
ScriptingBaseScript getScript(File file)
```
    Returns the ScriptingBaseScript associated with the file specified
    
    Parameters:
    
    file - File where is contained the ScriptingBaseScript's information
    
    Returns:
    
    ScriptingBaseScript
  - getScript
```
ScriptingBaseScript getScript(String name)
```
  - getFolder
```
ScriptingFolder getFolder(File file)
```
    Returns the ScriptingFolder associated with the file specified
    
    Parameters:
    
    file - File where is contained the ScriptingFolder's information
    
    Returns:
    
    ScriptingFolder
  - registerSystemFolder
```
void registerSystemFolder(String name,
                          File folder)
```
    Registers a File System with ScriptingUnits in the SystemFolder
    
    Parameters:
    
    name - String with the identificator name of the File System registered
    
    folder - File with the root of the File System to register
  - getSupportedLanguages
```
List<String> getSupportedLanguages()
```
  - getExtensionOfLanguage
```
String getExtensionOfLanguage(String language)
```
  - getEngineNameByLanguage
```
String getEngineNameByLanguage(String langName)
```
  - getEnginesIsolationGroups
```
Set<String> getEnginesIsolationGroups()
```
  - validateUnitId
```
boolean validateUnitId(ScriptingFolder folder,
                       String id)
```
    Checks if an id is unique in a determinate folder
    
    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
  - put
```
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
    
    Parameters:
    
    key - The name of named value to add
    
    value - The value of named value to add.
  - get
```
Object get(String key)
```
    Retrieves a value set in the state of this ScriptingManager
    
    Parameters:
    
    key - The key whose value is to be returned
    
    Returns:
    
    an Object with the value corresponding to the key
  - getHelpManager
```
ScriptingHelpManager getHelpManager()
```
    Gets the Help manager
    
    Returns:
    
    a ScriptingHelpManager
    
    See Also:
    
    ScriptingHelpManager
  - addLibFolder
```
void addLibFolder(File lib)
```
  - getRootUserFolder
```
File getRootUserFolder()
```
  - getInstallerFactory
```
ProviderFactory getInstallerFactory()
```
  - getHelpInstallerFactory
```
ProviderFactory getHelpInstallerFactory()
```
  - getPackagesFolder
```
File getPackagesFolder()
```
    Devuelbe la carpeta en la que se encuentran los paquetes de la aplicacion.
    
    Returns:
  - setPackagesFolder
```
void setPackagesFolder(File folder)
```
    Establece la carpeta en la que se encuentran los paquetes de la aplicacion.
    
    Parameters:
    
    folder -
  - loadEngines
```
void loadEngines()
```
    Search the available engines and initialize the manager.
  - getLibFolders
```
List<File> getLibFolders()
```
  - getLibFoldersVersions
```
Map<String,String> getLibFoldersVersions()
```
    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.
    
    Returns:
    
    a map with suffix and labels of library versions.
  - getProperty
```
Object getProperty(Object key)
```
    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.
    
    Parameters:
    
    key - the key associated to the property
    
    Returns:
    
    null if key is not found
    
    See Also:
    
    getExtendedProperties(), setProperty(Object, Object)
  - setProperty
```
void setProperty(Object key,
                 Object obj)
```
    Inserts an object as a property to this layer.
    
    Parameters:
    
    key - the key associated to the property
    
    obj - the property
    
    See Also:
    
    getProperty(Object), getExtendedProperties()
  - getExtendedProperties
```
Map getExtendedProperties()
```
    Returns a hash map with all new properties associated to this layer.
    
    Returns:
    
    hash table with the added properties
    
    See Also:
    
    getProperty(Object), setProperty(Object, Object)

Interface ScriptingManager

Field Summary

Method Summary

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

Field Detail

INSTALLER_PROVIDER_NAME

INSTALLER_PROVIDER_DESCRIPTION

HELP_INSTALLER_PROVIDER_NAME

HELP_INSTALLER_PROVIDER_DESCRIPTION

PYTHON_LANGUAGE_NAME

SCALA_LANGUAGE_NAME

DEFAULT_ISOLATION_GROUP

UNIT_SCRIPT

UNIT_DIALOG

UNIT_FOLDER

UNIT_EXTERNALFILE

Method Detail

setHomeFolder

getHomeFolder

getSystemFolder

getUserFolder

getAlternativeUserFolders

addAlternativeUserFolder

createUnit

createUnit

getUnitTypes

getScript

getScript

getFolder

registerSystemFolder

getSupportedLanguages

getExtensionOfLanguage

getEngineNameByLanguage

getEnginesIsolationGroups

validateUnitId

put

get

getHelpManager

addLibFolder

getRootUserFolder

getInstallerFactory

getHelpInstallerFactory

getPackagesFolder

setPackagesFolder

loadEngines

getLibFolders

getLibFoldersVersions

getProperty

setProperty

getExtendedProperties