TreeNode

Kind of class:	interface
Inherits from:	none
Implemented by:	ObjectTreeNode
Classpath:	org.springsoft.aslib.TreeNode
File last modified:	Saturday, 22 January 2005, 14:27:02

► View source

▼ Hide source

/*

TreeNode is part of ASLib

Copyright (C) 2004 Thomas P. Amsler

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Thomas Amsler
tamsler@cal.berkeley.edu

*/

/*
=====================================================================
    Requires:
    ActionScript 2.0

    Description:
    Binary Tree: Tree Node
=====================================================================
*/


import org.springsoft.aslib.BinaryTreeObject;

interface org.springsoft.aslib.TreeNode
{
    /**
    * Set left node
    *
    * @param node The node referenced by the left child
    */
    public function setLeft(node:TreeNode):Void;
    
    /**
    * Set right node
    *
    * @param node The node referenced by the right child
    */
    public function setRight(node:TreeNode):Void;
    
    /**
    * Set node data
    *
    * @param data Object data
    */
    public function set(data:BinaryTreeObject):Void;

    /**
    * Get left node
    *
    * @returns left child node
    */
    public function getLeft(Void):TreeNode;
    
    /**
    * Get right node
    *
    * @returns right child node
    */
    public function getRight(Void):TreeNode;
    
    /**
    * Get node data
    *
    * @returns object data
    */
    public function get(Void):BinaryTreeObject;
    
    /**
    * TreeNode string representation
    *
    * @returns the tree node's string representation
    */
    public function toString(Void):String;
    
    /**
    * Return node key
    *
    * @returns the tree node's key
    */
    public function getKey(Void):Number;
    
    /**
    * Test if node is a leave
    *
    * @returns true if node is a leave.  Otherwise returns false.
    */
    public function isLeave(Void):Boolean;
}

Summary

Instance methods

setLeft (node:TreeNode) : Void
- Set left node
setRight (node:TreeNode) : Void
- Set right node
set (data:BinaryTreeObject) : Void
- Set node data
getLeft (Void) : TreeNode
- Get left node
getRight (Void) : TreeNode
- Get right node
get (Void) : BinaryTreeObject
- Get node data
toString (Void) : String
- TreeNode string representation
getKey (Void) : Number
- Return node key
isLeave (Void) : Boolean
- Test if node is a leave

Instance methods

get

function get (

Void) : BinaryTreeObject

Get node data

Returns:

object data

getKey

function getKey (

Void) : Number

Return node key

Returns:

the tree node's key

getLeft

function getLeft (

Void) : TreeNode

Get left node

Returns:

left child node

getRight

function getRight (

Void) : TreeNode

Get right node

Returns:

right child node

isLeave

function isLeave (

Void) : Boolean

Test if node is a leave

Returns:

true if node is a leave. Otherwise returns false.

set

function set (

data:BinaryTreeObject) : Void

Set node data

Parameters:

data:

Object data

setLeft

function setLeft (

node:TreeNode) : Void

Set left node

Parameters:

node:

The node referenced by the left child

setRight

function setRight (

node:TreeNode) : Void

Set right node

Parameters:

node:

The node referenced by the right child

toString

function toString (

Void) : String

TreeNode string representation

Returns:

the tree node's string representation