SemanticTreeFactory.hpp

Go to the documentation of this file.

/*
Copyright 2007, 2008, 2009, 2010, 2011 Instituto de Sistemas e Robotica, Instituto Superior Tecnico

This file is part of MeRMaID.

MeRMaID 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 3 of the License, or
(at your option) any later version.

MeRMaID 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 MeRMaID.  If not, see <http://www.gnu.org/licenses/>.
*/



/**
 * @Filename SemanticTreeFactory.hpp
 * @Description SemanticTreeFactory class definition.
 * @Status Implementing
 * @Version $Id: SemanticTreeFactory.hpp 1 2011-03-04 18:13:18Z jreis $
 * @Maintainer Marco Barbosa + Nelson Ramos
 */

#ifndef __DATASEMANTICS_SEMANTICTREEFACTORY_H_
#define __DATASEMANTICS_SEMANTICTREEFACTORY_H_

#include <string>
#include "SemanticTree.hpp"
#include "SemanticNode.hpp"
#include "XmlDocument.hpp"



namespace mermaid
{
  namespace support
  {
    namespace data
    {
      using boost::shared_ptr;
      using mermaid::support::xml::XmlDocument;
      using mermaid::support::xml::XmlElement;
      
      /**
      * @Class SemanticTreeFactory SemanticTreeFactory.hpp "SemanticTreeFactory.hpp"
      * @Description Class representing a SemanticTree factory.
      * @Description This class is able to build SemanticTrees from XML descriptions.
      * @Author Marco Barbosa + Nelson Ramos
      */
      
      class SemanticTreeFactory
      {
      
        public:
          /**
          * @Description SemanticTree builder.
          * @Description This method builds a SemanticTree from its XML description
          * @Argument tree A reference to the resulting tree.
          * @Argument doc The XML document containing the tree description
          * @Returns TRUE if building was successful, FALSE otherwise.
          */
          static shared_ptr<SemanticTree> buildSemanticTree (XmlDocument * doc);
          
        private:
          static shared_ptr<SemanticNode> buildSemanticNode (shared_ptr<XmlElement> element);
      }; // SemanticTreeFactory
    } // namespace data
  } // namespace support
} // namespace mermaid



#endif // __DATASEMANTICS_SEMANTICTREEFACTORY_H_