NCMLElement.h

// This file is part of the "NcML Module" project, a BES module designed
// to allow NcML files to be used to be used as a wrapper to add
// AIS to existing datasets of any format.
//
// Copyright (c) 2009 OPeNDAP, Inc.
// Author: Michael Johnson  <m.johnson@opendap.org>
//
// For more information, please also see the main website: http://opendap.org/
//
// 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//
// Please see the files COPYING and COPYRIGHT for more information on the GLPL.
//
// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
#ifndef __NCML_MODULE__NCMLELEMENT_H__
#define __NCML_MODULE__NCMLELEMENT_H__
 
#include <iostream>
#include "RCObject.h"
#include "XMLHelpers.h"
#include <string>
#include <vector>
 
using agg_util::RCPtr;
using agg_util::RCObject;
using agg_util::RCObjectPool;
 
namespace ncml_module {
// FDecls
class NCMLParser;

class NCMLElement: public agg_util::RCObject {
public:

    class Factory {
    public:
        Factory();
        ~Factory();

        RCPtr<NCMLElement> makeElement(const std::string& eltTypeName, const XMLAttributeMap& attrs,
            NCMLParser& parser);
 
    private:
        // Interface

        void initialize();
 
    private:
        // Possible prototypes we can create from.  Uses getTypeName() for match.
        typedef std::vector<const NCMLElement*> ProtoList;

        void addPrototype(const NCMLElement* proto);

        ProtoList::iterator findPrototype(const std::string& elementTypeName);
 
        ProtoList _protos;
    };
 
protected:
    // Abstract: Only subclasses can create these
    explicit NCMLElement(NCMLParser* p);
 
    NCMLElement(const NCMLElement& proto);
 
private:
    // Disallow assignment for now
    NCMLElement& operator=(const NCMLElement& rhs);
 
public:
    virtual ~NCMLElement();
 
    void setParser(NCMLParser* p);

    int line() const;

    virtual const std::string& getTypeName() const = 0;

    virtual NCMLElement* clone() const = 0;

    virtual void setAttributes(const XMLAttributeMap& attrs) = 0;

    virtual bool validateAttributes(const XMLAttributeMap& attrs, const std::vector<std::string>& validAttrs,
            std::vector<std::string>* pInvalidAttrs = 0, bool printInvalid = true, bool throwOnError = true);

    virtual void handleBegin() = 0;

    virtual void handleContent(const std::string& content);

    virtual void handleEnd() = 0;

    virtual std::string toString() const = 0;

    static std::string printAttributeIfNotEmpty(const std::string& attrName, const std::string& attrValue);

    static bool isValidAttribute(const std::vector<std::string>& validAttrs, const std::string& attr);

    static bool areAllAttributesValid(const XMLAttributeMap& attrMap, const std::vector<std::string>& validAttrs,
        std::vector<std::string>* pInvalidAttributes = 0);
 
protected:
    // data rep
    NCMLParser* _parser;
};
 
}

inline std::ostream &
operator<<(std::ostream &strm, const ncml_module::NCMLElement &obj)
{
    strm << obj.toString();
    return strm;
}
 
#endif /* __NCML_MODULE__NCMLELEMENT_H__ */