VariableElement.h

Go to the documentation of this file.

// 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__VARIABLE_ELEMENT_H__
#define __NCML_MODULE__VARIABLE_ELEMENT_H__

#include "NCMLElement.h"

namespace libdap
{
  class BaseType;
}

namespace ncml_module
{

  class VariableElement : public NCMLElement
  {
  private:
    VariableElement& operator=(const VariableElement& rhs); // disallow

  public:
    static const string _sTypeName;
    static const vector<string> _sValidAttributes;

    VariableElement();
    VariableElement(const VariableElement& proto);
    virtual ~VariableElement();
    virtual const string& getTypeName() const;
    virtual VariableElement* clone() const; // override clone with more specific subclass
    virtual void setAttributes(const XMLAttributeMap& attrs);
    virtual void handleBegin();
    virtual void handleContent(const string& content);
    virtual void handleEnd();
    virtual string toString() const;

    const std::string name() const
    {
      return _name;
    }

    const std::string type() const
    {
      return _type;
    }

    const std::string shape() const
    {
      return _shape;
    }

    const std::string orgName() const
    {
      return _orgName;
    }

    bool isNewVariable() const;

    bool checkGotValues() const;

    void setGotValues();

  private:

    void processBegin(NCMLParser& p);

    void processEnd(NCMLParser& p);

    void processExistingVariable(NCMLParser& p, libdap::BaseType* pVar);

    void processRenameVariable(NCMLParser& p);

    void processNewVariable(NCMLParser& p);

    void processNewStructure(NCMLParser& p);

    void processNewScalar(NCMLParser& p, const std::string& dapType);

    void processNewArray(NCMLParser& p, const std::string& dapType);

    libdap::BaseType* replaceArrayIfNeeded(NCMLParser& p, libdap::BaseType* pOrgVar, const string& name);

    void addNewVariableAndEnterScope(NCMLParser& p, const std::string& dapType);

    void enterScope(NCMLParser& p, libdap::BaseType* pVar);

    void exitScope(NCMLParser& p);

    bool isDimensionNumericConstant(const std::string& dimToken) const;
    unsigned int getSizeForDimension(NCMLParser& p, const std::string& dimToken) const;

    unsigned int getProductOfDimensionSizes(NCMLParser& p) const;

    static vector<string> getValidAttributes();

  private:
    string _name;
    string _type;
    string _shape; // empty() => existing var (shape implicit) or if new var, then scalar (rank 0).
    string _orgName; // if !empty(), the name of existing variable we want to rename to _name

    // Ephemeral state below

    // tokenized version of _shape for dimensions
    vector<string> _shapeTokens;

    // if not null, this element created this var and it exists in the dds of the containing dataset
    libdap::BaseType* _pNewlyCreatedVar;

    // true once we get a valid <values> element with values in it.  Used for parse error checking
    bool _gotValues;
  };

}

#endif /* __NCML_MODULE__VARIABLE_ELEMENT_H__ */