org.gvsig.scripting.impl

Class DefaultScriptingHelpManager

java.lang.Object

org.gvsig.scripting.impl.DefaultScriptingHelpManager

All Implemented Interfaces:

ScriptingHelpManager

public class DefaultScriptingHelpManager
extends Object
implements ScriptingHelpManager

Nested Class Summary

Nested classes/interfaces inherited from interface org.gvsig.scripting.ScriptingHelpManager

ScriptingHelpManager.ScriptingHelpClass, ScriptingHelpManager.ScriptingHelpMethod

Field Summary

Fields

Modifier and Type	Field and Description
protected List<File>	helpRoots
protected HelpSet	helpSet
protected IndexerHelper	indexer
protected static Logger	logger
protected MethodList	methodsList

Constructor Summary

Constructors

Constructor and Description
DefaultScriptingHelpManager(ScriptingManager manager)

Method Summary

Modifier and Type	Method and Description
void	addMethods(URL methodsfile)
boolean	existsHelp(String name) Checks if exists a help module from the application's helpset with the same identificator
Map<String,ScriptingHelpManager.ScriptingHelpMethod>	findMethods(String text) Gets the methods of all the classes includes on the JavaDocs which matches with the text provided
ScriptingHelpManager.ScriptingHelpClass	getHelpClass(String name)
List<ScriptingHelpManager.ScriptingHelpClass>	getHelpClasses()
List<File>	getHelpRoots()
HelpSet	getHelpSet() Returns the HelpSet with the Help information of the JavaDocs registered
List<ScriptingHelpManager.ScriptingHelpMethod>	getMethods() Gets a List of all the ScriptingHelpManager.ScriptingHelpMethods contained on the JavaDocs
boolean	importJavadoc(String name, File folder, SimpleTaskStatus status) Adds a new help module to the application's helpset with the identificator specified
void	loadHelps()
URL	makeURL(File helpsetfolder, URL sourceurl)
void	reloadHelp() Reloads the Help information of the JavaDocs
boolean	removeHelp(String name) Removes a help module from the application's helpset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected static final Logger logger

helpSet

protected HelpSet helpSet

indexer

protected IndexerHelper indexer

methodsList

protected MethodList methodsList

helpRoots

protected List<File> helpRoots

Constructor Detail

DefaultScriptingHelpManager

public DefaultScriptingHelpManager(ScriptingManager manager)

Method Detail

loadHelps

public void loadHelps()

makeURL

public URL makeURL(File helpsetfolder,
                   URL sourceurl)

Specified by:

makeURL in interface ScriptingHelpManager

reloadHelp

public void reloadHelp()

Description copied from interface: ScriptingHelpManager

Reloads the Help information of the JavaDocs

Specified by:

reloadHelp in interface ScriptingHelpManager

existsHelp

public boolean existsHelp(String name)

Description copied from interface: ScriptingHelpManager

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

Specified by:

existsHelp in interface ScriptingHelpManager

Parameters:

name - String with the identificator of the module help to check

Returns:

true if exists, false if not

removeHelp

public boolean removeHelp(String name)

Description copied from interface: ScriptingHelpManager

Removes a help module from the application's helpset

Specified by:

removeHelp in interface ScriptingHelpManager

Parameters:

name - String with the identificator of the module help to remove

Returns:

addMethods

public void addMethods(URL methodsfile)

Specified by:

addMethods in interface ScriptingHelpManager

getMethods

public List<ScriptingHelpManager.ScriptingHelpMethod> getMethods()

Description copied from interface: ScriptingHelpManager

Gets a List of all the ScriptingHelpManager.ScriptingHelpMethods contained on the JavaDocs

Specified by:

getMethods in interface ScriptingHelpManager

Returns:

a List of the ScriptingHelpManager.ScriptingHelpMethods on all the ScriptingHelpAPIs imported

getHelpClass

public ScriptingHelpManager.ScriptingHelpClass getHelpClass(String name)

Specified by:

getHelpClass in interface ScriptingHelpManager

getHelpClasses

public List<ScriptingHelpManager.ScriptingHelpClass> getHelpClasses()

Specified by:

getHelpClasses in interface ScriptingHelpManager

findMethods

public Map<String,ScriptingHelpManager.ScriptingHelpMethod> findMethods(String text)

Description copied from interface: ScriptingHelpManager

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

Specified by:

findMethods in interface ScriptingHelpManager

Returns:

a HashMap with the references founded

getHelpRoots

public List<File> getHelpRoots()

Specified by:

getHelpRoots in interface ScriptingHelpManager

getHelpSet

public HelpSet getHelpSet()

Description copied from interface: ScriptingHelpManager

Returns the HelpSet with the Help information of the JavaDocs registered

Specified by:

getHelpSet in interface ScriptingHelpManager

Returns:

a HelpSet with the Help content

importJavadoc

public boolean importJavadoc(String name,
                             File folder,
                             SimpleTaskStatus status)

Description copied from interface: ScriptingHelpManager

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

Specified by:

importJavadoc in interface ScriptingHelpManager

Parameters:

name - String with the identificator of the module help to add

Returns: