All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class EDU.bmrb.starlibj.BlockNode

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

public class BlockNode
extends StarNode
implements Cloneable
A single block in the file - this can be either a data block or a global block - they are both handled the same way.


Variable Index

 o myDataList
 o myHeading

Method Index

 o addElement(Object)
Just like the Vector method of the same name.
 o clone()
Allocates a new copy of me and returns a reference to it.
 o contains(Object)
Just like the Vector method of the same name.
 o elementAt(int)
Just like the Vector method of the same name.
 o elements()
Just like the Vector method of the same name.
 o firstElement()
Just like the Vector method of the same name.
 o getLabel()
Return my name (global_ or data_..)
 o indexOf(Object)
Just like the Vector method of the same name.
 o indexOf(Object, int)
Just like the Vector method of the same name.
 o insertElementAt(Object, int)
Just like the Vector method of the same name.
 o isEmpty()
Just like the Vector method of the same name.
 o lastElement()
Just like the Vector method of the same name.
 o lastIndexOf(Object)
Just like the Vector method of the same name.
 o lastIndexOf(Object, int)
Just like the Vector method of the same name.
 o removeElement(Object)
Just like the Vector method of the same name.
 o removeElementAt(int)
Similar to the Vector method of the same name.
 o searchByName(String)
Given a tag name, find the AST object it resides in.
 o searchByTagValue(String, String)
Given a tag name and a value, find the AST object that that particular tag and value pair resides in.
 o searchForType(Class, short)
This method returns a vector of all the nodes of the given type.
 o setElementAt(Object, int)
Just like the Vector method of the same name.
 o setLabel(String)
Change my name (global_ or data_..) - generate an exception if the given name is not valid.
 o setSize(int)
Just like the Vector method of the same name.
 o size()
Just like the Vector method of the same name.
 o Unparse(int)
Unparse prints the contents of the StarNode object out to the given stream.

Variables

 o myDataList
 protected BlockListVector myDataList
 o myHeading
 protected String myHeading

Methods

 o clone
 public 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
 o getLabel
 public String getLabel()
Return my name (global_ or data_..)

 o setLabel
 public void setLabel(String newName) throws NameViolatesStarSyntax
Change my name (global_ or data_..) - generate an exception if the given name is not valid.

 o 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:
setSize
 o size
 public int size()
Just like the Vector method of the same name. Returns the number of elements in this block.

See Also:
size
 o isEmpty
 public boolean isEmpty()
Just like the Vector method of the same name. True if this block has no elements in it.

See Also:
isEmpty
 o elements
 public Enumeration elements()
Just like the Vector method of the same name. Gives an enumeration over the loops, saveframes, and data items in this block.

See Also:
Enumeration
 o contains
 public boolean contains(Object obj)
Just like the Vector method of the same name. True if the node given is a loop, item, or saveframe immediately inside this block. This is not a deep recursive search - it only looks at the level immediately inside the block.

Parameters:
obj - The loop, item, or saveframe to look for
See Also:
contains
 o indexOf
 public int indexOf(Object obj)
Just like the Vector method of the same name. Returns the integer index of the given item, loop or saveframe inside this StarFileNode. This is not a deep recursive search.

Parameters:
obj - The loop, item, or saveframe to look for
See Also:
indexOf
 o indexOf
 public int indexOf(Object obj,
                    int index)
Just like the Vector method of the same name. Returns the integer index of the next item, loop or saveframe inside this StarFileNode, starting at the index given. This is not a deep recursive search.

Parameters:
obj - The item, loop, or saveframe to look for.
index - Start searching at this point in the vector.
See Also:
indexOf
 o lastIndexOf
 public int lastIndexOf(Object obj)
Just like the Vector method of the same name. Returns the lastmost integer index of the given item, loop, or saveframe

Parameters:
obj - The item, loop, or saveframe to look for.
See Also:
lastIndexOf
 o lastIndexOf
 public int lastIndexOf(Object obj,
                        int index)
Just like the Vector method of the same name. Returns the lastmost integer index of the given item, loop, or saveframe, but going no higher than the given index.

Parameters:
obj - The item, loop, or saveframe to look for.
index - Start searching back from this point in the vector.
See Also:
lastIndexOf
 o elementAt
 public StarNode elementAt(int index)
Just like the Vector method of the same name. Returns the item, loop, or saveframe object at the given index.

Parameters:
index - The index to return the item, loop, or saveframe at.
Returns:
The returned object is either an item, loop, or saveframe.
See Also:
elementAt
 o firstElement
 public StarNode firstElement()
Just like the Vector method of the same name. Returns the first item. loop. or saveframe object in the file.

Returns:
The returned object is a item, loop, or saveframe.
See Also:
firstElement
 o lastElement
 public StarNode lastElement()
Just like the Vector method of the same name. Returns the last item, loop, or saveframe object in the file.

Returns:
The returned object is a item, loop, or saveframe
See Also:
lastElement
 o setElementAt
 public void setElementAt(Object obj,
                          int index) throws WrongElementType
Just like the Vector method of the same name. Clobbers the item, loop, or saveframe at the given index with the object given.

Parameters:
obj - The item, loop, or saveframe to set it to.
index - the position to replace.
See Also:
setElementAt
 o removeElementAt
 public void removeElementAt(int index)
Similar to the Vector method of the same name. Deletes the item, loop, or saveframe at the given index from the block node

Parameters:
index - the position to remove.
See Also:
removeElementAt
 o insertElementAt
 public void insertElementAt(Object obj,
                             int index) throws WrongElementType
Just like the Vector method of the same name. Inserts an item, loop, or saveframe at the position given.

Parameters:
obj - The item, loop, or saveframe to insert.
index - the position to insert it in from of.
See Also:
insertElementAt
 o addElement
 public void addElement(Object obj) throws WrongElementType
Just like the Vector method of the same name. Adds an item, loop or saveframe to the end of the list.

Parameters:
obj - The item, loop, or saveframe to add.
See Also:
addElement
 o removeElement
 public boolean removeElement(Object obj)
Just like the Vector method of the same name. Removes the item, loop, or saveframe matching the one given.

Parameters:
obj - The item, loop, or saveframe to remove.
See Also:
removeElement
 o searchByName
 public VectorCheckType searchByName(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
 o searchByTagValue
 public VectorCheckType searchByTagValue(String tag,
                                         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 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
 o searchForType
 public VectorCheckType searchForType(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. Set to DataValueNode.DONT_CARE if it doesn't matter.
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
 o Unparse
 public void Unparse(int indent)
Unparse prints the contents of the StarNode object out to the given stream. This is essentially the inverse of the CS term to "parse", hence the name "Unparse". The parameter given is the indentation level to print things.

Overrides:
Unparse in class StarNode

All Packages  Class Hierarchy  This Package  Previous  Next  Index