Application: gvSIG desktop » gvSIG scripting

package org.gvsig.scripting;

import java.io.File;

import java.net.URL;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import javax.help.HelpSet;

/**

 * This class is responsable of the management of the Help services provided to the application.

 * It shows all the methods applied to the JavaDocs imported on the ScriptingFramework

 *

 * @see ScriptingManager

 */

public interface ScriptingHelpManager {

        /**

         * Interface that represents each JavaDoc imported to the application

         *

         */

        public interface ScriptingHelpAPI{

                /**

                 * Gets the JavaDoc's identificator

                 * 

                 * @return a String with the name of the JavaDoc imported identificator

                 */

                public String getName();

        }

        /**

         * Interface that represents a class contained on the JavaDocs

         *

         */

        public interface ScriptingHelpClass{

                /**

                 * Gets the name of the class

                 * 

                 * @return a String with the Class' name

                 */

                public String getName();

                /**

                 * Gets the URL of the resource that contains the JavaDoc of this class

                 * 

                 * @return a String with the URL.

                 */

                public String getUrl();

        }

        /**

         * Interface that represents a method implemented by a class of the JavaDoc 

         *

         */

        public interface ScriptingHelpMethod extends Iterable{

                /**

                 * Gets the method's name

                 * 

                 * @return a String with the method's name

                 */

                public String getName();

                /**

                 * Gets an Iterator of the {@link ScriptingHelpClass}es which implements that method  

                 * 

                 */

                public Iterator<ScriptingHelpClass> iterator();

        }

        /**

         * Returns the directory of the Help's content

         * 

         * @return a File with the Help's Folder 

         */

        public File getFolder();

        /**

         * Gets a List of the JavaDocs imported

         * 

         * @return a List of the {@link ScriptingHelpAPI}s imported in the application

         */

        public List<ScriptingHelpAPI> getAPI();

        /**

         * Gets a List of all the {@link ScriptingHelpMethod}s contained on the JavaDocs

         * 

         * @return a List of the {@link ScriptingHelpMethod}s on all the {@link ScriptingHelpAPI}s imported

         */        

        public List<ScriptingHelpMethod> getMethods();

        /**

         * Gets the methods of all the classes includes on the JavaDocs which matches with the text provided

         * 

         * @param a text String with the text to get the methods that contains it

         * 

         * @return a HashMap with the references founded

         * 

         */

        public Map<String,ScriptingHelpMethod> findMethods(String text);

        /**

         * Returns the HelpSet with the Help information of the JavaDocs registered

         * 

         * @return a HelpSet with the Help content

         */

        public HelpSet getHelpSet();

        /**

         * Reloads the Help information of the JavaDocs

         * 

         */

        public void reloadHelp();

        /**

         * Removes a help module from the application's helpset

         * 

         * @param name String with the identificator of the module help to remove

         * 

         */

        public void removeHelp(String name);

        /**

         * Checks if exists a help module from the application's helpset with the same identificator

         * 

         * @param name String with the identificator of the module help to check

         * 

         * @return true if exists, false if not

         * 

         */

        public boolean existsHelp(String name);

        /**

         * Adds a new help module to the application's helpset with the identificator specified

         * 

         * @param name String with the identificator of the module help to add

         * @param url URL with the root directory of the help to import 

         * 

         * @return true if exists, false if not

         * 

         */

        public void importHelp(String name, URL url);

}