org.safs

Class Tree

java.lang.Object

org.safs.Tree

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

MenuTree, PCTree

public class Tree
extends java.lang.Object
implements java.io.Serializable

Purpose: generic tree object

Since:

JUL 11, 2003
JUL 11, 2003 (DBauman) Original Release

Author:

Doug Bauman

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EQUAL_SEPARATOR
static java.lang.String	PATH_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
Tree()

Method Summary

Modifier and Type	Method and Description
java.lang.String	exactMatchPath(java.lang.String match) Purpose: find an exact match based on the parameter by walking the tree, finding a string which equals each matching substring, and returning the full path if it matched.
java.lang.String	findMatchPath(java.lang.String match) Purpose: find a match based on the parameter by walking the tree, finding a string which contains the matching substring, and returning the full path if it matched.
java.lang.Integer	getChildCount()
Tree	getFirstChild()
java.lang.Integer	getLevel()
Tree	getNextSibling()
java.lang.Integer	getSiblingCount()
java.lang.Object	getUserObject()
void	setChildCount(java.lang.Integer childCount)
void	setFirstChild(Tree firstChild)
void	setLevel(java.lang.Integer level)
void	setNextSibling(Tree nextSibling)
void	setSiblingCount(java.lang.Integer siblingCount)
void	setUserObject(java.lang.Object userObject)
java.lang.String	toString()
java.lang.String[]	toStringArray()
java.lang.String[]	toStringArrayWOSiblings()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PATH_SEPARATOR

public static final java.lang.String PATH_SEPARATOR

See Also:

Constant Field Values

EQUAL_SEPARATOR

public static final java.lang.String EQUAL_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

Tree

public Tree()

Method Detail

getUserObject

public java.lang.Object getUserObject()

setUserObject

public void setUserObject(java.lang.Object userObject)

getFirstChild

public Tree getFirstChild()

setFirstChild

public void setFirstChild(Tree firstChild)

getNextSibling

public Tree getNextSibling()

setNextSibling

public void setNextSibling(Tree nextSibling)

getLevel

public java.lang.Integer getLevel()

setLevel

public void setLevel(java.lang.Integer level)

getSiblingCount

public java.lang.Integer getSiblingCount()

setSiblingCount

public void setSiblingCount(java.lang.Integer siblingCount)

getChildCount

public java.lang.Integer getChildCount()

setChildCount

public void setChildCount(java.lang.Integer childCount)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringArray

public java.lang.String[] toStringArray()

toStringArrayWOSiblings

public java.lang.String[] toStringArrayWOSiblings()

findMatchPath

public java.lang.String findMatchPath(java.lang.String match)

Purpose: find a match based on the parameter by walking the tree, finding a string which contains the matching substring, and returning the full path if it matched.
Assumptions: match is not null; first match will be considered the match, subsequent matches would therefore be ignored.

Parameters:

match, - String

Returns:

full path to match, null otherwise

exactMatchPath

public java.lang.String exactMatchPath(java.lang.String match)

Purpose: find an exact match based on the parameter by walking the tree, finding a string which equals each matching substring, and returning the full path if it matched.
Assumptions: match is not null; first match will be considered the match, subsequent matches would therefore be ignored.

Parameters:

match, - String

Returns:

full path to match, null otherwise