|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectstory.scheherazade.virgil.help.Scheherazade_Help
public class Scheherazade_Help
This class is responsible for holding the different Scheherazade help data structures The three data structures are: -HelpTopic -> Involves a header and information about that header and possibly additional children topics -FAQ -> Involves a question and an answer in the form of strings -Icon -> Involves an icon name and a brief description of that icon All data structures carry special unique name identifiers (i.e. t_ID for "topic ID") HelpTopics are stored in Scheherazade_Help as a vector of top level HelpTopics FAQs are stored in Scheherazade_Help as a hash table with the key being the question ID and the value being the FAQ object Icons are stored in Scheherazade_Help as a hash table with the key being the icon ID and the value being the Icon object
Field Summary | |
---|---|
static java.lang.String |
F_ID
|
static java.lang.String |
FAQ
|
static java.lang.String |
HELP
|
static java.lang.String |
HELP_FILE
|
static java.lang.String |
I_ID
|
static java.lang.String |
ICON
|
static java.lang.String |
T_ID
|
static java.lang.String |
TOPIC
|
Constructor Summary | |
---|---|
Scheherazade_Help()
Constructor Sets up the DOM and attempts to parse the xml file at the target location indicated above Throws errors and warnings as necessary using HelpErrorHandler Ensures validity of xml file based on dtd |
Method Summary | |
---|---|
java.util.Hashtable<java.lang.String,FAQ> |
getFAQHash()
Keys = FAQ IDs Values = FAQ objects |
java.util.Vector<HelpTopic> |
getHelpVector()
Returns a vector of all HelpTopics |
java.util.Hashtable<java.lang.String,Icon> |
getIconHash()
Keys = Icon IDs Values = Icon objects |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String HELP
public static final java.lang.String TOPIC
public static final java.lang.String FAQ
public static final java.lang.String ICON
public static final java.lang.String T_ID
public static final java.lang.String F_ID
public static final java.lang.String I_ID
public static final java.lang.String HELP_FILE
Constructor Detail |
---|
public Scheherazade_Help() throws Scheherexception
Scheherexception
Method Detail |
---|
public java.util.Vector<HelpTopic> getHelpVector()
public java.util.Hashtable<java.lang.String,FAQ> getFAQHash()
public java.util.Hashtable<java.lang.String,Icon> getIconHash()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |