All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home

Class weka.gui.HierarchyPropertyParser 

java.lang.Object
    |
    +----weka.gui.HierarchyPropertyParser
public class HierarchyPropertyParser
extends java.lang.Object
implements java.io.Serializable
This class implements a parser to read properties that have a hierarchy(i.e. tree) structure. Conceptually it's similar to the XML DOM/SAX parser but of course is much simpler and uses dot as the seperator of levels instead of back-slash.
It provides interfaces to both build a parser tree and traverse the tree.
Note that this implementation does not lock the tree when different threads are traversing it simultaneously, i.e. it's NOT synchronized and multi-thread safe. It is recommended that later implementation extending this class provide a locking scheme and override the functions with the "synchronized" modifier (most of them are goToXXX() and information accessing functions).

Version:
$Revision: 1.2 $
Author:
Xin Xu (xx5@cs.waikato.ac.nz)

Constructor Index

o HierarchyPropertyParser()
Default constructor
o HierarchyPropertyParser(String, String)
Constructor that builds a tree from the given property with the given delimitor

Method Index

o add(String)
Add the given item of property to the tree
o build(String, String)
Build a tree from the given property with the given delimitor
o childrenValues()
The value in the children nodes.
o contains(String)
Whether the HierarchyPropertyParser contains the given string
o context()
The context of the current node, i.e.
o depth()
Get the depth of the tree, i.e.
o fullValue()
The full value of the current node, i.e.
o getLevel()
Get the level of current node.
o getSeperator()
Get the seperator between levels.
o getValue()
Get the value of current node
o goDown(String)
Go to a certain node of the tree down from the current node according to the specified relative path.
o goTo(String)
Go to a certain node of the tree according to the specified path Note that the path must be absolute path from the root.
o goToChild(int)
Go to one child node from the current position in the tree according to the given position
o goToChild(String)
Go to one child node from the current position in the tree according to the given value
If the child node with the given value cannot be found it returns false, true otherwise.
o goToParent()
Go to the parent from the current position in the tree If the current position is the root, it stays there and does not move
o goToRoot()
Go to the root of the tree
o isHierachic(String)
Whether the given string has a hierachy structure with the seperators
o isLeafReached()
Whether the current position is a leaf
o isRootReached()
Whether the current position is the root
o main(String[])
Tests out the parser.
o numChildren()
The number of the children nodes.
o parentValue()
The value in the parent node.
o search(Vector, String)
Helper function to search for the given target string in a given vector in which the elements' value may hopefully is equal to the target.
o setSeperator(String)
Set the seperator between levels.
o showTree()
Show the whole tree in text format
o tokenize(String)
Tokenize the given string based on the seperator and put the tokens into an array of strings

Constructor Detail

o HierarchyPropertyParser
public HierarchyPropertyParser()
          Default constructor
o HierarchyPropertyParser
public HierarchyPropertyParser(java.lang.String p,
                               java.lang.String delim) throws java.lang.Exception
          Constructor that builds a tree from the given property with the given delimitor
Parameters:
p - the given property string
delim - the given dilimitor

Method Detail

o setSeperator
public void setSeperator(java.lang.String s)
          Set the seperator between levels. Default is dot.
Parameters:
s - the seperator symbol
o getSeperator
public java.lang.String getSeperator()
          Get the seperator between levels. Default is dot.
Returns:
the seperator symbol
o build
public void build(java.lang.String p,
                  java.lang.String delim) throws java.lang.Exception
          Build a tree from the given property with the given delimitor
Parameters:
p - the given property
delim - the given delimitor
o add
public void add(java.lang.String property)
          Add the given item of property to the tree
Parameters:
property - the given item
o tokenize
public java.lang.String[] tokenize(java.lang.String rawString)
          Tokenize the given string based on the seperator and put the tokens into an array of strings
Parameters:
rawString - the given string
Returns:
an array of strings
o contains
public boolean contains(java.lang.String string)
          Whether the HierarchyPropertyParser contains the given string
Parameters:
string - the given string
Returns:
whether contains
o isHierachic
public boolean isHierachic(java.lang.String string)
          Whether the given string has a hierachy structure with the seperators
Parameters:
string - the given string
o search
public int search(java.util.Vector vct,
                  java.lang.String target)
          Helper function to search for the given target string in a given vector in which the elements' value may hopefully is equal to the target. If such elements are found the first index is returned, otherwise -1
Parameters:
vct - the given vector
target - the given target string
Returns:
the index of the found element, -1 if not found
o goTo
public boolean goTo(java.lang.String path)
          Go to a certain node of the tree according to the specified path Note that the path must be absolute path from the root.
For relative path, see goDown(String path).
Parameters:
path - the given absolute path
Returns:
whether the path exists, if false the current position does not move
o goDown
public boolean goDown(java.lang.String path)
          Go to a certain node of the tree down from the current node according to the specified relative path. The path does not contain the value of current node
Parameters:
path - the given relative path
Returns:
whether the path exists, if false the current position does not move
o goToRoot
public void goToRoot()
          Go to the root of the tree
o goToParent
public void goToParent()
          Go to the parent from the current position in the tree If the current position is the root, it stays there and does not move
o goToChild
public boolean goToChild(java.lang.String value)
          Go to one child node from the current position in the tree according to the given value
If the child node with the given value cannot be found it returns false, true otherwise. If false, the current position does not change
Parameters:
value - the value of the given child
Returns:
whether the child can be found
o goToChild
public void goToChild(int pos) throws java.lang.Exception
          Go to one child node from the current position in the tree according to the given position
Parameters:
pos - the position of the given child
Throws:
if - the position is out of range or leaf is reached
o numChildren
public int numChildren()
          The number of the children nodes. If current node is leaf, it returns 0.
Returns:
the number of the children nodes of the current position
o childrenValues
public java.lang.String[] childrenValues()
          The value in the children nodes. If current node is leaf, it returns null.
Returns:
the value in the children nodes
o parentValue
public java.lang.String parentValue()
          The value in the parent node. If current node is root, it returns null.
Returns:
the value in the parent node
o isLeafReached
public boolean isLeafReached()
          Whether the current position is a leaf
Returns:
whether the current position is a leaf
o isRootReached
public boolean isRootReached()
          Whether the current position is the root
Returns:
whether the current position is the root
o getValue
public java.lang.String getValue()
          Get the value of current node
Returns:
value level
o getLevel
public int getLevel()
          Get the level of current node. Note the level starts from 0
Returns:
the level
o depth
public int depth()
          Get the depth of the tree, i.e. (the largest level)+1
Returns:
the depth of the tree
o context
public java.lang.String context()
          The context of the current node, i.e. the path from the root to the parent node of the current node, seperated by the seperator. If root, it returns null
Returns:
the context path
o fullValue
public java.lang.String fullValue()
          The full value of the current node, i.e. its context + seperator + its value. For root, only its value.
Returns:
the context path
o showTree
public java.lang.String showTree()
          Show the whole tree in text format
Returns:
the whole tree in text format
o main
public static void main(java.lang.String args[])
          Tests out the parser.
Parameters:
args - should contain nothing 
All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home