exe.pseudocode
Class PseudoCodeDisplay

java.lang.Object
  extended by exe.pseudocode.PseudoCodeDisplay

public class PseudoCodeDisplay
extends java.lang.Object

PsuedoCodeDisplay.java - This program is used to generate a URI String from a pseudocode XML file (defined by pseudo.dtd). For more information, see the documentation for the pseudo_uri method.

Author:
Justin Henry, William Gates

Field Summary
static int BLUE
           
static int GRAY
           
static int GREEN
           
static int ORANGE
           
static int PURPLE
           
static int RED
           
static int YELLOW
           
 
Constructor Summary
PseudoCodeDisplay(java.lang.String fileName)
          Constructor - creates a new instance of the PseudoCodeDisplay class.
 
Method Summary
 java.lang.String pseudo_uri(java.util.HashMap<java.lang.String,java.lang.String> vars, int selected)
           
 java.lang.String pseudo_uri(java.util.HashMap<java.lang.String,java.lang.String> vars, int[] selected)
           
 java.lang.String pseudo_uri(java.util.HashMap<java.lang.String,java.lang.String> vars, int[] selected, int[] lineColors)
          This is the main method of the overloaded pseudo_uri method.
 java.lang.String pseudo_uri(java.util.HashMap<java.lang.String,java.lang.String> vars, int selected, int color)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RED

public static final int RED
See Also:
Constant Field Values

ORANGE

public static final int ORANGE
See Also:
Constant Field Values

YELLOW

public static final int YELLOW
See Also:
Constant Field Values

GREEN

public static final int GREEN
See Also:
Constant Field Values

BLUE

public static final int BLUE
See Also:
Constant Field Values

PURPLE

public static final int PURPLE
See Also:
Constant Field Values

GRAY

public static final int GRAY
See Also:
Constant Field Values
Constructor Detail

PseudoCodeDisplay

public PseudoCodeDisplay(java.lang.String fileName)
                  throws org.jdom.JDOMException,
                         java.io.IOException
Constructor - creates a new instance of the PseudoCodeDisplay class. The constructor also initializes the original document tree which is built from the file which the user passes in.

Parameters:
fileName - the name of the XML file (defined by pseudo.dtd)
Throws:
org.jdom.JDOMException
java.io.IOException
Method Detail

pseudo_uri

public java.lang.String pseudo_uri(java.util.HashMap<java.lang.String,java.lang.String> vars,
                                   int[] selected,
                                   int[] lineColors)
                            throws org.jdom.JDOMException
This is the main method of the overloaded pseudo_uri method. All other versions call this one with some modification of their parameters.

Parameters:
vars - a HashMap of the variables to be replaced in the XML template
selected - which line numbers should be highlighted
lineColors - what color each line should be highlighted
Returns:
a valid URI in String format with its special characters escaped
Throws:
org.jdom.JDOMException

pseudo_uri

public java.lang.String pseudo_uri(java.util.HashMap<java.lang.String,java.lang.String> vars,
                                   int selected)
                            throws org.jdom.JDOMException
Throws:
org.jdom.JDOMException

pseudo_uri

public java.lang.String pseudo_uri(java.util.HashMap<java.lang.String,java.lang.String> vars,
                                   int selected,
                                   int color)
                            throws org.jdom.JDOMException
Throws:
org.jdom.JDOMException

pseudo_uri

public java.lang.String pseudo_uri(java.util.HashMap<java.lang.String,java.lang.String> vars,
                                   int[] selected)
                            throws org.jdom.JDOMException
Throws:
org.jdom.JDOMException