/******************************** LICENSE ********************************

 Copyright 2007 European Centre for Medium-Range Weather Forecasts (ECMWF)

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at 

    http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.

 ******************************** LICENSE ********************************/

/*! \file XmlTree.h
    \brief Definition of the Template class XmlTree.
    \author Meteorological Visualisation Section, ECMWF

    Started: Jun-2005

*/

#ifndef XmlTree_H
#define XmlTree_H

#include "magics.h"
#include "XmlNode.h"


namespace magics {

class XmlTree {

public:
	XmlTree();
	virtual ~XmlTree();
    XmlNode* getParent(const string&);
    void     endElement(const string&); 
    XmlNode* newNode(const string&, const map<string, string>& def) const;
    XmlNode::ElementIterator firstElement() const { return root_.firstElement(); }
    XmlNode::ElementIterator lastElement() const  { return root_.lastElement(); }
    void visit(XmlNodeVisitor& visitor) const { root_.visit(visitor); } 
    XmlNode* root()                           { return &root_; } 
    void definition(XmlNode* definition);    
    
protected:
     //! Method to print string about this class on to a stream of type ostream (virtual).
	 virtual void print(ostream&) const; 
	 mutable map<string, XmlNode*> ids_;
	 XmlNode                  root_;
	 XmlNode                  definitions_;

private:
    //! Copy constructor - No copy allowed
	XmlTree(const XmlTree&);
    //! Overloaded << operator to copy - No copy allowed
	XmlTree& operator=(const XmlTree&);

// -- Friends
    //! Overloaded << operator to call print().
	friend ostream& operator<<(ostream& s,const XmlTree& p)
		{ p.print(s); return s; }
};

} // namespace magics
#endif
