agentland.help
Interface JavaHelp

All Superinterfaces:

Agent, Good, Managed, Remote, Spy

All Known Implementing Classes:

JavaHelpAgent

public interface JavaHelp

extends Managed

JavaHelp is the interface for JavaHelpAgent. The JavaHelpAgent is the interface between Metaglue and Sun's JavaHelp system. This agent creates various XML files needed by JavaHelp in order to display HTML help files.

See Also:

Good

Fields inherited from interface metaglue.Agent

ALIVE, DIED, NO_METAGLUE, NOT_RUNNING, STARTING

Method Summary

void	generateHelpSet(String sHelpSetName, String sBasePath) Generates the HelpSet .hs file.
void	generateIndex(String sHelpSetName, Vector vInput, String sBasePath) Generates the Index file needed by JavaHelp.
void	generateJavaHelpFiles(String sHelpSetName, Vector vHelpFiles, Vector vSortedHelpFiles, String sBasePath) Generates the XML files needed by the JavaHelp system.
void	generateMap(String sHelpSetName, Vector vInput, String sBasePath) Generates the map file needed by JavaHelp.
void	generateTOC(String sHelpSetName, Vector vInput, String sBasePath) Generates the Table Of Contents file neede by JavaHelp.
File	getHelpSetFile() Returns the HelpSet file as a File object.
String	getHelpSetFullName() Returns the full name (including path) of the HelpSet file.
File	getMapFile() Returns the Map file as a File object.
String	getMapFullName() Returns the full name (including path) of the Map file.
URL	getMapURL() Returns the location of the Map file as a URL.

Methods inherited from interface agentland.resource.Managed

getNeed, replace, replace, resources, yank, yank

Methods inherited from interface agentland.util.Good

getHistory, getHistoryElement, resetHistory

Methods inherited from interface metaglue.Agent

addMonitor, alive, getAgentID, getMetaglueAgentID, shutdown, startup, whereAreYou

Methods inherited from interface agentland.util.Spy

tell

Method Detail

generateJavaHelpFiles

public void generateJavaHelpFiles(String sHelpSetName,
                                  Vector vHelpFiles,
                                  Vector vSortedHelpFiles,
                                  String sBasePath)
                           throws RemoteException

Generates the XML files needed by the JavaHelp system. This method is called by the HelpFileManager to create or update the index files used by the JavaHelp browser.

Parameters:

sHelpSetName - a String value

vHelpFiles - a Vector value

vSortedHelpFiles - a Vector value

sBasePath - a String value

Throws:

RemoteException - if an error occurs

generateHelpSet

public void generateHelpSet(String sHelpSetName,
                            String sBasePath)
                     throws RemoteException

Generates the HelpSet .hs file.

Parameters:

sHelpSetName - a String value of the HelpSet's name.

sBasePath - a String value of the path where the HelpSet file should be located.

Throws:

RemoteException - if an error occurs

generateMap

public void generateMap(String sHelpSetName,
                        Vector vInput,
                        String sBasePath)
                 throws RemoteException

Generates the map file needed by JavaHelp.

Parameters:

sHelpSetName - a String value

vInput - a Vector value

sBasePath - a String value

Throws:

RemoteException - if an error occurs

generateTOC

public void generateTOC(String sHelpSetName,
                        Vector vInput,
                        String sBasePath)
                 throws RemoteException

Generates the Table Of Contents file neede by JavaHelp.

Parameters:

sHelpSetName - a String value

vInput - a Vector value

sBasePath - a String value

Throws:

RemoteException - if an error occurs

generateIndex

public void generateIndex(String sHelpSetName,
                          Vector vInput,
                          String sBasePath)
                   throws RemoteException

Generates the Index file needed by JavaHelp.

Parameters:

sHelpSetName - a String value

vInput - a Vector value

sBasePath - a String value

Throws:

RemoteException - if an error occurs

getHelpSetFile

public File getHelpSetFile()
                    throws RemoteException

Returns the HelpSet file as a File object.

Returns:

a File value

Throws:

RemoteException - if an error occurs

getHelpSetFullName

public String getHelpSetFullName()
                          throws RemoteException

Returns the full name (including path) of the HelpSet file.

Returns:

a String value

Throws:

RemoteException - if an error occurs

getMapFile

public File getMapFile()
                throws RemoteException

Returns the Map file as a File object.

Returns:

a File value

Throws:

RemoteException - if an error occurs

getMapFullName

public String getMapFullName()
                      throws RemoteException

Returns the full name (including path) of the Map file.

Returns:

a String value

Throws:

RemoteException - if an error occurs

getMapURL

public URL getMapURL()
              throws RemoteException

Returns the location of the Map file as a URL.

Returns:

an URL value

Throws:

RemoteException - if an error occurs