EntryNode.h

//========================================================================================
// 
// $File$
// 
// Owner: Yeming Liu
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// Comments: Templatized Node class allowing an arbitrary number of children in the tree.
// This structure is used to support multi level sorting.
// 
//========================================================================================

#ifndef __ENTRYNODE__
#define __ENTRYNODE__

template <class T> 
class EntryNode
{
 public:
 EntryNode() : fData(), fLevel(0), fChild(nil), fSibling(nil), fPrevious(nil), fPreviousIsParent(kFalse) { }

 EntryNode(const T& data) : fData(data), fLevel(1), fChild(nil), fSibling(nil), fPrevious(nil), fPreviousIsParent(kFalse) { }

 EntryNode(const T& data, int32 level, EntryNode<T>* child, EntryNode<T>* sibling, EntryNode<T>* previous, bool16 isParent) : 
 fData(data), fLevel(level), fChild(child), fSibling(sibling), fPrevious(previous), fPreviousIsParent(isParent) { }

 virtual ~EntryNode() {}

 virtual const T& GetData() { return fData; }

 virtual void SetData(const T& data) { fData = data; }

 virtual int32 GetNodeLevel() { return fLevel; }

 virtual void SetNodeLevel(int32 level) { fLevel = level; }

 virtual EntryNode<T>* GetChild() { return fChild; }

 virtual void SetChild(EntryNode<T>* child) { fChild = child; }

 virtual EntryNode<T>* GetSibling() { return fSibling; }

 virtual void SetSibling(EntryNode<T>* sibling) { fSibling = sibling; }

 virtual EntryNode<T>* GetPrevious() { return fPrevious; }

 virtual void SetPrevious(EntryNode<T>* previous) { fPrevious = previous; }

 virtual bool16 IsPreviousParent() { return fPreviousIsParent; }

 virtual void SetPreviousIsParent(bool16 isParent) { fPreviousIsParent = isParent; }

 private:
 T fData; // any data in the entry node
 int32 fLevel; // level where the data will be
 EntryNode<T>* fChild; // the node's child
 EntryNode<T>* fSibling; // the node's sibling
 EntryNode<T>* fPrevious;// the node's previous node
 bool16 fPreviousIsParent;// flag indicates if thie nodes has parent or not(such as non-first child of a node)
};

#endif // __ENTRYNODE__