source: inundation/ga/storm_surge/pyvolution/treenode.py @ 1506

import string
import exceptions
import types


class TreeNode:
    """class TreeNode

    Base class for nodes in a tree-like structure.
    Public Methods:
        GetChildren()
        GetParent()
        AddChild(child)
        GetLeaves()
        DeleteChild(child)
        Prune(children)
        Show()
    """


    def __init__(self,name=None):
        self.children = None
        self.parent = None

        # subclasses can implement these attributes as functions, called
        # when a node (either leaf or internal) is deleted
        if not hasattr(self,'ClearLeafNode'):
            self.ClearLeafNode = None
        if not hasattr(self,'ClearInternalNode'):
            self.ClearInternalNode = None

        # when not already set by derived class, set unique instance name
        if not hasattr(self,"name"):
            if name:
                self.name = name
            else:
                self.name = id(self)


    #Make treenode elements appear as sequences such thta on
    #can iterate over them             
    def __iter__(self):
        self.index = -1   # incremented on first call to next()
        return self

    def next(self):
        try:
            self.index += 1
            return self.children[self.index]
        except IndexError:
            self.index = -1
            raise StopIteration



    #---- public methods ------------------------------------

    def GetChildren(self):
        return self.children


    def GetParent(self):
        return self.parent


    def AddChild(self,child):
        child.parent = self
        if hasattr(self,'storage'):
            child.storage = self.storage
        if self.children is None:
            self.children = []
        self.children.append(child)


    def DeleteChild(self,child):
        try:
            index = self.children.index(child)
            child.Prune()
            del self.children[index]
            if self.children == []:
                self.children = None
        except ValueError:
            raise TreeNodeError


    def Prune(self):
        if self.children is None:                  # Leaf node
            if callable(self.clear_leaf_node):
                self.clear_leaf_node()
            else:
                msg = 'Node must have a method named "clear_leaf_node"' 
                raise msg       
        else:
            if callable(self.clear_internal_node):   # Internal node
                self.clear_internal_node()
            else:
                msg = 'Node must have a method named "clear_internal_node"' 
                raise msg       
                                
            for child in self.children:
                child.Prune()
            self.children = None


    #FIXME: I think this one is redundant and should could be removed (OMN)
    # Really?  Where is the equivalent method? (DEE)
    # OK - I reliased that we can use it for testing and statistics (OMN)
    def GetLeaves(self):
        if self.children is None:
            myleaves = [self]
        else:
            myleaves = []
            for child in self.children:
                myleaves += child.GetLeaves()

        return myleaves


    def CountLeaves(self):
        if self.children is None:
            count = 1
        else:
            count = 0
            for child in self.children:
                count += child.CountLeaves()

        return count


    def Show(self,depth=0):
        """Traverse tree and print node names.
        """        
        print "%s%s" % ('  '*depth, self.name)
        if self.children:
            for child in self.children:
                child.Show(depth+1)
        else:
            print ': %d' %self.Count()

         
#----------------------------------------------------------------
class TreeNodeError(exceptions.Exception):
    pass