EDU.bmrb.starlibj
Class StarFileNode

java.lang.Object
  |
  +--EDU.bmrb.starlibj.StarNode
        |
        +--EDU.bmrb.starlibj.StarFileNode

public class StarFileNode
extends StarNode
implements java.lang.Cloneable

StarFileNode is the mother of all STAR nodes (literally). This node is the root of the whole star tree for a star file. If a star file is parsed in with the parser, it produces an object of this type, which in turn contains the rest of the tree.


Field Summary
protected  StarListVector myStarList
           
 SkipTextHandler skipper
           
 
Fields inherited from class EDU.bmrb.starlibj.StarNode
colNum, lineNum, parent, preComment
 
Constructor Summary
StarFileNode()
          Constructor - makes an empty star file:
StarFileNode(StarFileNode copyMe)
          Copy Constructor - makes a copy of an existing tree:
 
Method Summary
 void addElement(java.lang.Object obj)
          Just like the Vector method of the same name.
 java.lang.Object clone()
          Allocates a new copy of me and returns a reference to it.
 boolean contains(java.lang.Object obj)
          Just like the Vector method of the same name.
 BlockNode elementAt(int index)
          Just like the Vector method of the same name.
 java.util.Enumeration elements()
          Just like the Vector method of the same name.
 BlockNode firstElement()
          Just like the Vector method of the same name.
 int indexOf(java.lang.Object obj)
          Just like the Vector method of the same name.
 int indexOf(java.lang.Object obj, int index)
          Just like the Vector method of the same name.
 void insertElementAt(java.lang.Object obj, int index)
          Just like the Vector method of the same name.
 boolean isEmpty()
          Just like the Vector method of the same name.
 BlockNode lastElement()
          Just like the Vector method of the same name.
 int lastIndexOf(java.lang.Object obj)
          Just like the Vector method of the same name.
 int lastIndexOf(java.lang.Object obj, int index)
          Just like the Vector method of the same name.
 SkipTextHandler mySkips()
           
 boolean removeElement(java.lang.Object obj)
          Just like the Vector method of the same name.
 void removeElementAt(int index)
          Similar to the Vector method of the same name.
 VectorCheckType searchByName(java.lang.String searchFor)
          Given a tag name, find the AST object it resides in.
 VectorCheckType searchByTagValue(java.lang.String tag, java.lang.String value)
          Given a tag name and a value, find the AST object that that particular tag and value pair resides in.
 VectorCheckType searchForType(java.lang.Class type, short delim)
          This method returns a vector of all the nodes of the given type.
 void setElementAt(java.lang.Object obj, int index)
          Just like the Vector method of the same name.
 void setSize(int newSize)
          Just like the Vector method of the same name.
 int size()
          Just like the Vector method of the same name.
 
Methods inherited from class EDU.bmrb.starlibj.StarNode
getColNum, getLineNum, getParallelCopy, getParent, getPreComment, searchForTypeByName, searchForTypeByTagValue, setColNum, setLineNum, setParent, setPeer, setPreComment, Unparse
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

skipper

public SkipTextHandler skipper

myStarList

protected StarListVector myStarList
Constructor Detail

StarFileNode

public StarFileNode()
Constructor - makes an empty star file:

StarFileNode

public StarFileNode(StarFileNode copyMe)
Copy Constructor - makes a copy of an existing tree:
Method Detail

setSize

public void setSize(int newSize)
Just like the Vector method of the same name. Makes enough room so that there can be newSize elements in the node, without having to insert them manually one at a time. The nodes start out will a null value that can be replaced with setElementAt.
See Also:
VectorCheckType.setSize

size

public int size()
Just like the Vector method of the same name. Returns the number of block elements in this Star File.
See Also:
java.util.Vector.size

isEmpty

public boolean isEmpty()
Just like the Vector method of the same name. True if the star file has nothing in it.
See Also:
java.util.Vector.isEmpty

elements

public java.util.Enumeration elements()
Just like the Vector method of the same name. Gives an enumeration over the blocks in the star file.
See Also:
java.util.Vector.Enumeration

contains

public boolean contains(java.lang.Object obj)
Just like the Vector method of the same name. True if the node given is a BlockNode inside this StarFileNode.
Parameters:
obj - The BlockNode to look for.
See Also:
java.util.Vector.contains

indexOf

public int indexOf(java.lang.Object obj)
Just like the Vector method of the same name. Returns the integer index of the Given BlockNode inside this StarFileNode.
Parameters:
obj - The BlockNode to look for.
See Also:
java.util.Vector.indexOf

indexOf

public int indexOf(java.lang.Object obj,
                   int index)
Just like the Vector method of the same name. Returns the integer index of the next BlockNode inside this StarFileNode, starting at the index given.
Parameters:
obj - The BlockNode to look for.
index - Start searching at this point in the vector.
See Also:
java.util.Vector.indexOf

lastIndexOf

public int lastIndexOf(java.lang.Object obj)
Just like the Vector method of the same name. Returns the lastmost integer index of the given BlockNode.
Parameters:
obj - The BlockNode to look for.
See Also:
java.util.Vector.lastIndexOf

