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.
-
C_EQUAL
- A constant that indicates a comparison for equality.
-
C_GREATER
- A constant that indicates a comparison that is true if the
first argument is greater than the second.
-
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.
-
C_LESS
- A constant that indicates a comparison that is true if the
first argument is less than the second.
-
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.
-
C_NOT_EQUAL
- A constant that indicates a comparison for inequality.
-
C_UNDEFINED
- A constant that indicates that the comparison operator is
undefined.
-
contents
- Used to store child tokens and objects
-
newline
- OS specific line separator
-
U_VAL
- A constant that indicates an argument reprents a literal value.
-
U_VAR
- A constant that indicates an argument reprents a variable.
-
SHOE_Obj()
-
-
addSHOEtoContents(SHOE_Obj, String)
- Inserts an object into the content list.
-
getContentTokens()
- Returns and enumeration specifying all (non-SHOE) tokens contained
between this SHOE Object's start and end tags.
-
getKey()
- Returns an identifier for the SHOE object.
-
printContents(PrintStream)
- Print the text, HTML tags and SHOE tags contained within the object.
-
printSGML(PrintStream)
- Writes the objects and its components to the given print
stream in SGML format.
-
readSubTags(HTML_Tokenizer)
- Reads and processes the tokens from an HTML_Tokenizer until
the appropriate closing tag is encountered.
-
sortObjectEnum(Enumeration)
- Given an enumeration of SHOE objects, returns a vector of the same
objects sorted in order by their key.
-
sortObjectVector(Vector)
- Given a vector of SHOE objects, returns a vector of the same
objects sorted in order by their key.
U_VAR
public static final byte U_VAR
- A constant that indicates an argument reprents a variable.
U_VAL
public static final byte U_VAL
- A constant that indicates an argument reprents a literal value.
C_EQUAL
public static final int C_EQUAL
- A constant that indicates a comparison for equality.
C_NOT_EQUAL
public static final int C_NOT_EQUAL
- A constant that indicates a comparison for inequality.
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.
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.
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.
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.
C_UNDEFINED
public static final int C_UNDEFINED
- A constant that indicates that the comparison operator is
undefined.
contents
protected Vector contents
- Used to store child tokens and objects
newline
protected static String newline
- OS specific line separator
SHOE_Obj
public SHOE_Obj()
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.
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.
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.
readSubTags
public abstract Vector readSubTags(HTML_Tokenizer intokens)
- Reads and processes the tokens from an HTML_Tokenizer until
the appropriate closing tag is encountered.
printSGML
public abstract void printSGML(PrintStream out)
- Writes the objects and its components to the given print
stream in SGML format.
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.
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.
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