All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class SHOE.SHOE_Obj

java.lang.Object
   |
   +----SHOE.SHOE_Obj

public abstract class SHOE_Obj
extends Object
An abstract class that can be used to refer to any type of SHOE tag. In addition to overriding the abstract classes, sub-classes of SHOE_Obj must create a constructor that receives an SGML_Tag and must have a toString() method. If the object could contain other tags, then the class must also have a readSubTags() method.


Variable Index

 o C_EQUAL
A constant that indicates a comparison for equality.
 o C_GREATER
A constant that indicates a comparison that is true if the first argument is greater than the second.
 o C_GREATER_OR_EQUAL
A constant that indicates a comparison that is true if the first argument is greater than or equal to the second.
 o C_LESS
A constant that indicates a comparison that is true if the first argument is less than the second.
 o C_LESS_OR_EQUAL
A constant that indicates a comparison that is true if the first argument is less than or equal to the second.
 o C_NOT_EQUAL
A constant that indicates a comparison for inequality.
 o C_UNDEFINED
A constant that indicates that the comparison operator is undefined.
 o contents
Used to store child tokens and objects
 o newline
OS specific line separator
 o U_VAL
A constant that indicates an argument reprents a literal value.
 o U_VAR
A constant that indicates an argument reprents a variable.

Constructor Index

 o SHOE_Obj()

Method Index

 o addSHOEtoContents(SHOE_Obj, String)
Inserts an object into the content list.
 o getContentTokens()
Returns and enumeration specifying all (non-SHOE) tokens contained between this SHOE Object's start and end tags.
 o getKey()
Returns an identifier for the SHOE object.
 o printContents(PrintStream)
Print the text, HTML tags and SHOE tags contained within the object.
 o printSGML(PrintStream)
Writes the objects and its components to the given print stream in SGML format.
 o readSubTags(HTML_Tokenizer)
Reads and processes the tokens from an HTML_Tokenizer until the appropriate closing tag is encountered.
 o sortObjectEnum(Enumeration)
Given an enumeration of SHOE objects, returns a vector of the same objects sorted in order by their key.
 o sortObjectVector(Vector)
Given a vector of SHOE objects, returns a vector of the same objects sorted in order by their key.

Variables

 o U_VAR
 public static final byte U_VAR
A constant that indicates an argument reprents a variable.

 o U_VAL
 public static final byte U_VAL
A constant that indicates an argument reprents a literal value.

 o C_EQUAL
 public static final int C_EQUAL
A constant that indicates a comparison for equality.

 o C_NOT_EQUAL
 public static final int C_NOT_EQUAL
A constant that indicates a comparison for inequality.

 o C_GREATER
 public static final int C_GREATER
A constant that indicates a comparison that is true if the first argument is greater than the second.

 o C_GREATER_OR_EQUAL
 public static final int C_GREATER_OR_EQUAL
A constant that indicates a comparison that is true if the first argument is greater than or equal to the second.

 o C_LESS
 public static final int C_LESS
A constant that indicates a comparison that is true if the first argument is less than the second.

 o C_LESS_OR_EQUAL
 public static final int C_LESS_OR_EQUAL
A constant that indicates a comparison that is true if the first argument is less than or equal to the second.

 o C_UNDEFINED
 public static final int C_UNDEFINED
A constant that indicates that the comparison operator is undefined.

 o contents
 protected Vector contents
Used to store child tokens and objects

 o newline
 protected static String newline
OS specific line separator

Constructors

 o SHOE_Obj
 public SHOE_Obj()

Methods

 o sortObjectVector
 public static Vector sortObjectVector(Vector shoeVec)
Given a vector of SHOE objects, returns a vector of the same objects sorted in order by their key.

 o sortObjectEnum
 public static Vector sortObjectEnum(Enumeration shoeEnum)
Given an enumeration of SHOE objects, returns a vector of the same objects sorted in order by their key.

 o getKey
 public abstract String getKey()
Returns an identifier for the SHOE object. Depending on the type of object, it may or may not be unique.

 o readSubTags
 public abstract Vector readSubTags(HTML_Tokenizer intokens)
Reads and processes the tokens from an HTML_Tokenizer until the appropriate closing tag is encountered.

 o printSGML
 public abstract void printSGML(PrintStream out)
Writes the objects and its components to the given print stream in SGML format.

 o addSHOEtoContents
 protected void addSHOEtoContents(SHOE_Obj obj,
                                  String pretext)
Inserts an object into the content list. If the last element in the list is a text token, then the new object is inserted before it, otherwise it is inserted at the end. This is so that formatting is maintained properly since the last element typically sets up the position of the closing tag. The pretext argument is a string that is inserted before the SHOE tag.

 o getContentTokens
 protected Enumeration getContentTokens()
Returns and enumeration specifying all (non-SHOE) tokens contained between this SHOE Object's start and end tags. If the object is empty, an empty enumeration is returned.

 o printContents
 protected void printContents(PrintStream out)
Print the text, HTML tags and SHOE tags contained within the object.


All Packages  Class Hierarchy  This Package  Previous  Next  Index