ValuesElement.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__VALUESELEMENT_H__
#define __NCML_MODULE__VALUESELEMENT_H__

#include "NCMLElement.h"
#include "NCMLDebug.h"
#include <sstream>
#include <string>
#include <vector>

using std::string;

namespace libdap
{
  class Array;
  class BaseType;
}

namespace ncml_module
{
  class NCMLParser;
  class VariableElement;

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

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

    ValuesElement();
    ValuesElement(const ValuesElement& proto);
    virtual ~ValuesElement();
    virtual const string& getTypeName() const;
    virtual ValuesElement* 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;

  private: // Methods

    bool shouldAutoGenerateValues() const { return ((!_start.empty()) && (!_increment.empty())); }

    void validateStartAndIncrementForVariableTypeOrThrow(libdap::BaseType& var) const;

    void setVariableValuesFromTokens(NCMLParser& p, libdap::BaseType& var);

    void setScalarVariableValuesFromTokens(NCMLParser& p, libdap::BaseType& var);

    void setVectorVariableValuesFromTokens(NCMLParser& p, libdap::BaseType& var);


    template <typename DAPType> void generateAndSetVectorValues(NCMLParser& p, libdap::Array* pArray);

    void autogenerateAndSetVariableValues(NCMLParser& p, libdap::BaseType& var);

    template <class DAPType, typename ValueType> void setScalarValue(libdap::BaseType& var, const string& valueAsToken);

    template <typename DAPType> void setVectorValues(libdap::Array* pArray, const std::vector<string>& valueTokens);

    void parseAndSetCharValue(libdap::BaseType& var, const string& valueAsToken);

    void parseAndSetCharValueArray(NCMLParser& p, libdap::Array* pVecVar, const std::vector<string>& tokens);

    std::string getNCMLTypeForVariable(NCMLParser& p) const;

    const VariableElement* getContainingVariableElement(NCMLParser& p) const;

    void setGotValuesOnOurVariableElement(NCMLParser& p);

    void dealWithEmptyStringValues();

    static vector<string> getValidAttributes();

  private: // Data Rep
    string _start;
    string _increment;
    string _separator; // defaults to whitespace

    // If we got handleContent successfully!
    bool _gotContent;

    //TODO add comment
    std::string _accumulated_content;
    // Temp to tokenize the content on handleContent()
    std::vector<string> _tokens;
  };

}

#endif /* __NCML_MODULE__VALUESELEMENT_H__ */