story.scheherazade.virgil.help
Class Scheherazade_Help

java.lang.Object
  extended by story.scheherazade.virgil.help.Scheherazade_Help

public class Scheherazade_Help
extends java.lang.Object

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

Author:
Marshall

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

HELP

public static final java.lang.String HELP
See Also:
Constant Field Values

TOPIC

public static final java.lang.String TOPIC
See Also:
Constant Field Values

FAQ

public static final java.lang.String FAQ
See Also:
Constant Field Values

ICON

public static final java.lang.String ICON
See Also:
Constant Field Values

T_ID

public static final java.lang.String T_ID
See Also:
Constant Field Values

F_ID

public static final java.lang.String F_ID
See Also:
Constant Field Values

I_ID

public static final java.lang.String I_ID
See Also:
Constant Field Values

HELP_FILE

public static final java.lang.String HELP_FILE
See Also:
Constant Field Values
Constructor Detail

Scheherazade_Help

public Scheherazade_Help()
                  throws Scheherexception
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

Throws:
Scheherexception
Method Detail

getHelpVector

public java.util.Vector<HelpTopic> getHelpVector()
Returns a vector of all HelpTopics

Returns:
a vector of HelpTopics

getFAQHash

public java.util.Hashtable<java.lang.String,FAQ> getFAQHash()
Keys = FAQ IDs Values = FAQ objects

Returns:
a Hash table of full of FAQ data

getIconHash

public java.util.Hashtable<java.lang.String,Icon> getIconHash()
Keys = Icon IDs Values = Icon objects

Returns:
a Hash table full of Icon Data


Copyright © 2011 David K. Elson. All Rights Reserved.