agentland.help
Class JavaHelpAgent

java.lang.Object
  |
  +--java.rmi.server.RemoteObject
        |
        +--java.rmi.server.RemoteServer
              |
              +--java.rmi.server.UnicastRemoteObject
                    |
                    +--metaglue.AgentAgent
                          |
                          +--agentland.util.GoodAgent
                                |
                                +--agentland.resource.ManagedAgent
                                      |
                                      +--agentland.help.JavaHelpAgent

All Implemented Interfaces:

Agent, Good, JavaHelp, Managed, MetagluePrimitives, Remote, Serializable, Spy

public class JavaHelpAgent

extends ManagedAgent

implements JavaHelp

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:

ManagedAgent, JavaHelp, Serialized Form

Inner classes inherited from class metaglue.AgentAgent

AgentAgent.Attribute

Fields inherited from class agentland.resource.ManagedAgent

rm, society

Fields inherited from class agentland.util.GoodAgent

alert, notifier

Fields inherited from class java.rmi.server.RemoteObject

ref

Fields inherited from interface metaglue.Agent

ALIVE, DIED, NO_METAGLUE, NOT_RUNNING, STARTING

Constructor Summary

JavaHelpAgent()
Creates a new JavaHelpAgent instance.

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 class agentland.resource.ManagedAgent

connect, getAlert, getNeed, isAvailable, isAvailable, reliesOn, reliesOn, replace, replace, request, request, request, requestAgent, requestAgent, resources, resourcesByAgentID, setNeed, tiedTo, yank, yank, yank

Methods inherited from class agentland.util.GoodAgent

addSpy, addSpy, alert, alertString, beep, error, getHistory, getHistoryElement, getPersistentMap, log, notify, removeSpy, removeSpy, resetHistory, safeRely, safeRely, safeRely, setNiceLogName, tell

Methods inherited from class metaglue.AgentAgent

addMonitor, alive, defrost, defrostAll, defrostBoolean, defrostInt, defrostString, fixAttribute, fixAttribute, freeze, freeze, freeze, freezeAll, freezeVar, getAgentID, getAttribute, getCatalog, getCatalogID, getDesignation, getFrozenVariables, getLogLevel, getMetaglueAgent, getMetaglueAgentID, getOccupation, getProperties, getSociety, log, log, lookupClass, obtainMetaglueAgent, obtainMetaglueAgent, obtainMetaglueAgentByName, reliesOn, reliesOnSynch, removeFrozen, replaceExceptionHandler, setFreezeName, setLogLevel, setLogName, shutdown, startAgent, startAgentOn, startAgentOn, startup, status, tiedTo, tiedTo, tiedTo, tiedTo, tieToDesignation, whereAreYou

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

Constructor Detail

JavaHelpAgent

public JavaHelpAgent()
              throws RemoteException

Creates a new JavaHelpAgent instance.

Throws:

RemoteException - if an error occurs

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.

Specified by:

generateJavaHelpFiles in interface JavaHelp

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.

Specified by:

generateHelpSet in interface JavaHelp

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.

Specified by:

generateMap in interface 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.

Specified by:

generateTOC in interface 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.

Specified by:

generateIndex in interface 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.

Specified by:

getHelpSetFile in interface JavaHelp

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.

Specified by:

getHelpSetFullName in interface JavaHelp

Returns:

a String value

Throws:

RemoteException - if an error occurs

getMapFile

public File getMapFile()
                throws RemoteException

Returns the Map file as a File object.

Specified by:

getMapFile in interface JavaHelp

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.

Specified by:

getMapFullName in interface JavaHelp

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.

Specified by:

getMapURL in interface JavaHelp

Returns:

an URL value

Throws:

RemoteException - if an error occurs