Application: gvSIG desktop » gvSIG scripting

package org.gvsig.scripting;

import java.io.File;

import java.util.List;

import java.util.Map;

/**

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

 * @see ScriptingHelpManager

 */

public interface ScriptingManager {

        public static final String UNIT_SCRIPT = "Script";

        public static final String UNIT_DIALOG = "Dialog";

        public static final String UNIT_PROJECT = "Project";

        public static final String UNIT_FOLDER = "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();

        /**

         * Sets a new path to the User's Folder

         * 

         * @param path a String with the new path to the User's Folder

         */

        public void setRootUserFolder(String path);

        /**

         * Creates a new instance of {@link ScriptingScript} named as the id and in the directory specified

         * 

         * @param folder {@link ScriptingFolder} with the destiny directory information

         * @param id String with the identificator of the {@link ScriptingScript} created

         * 

         * @return the new {@link ScriptingScript}

         * @deprecated see {@link #createUnit(String, ScriptingFolder, String)}

         */

        @Deprecated

    public ScriptingScript createScript(ScriptingFolder folder, String id);

        /**

         * Creates a new instance of {@link ScriptingProject} named as the id and in the directory specified

         * 

         * @param folder {@link ScriptingFolder} with the destiny directory information

         * @param id String with the identificator of the {@link ScriptingProject} created

         * 

         * @return the new {@link ScriptingProject}

         * @deprecated see {@link #createUnit(String, ScriptingFolder, String)}

         */

        @Deprecated

    public ScriptingProject createProject(ScriptingFolder folder, String id);

        /**

         * Creates a new instance of {@link ScriptingDialog} named as the id and in the directory specified

         * 

         * @param folder {@link ScriptingFolder} with the destiny directory information

         * @param id String with the identificator of the {@link ScriptingDialog} created

         * 

         * @return the new {@link ScriptingDialog}

         * @deprecated see {@link #createUnit(String, ScriptingFolder, String)}

         */

        @Deprecated

    public ScriptingDialog createDialog(ScriptingFolder folder, String id);

        /**

         * Creates a new instance of {@link ScriptingFolder} named as the id and in the directory specified

         * 

         * @param folder {@link ScriptingFolder} with the destiny directory information

         * @param id String with the identificator of the {@link ScriptingFolder} created

         * 

         * @return the new {@link ScriptingFolder}

         * @deprecated see {@link #createUnit(String, ScriptingFolder, String)}

         */

        @Deprecated

    public ScriptingFolder createFolder(ScriptingFolder folder, String id);

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

    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);

        /**

         * 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);

        /**

         * 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);

    /**

     * Gets all the supported Language by their extensions associated with each

     * one.

     * 

     * @return a Map with the pairs <key,value> where the key is a String with

     *         the extension and the value is the Language associated

     */

    public Map<String, String> getSupportedLanguagesByExtension();

    /**

     * Gets all the supported Language and the extensions associated with each

     * one.

     * 

     * @return a Map with the pairs <key,value> where the key is a String with

     *         the Language and the value is the extension associated

     */

        public Map<String, String> getExtensionsByLanguages();

        /**

         * 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);

        /**

         * Gets the Help manager 

         * 

         * @return a {@link ScriptingHelpManager}

         * 

         * @see ScriptingHelpManager

         */

        public ScriptingHelpManager getHelpManager();        

}