Application: gvSIG desktop » gvSIG scripting

package org.gvsig.scripting;

import java.io.File;

import java.util.List;

import java.util.Map;

import java.util.Set;

import org.gvsig.tools.packageutils.Version;

import org.gvsig.tools.service.spi.ProviderFactory;

import org.gvsig.tools.script.ScriptManager;

import org.gvsig.tools.util.FolderSet;

/**

 * 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.

 */

public interface ScriptingManager extends ScriptManager {

    public static final String INSTALLER_PROVIDER_NAME = "Script";

    public static final String INSTALLER_PROVIDER_DESCRIPTION = "Provider to install scripts";

    public static final String PYTHON_LANGUAGE_NAME = "python";

//    public static final String SCALA_LANGUAGE_NAME = "scala";

    public static final String DEFAULT_ISOLATION_GROUP = "default";

    public static final String UNIT_SCRIPT = "Script";

    public static final String UNIT_DIALOG = "Dialog";

    public static final String UNIT_FOLDER = "Folder";

    public static final String UNIT_EXTERNALFILE = "ExternalFile";

    public void setHomeFolder(File home);

    public File getHomeFolder();

    public File getDataFolder(String id);

    public void registerDataFolder(ScriptingFolder folderScript, String id);

    public List<DataFolderFound> searchOldVersions(Version currentVersion, FolderSet folder);

    /**

     * Returns the System's Folder

     *

     * @return a {@link ScriptingFolder} with the System's Folder.

     */

    public ScriptingFolder getSystemFolder();

    /**

     * Returns the User's Folder

     *

     * @return a {@link ScriptingFolder} with the User's Folder.

     */

    public ScriptingFolder getUserFolder();

    public List<ScriptingFolder> getAlternativeUserFolders();

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

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

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

    public List<String> getUnitTypes();

    /**

     * Returns the {@link ScriptingBaseScript} associated with the file

     * specified

     *

     * @param file File where is contained the {@link ScriptingBaseScript}'s

     * information

     *

     * @return {@link ScriptingBaseScript}

     */

    public ScriptingBaseScript getScript(File file);

    public ScriptingBaseScript getScript(String name);

    /**

     * Returns the {@link ScriptingFolder} associated with the file specified

     *

     * @param file File where is contained the {@link ScriptingFolder}'s

     * information

     *

     * @return {@link ScriptingFolder}

     */

    public ScriptingFolder getFolder(File file);

    /**

     * Return the {@link ScriptingUnit} associated with the path specified.

     *

     * the path should start with "User" or "System".

     *

     * @param pathName

     *

     * @return the required {@link ScriptingUnit}

     */

    public ScriptingUnit getUnit(String pathName);

    /**

     * Returns the path of the User's Folder

     *

     * @return a String with the path of the User's Folder

     */

//    public String getRootUserFolder();

    /**

     * Registers a File System with {@link ScriptingUnit}s in the SystemFolder

     *

     * @param name String with the identificator name of the File System

     * registered

     * @param folder File with the root of the File System to register

     */

    public void registerSystemFolder(String name, File folder);

    public List<String> getSupportedLanguages();

    public String getExtensionOfLanguage(String language);

    public String getEngineNameByLanguage(String langName);

    public Set<String> getEnginesIsolationGroups();

    /**

     * Checks if an id is unique in a determinate folder

     *

     * @param folder {

     * @ScriptingFolder} with the directory to verify the id

     * @param id String with the id to validate

     *

     * @return true if there isn't another {@link ScriptingUnit} with the same

     * id, and false in the other case

     */

    public boolean validateUnitId(ScriptingFolder folder, String id);

    /**

     * 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

     *

     * @param key The name of named value to add

     * @param value The value of named value to add.

     */

    public void put(String key, Object value);

    /**

     * Retrieves a value set in the state of this ScriptingManager

     *

     * @param key The key whose value is to be returned

     *

     * @return an Object with the value corresponding to the key

     */

    public Object get(String key);

    public void addLibFolder(File lib);

    public File getRootUserFolder();

    public ProviderFactory getInstallerFactory();

    /**

     * Devuelbe la carpeta en la que se encuentran los paquetes

     * de la aplicacion.

     *

     * @return

     */

    public File getPackagesFolder();

    /**

     * Establece la carpeta en la que se encuentran los paquetes

     * de la aplicacion.

     * @param folder

     */

    public void setPackagesFolder(File folder);

    /**

     * Search the available engines and initialize the manager.

     */

    public void loadEngines();

    public List<File> getLibFolders();

    /**

     * 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.

     *

     * @return a map with suffix and labels of library versions.

     */

    public Map<String,String> getLibFoldersVersions();

    /**

     * <p>

     * Returns a reference to an object (property) associated to this layer.</p>

     *

     * <p>

     * For example, you can attach a network definition to key "network" and

     * check

     * if a layer has a network loaded using

     * <i>getAssociatedObject("network")</i> and

     * that it's not null.</p>

     *

     * @param key the key associated to the property

     *

     * @return <code>null</code> if key is not found

     *

     * @see #getExtendedProperties()

     * @see #setProperty(Object, Object)

     */

    public Object getProperty(Object key);

    /**

     * Inserts an object as a property to this layer.

     *

     * @param key the key associated to the property

     * @param obj the property

     *

     * @see #getProperty(Object)

     * @see #getExtendedProperties()

     */

    public void setProperty(Object key, Object obj);

    /**

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

     *

     * @return hash table with the added properties

     *

     * @see #getProperty(Object)

     * @see #setProperty(Object, Object)

     */

    public Map getExtendedProperties();

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

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

}