lastIndexOf

public int lastIndexOf(java.lang.Object obj,
                       int index)
Just like the Vector method of the same name. Returns the lastmost integer index of the given BlockNode, but going no higher than the given index.
Parameters:
obj - The BlockNode to look for.
index - Start searching back from this point in the vector.
See Also:
java.util.Vector.lastIndexOf

elementAt

public BlockNode elementAt(int index)
Just like the Vector method of the same name. Returns the BlockNode object at the given index.
Parameters:
index - The index to return the BlockNode at.
Returns:
The Returned Object is a BlockNode and can be safely casted to BlockNode.
See Also:
java.util.Vector.elementAt

firstElement

public BlockNode firstElement()
Just like the Vector method of the same name. Returns the first BlockNode object in the file.
Returns:
The Returned Object is a BlockNode and can be safely casted to BlockNode.
See Also:
java.util.Vector.firstElement

lastElement

public BlockNode lastElement()
Just like the Vector method of the same name. Returns the last Blocknode object in the file.
Returns:
The Returned Object is a BlockNode and can be safely casted to BlockNode.
See Also:
java.util.Vector.lastElement

setElementAt

public void setElementAt(java.lang.Object obj,
                         int index)
                  throws WrongElementType
Just like the Vector method of the same name. Clobbers the BlockNode at the given index with the blocknode given.
Parameters:
obj - The BlockNode to set it to.
index - the position to replace.
See Also:
java.util.Vector.setElementAt

removeElementAt

public void removeElementAt(int index)
Similar to the Vector method of the same name. Deletes the BlockNode at the given index from the star file node.
Parameters:
index - the position to remove.
See Also:
java.util.Vector.removeElementAt

insertElementAt

public void insertElementAt(java.lang.Object obj,
                            int index)
                     throws WrongElementType
Just like the Vector method of the same name. Inserts a Blocknode.
Parameters:
obj - The BlockNode to insert.
index - the position to insert before.
See Also:
java.util.Vector.insertElementAt

addElement

public void addElement(java.lang.Object obj)
                throws WrongElementType
Just like the Vector method of the same name. Adds a BlockNode to the end of the list.
Parameters:
obj - The BlockNode to add.
See Also:
java.util.Vector.addElement

removeElement

public boolean removeElement(java.lang.Object obj)
Just like the Vector method of the same name. Removes the Blocknode matching the one given.
Parameters:
obj - The BlockNode to remove.
See Also:
java.util.Vector.removeElement

clone

public java.lang.Object clone()
Allocates a new copy of me and returns a reference to it. This is a deep copy, meaning that all children are copied instead of linked.
Overrides:
clone in class StarNode

searchByName

public VectorCheckType searchByName(java.lang.String searchFor)
Given a tag name, find the AST object it resides in. It returns a reference to the lowest level AST object that the tag resides in. The caller needs to use the type-aware features of Java to discover what the object's type really is.

The search for names is case-insensitive.

Parameters:
searchFor - - Look for this string as the tag name.
Overrides:
searchByName in class StarNode

searchByTagValue

public VectorCheckType searchByTagValue(java.lang.String tag,
                                        java.lang.String value)
Given a tag name and a value, find the AST object that that particular tag and value pair resides in. This is like performing an SQL search: WHERE tag = value.

Only searches starting at the node it was called from, and its children. Recurses downward, but does not recurse upward. This function is only capable of returning one answer, so it cannot be called at the same levels where searchByTag() can be called (see above).

The search for tag names is case-insensitive.

The search for values, however is case-sensitive.

Parameters:
tag - - Look for this tag...
value - - Where it has this value.
Returns:
A java.util.vector containing the matching StarNodes. This vector will have a size of zero if there are no matches.
Overrides:
searchByTagValue in class StarNode

searchForType

public VectorCheckType searchForType(java.lang.Class type,
                                     short delim)
This method returns a vector of all the nodes of the given type. It is much like searchByName() in that it heirarchically walks the STAR tree and calls the searchForType() functions of the subtrees within the tree. In this way it is possible to call this function at any level of the STAR file.

The second parameter is optional and is only useful when you are searching for DataValueNodes. It determines the kind of DataValueNode you are searching for, by delimiter type. For example, you could search for only those DataValueNodes that are semicolon-delimited by passing DataValueNode::SEMICOLON as the second argument. Or you could look for just framecodes by passing DataValueNode::FRAMECODE as the second parameter. Passing a negative number says you want all the DataValueNodes, regardless of their delimiter type.

If the search is for some ASTtype other than DataValueNode, then it is irrelevant what the second parameter of this function is, as it will never be used - You can just leave it off and accept the default.

Parameters:
type - - type to search for
delim - - DataValueNode::ValType to look for. Default = "dont-care".
Returns:
A java.util.vector containing the matching StarNodes. This vector will have a size of zero if there are no matches.
Overrides:
searchForType in class StarNode

mySkips

public SkipTextHandler mySkips()
Overrides:
mySkips in class StarNode