Package org.gvsig.scripting

Interface ScriptingManager

All Superinterfaces:
org.gvsig.tools.script.ScriptManager
public interface ScriptingManager extends org.gvsig.tools.script.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.

  • Field Details

  • Method Details

    • setHomeFolder

      void setHomeFolder(File home)

    • getHomeFolder

      File getHomeFolder()

    • getDataFolder

      File getDataFolder(String id)

    • registerDataFolder

      void registerDataFolder(ScriptingFolder folderScript, String id)

    • searchOldVersions

      List<DataFolderFound> searchOldVersions(org.gvsig.tools.packageutils.Version currentVersion, org.gvsig.tools.util.FolderSet folder)

    • 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

    • getUnit

      ScriptingUnit getUnit(String pathName)
      Return the ScriptingUnit associated with the path specified. the path should start with "User" or "System".
      Parameters:
      pathName -
      Returns:
      the required ScriptingUnit

    • 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

    • addLibFolder

      void addLibFolder(File lib)

    • getRootUserFolder

      File getRootUserFolder()

    • getInstallerFactory

      org.gvsig.tools.service.spi.ProviderFactory getInstallerFactory()

    • 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:

    • 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:

    • getExtendedProperties

      Map getExtendedProperties()
      Returns a hash map with all new properties associated to this layer.
      Returns:
      hash table with the added properties
      See Also:

    • createLink

      ScriptingFolder createLink(String name, File link, String targetPathName)

    • createLink

      ScriptingFolder createLink(String name, ScriptingFolder link, String targetPathName)