mvt.help
Class HelpParser

java.lang.Object
  |
  +--mvt.help.HelpParser

public final class HelpParser

extends java.lang.Object

Takes an xml file and parses it using the following syntax:

<help>
<topic topic="a topic to search for and displayed" location="html file"> <topic topic="another topic" location="another html file">

Field Summary

(package private) java.net.URL

url Internet address of file.

Constructor Summary

HelpParser(java.lang.String uri)
Constructor that sets up the location of the xml file.

Method Summary

HelpIndexList	getHelp() Makes getting the list of objects fast after parsing.
HelpIndexList	parseHelp() Parses the xml file and returns a list of HelpIndexNodes.

Methods inherited from class java.lang.Object

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

Field Detail

url

java.net.URL url

Internet address of file.

Constructor Detail

HelpParser

public HelpParser(java.lang.String uri)
           throws java.net.MalformedURLException

Constructor that sets up the location of the xml file.

Parameters:

uri - the uri to the file xml file.

Throws:

java.net.MalformedURLException

Method Detail

parseHelp

public HelpIndexList parseHelp()
                        throws HelpParserException

Parses the xml file and returns a list of HelpIndexNodes.

Returns:

HelpIndexList a list of HelpIndexNode.

Throws:

HelpParserException - any and all error messages.

See Also:

HelpIndexList, HelpIndexNode

getHelp

public HelpIndexList getHelp()
                      throws HelpParserException

Makes getting the list of objects fast after parsing. If the xml file has not been parsed before it will be parsed, otherwise the list will be returned.

Returns:

HelpIndexList a list of HelpIndexNodes.

Throws:

HelpParserException

See Also:

parseHelp(), HelpIndexList, HelpIndexNode