bes  Updated for version 3.20.5
ValuesElement.h
1 // This file is part of the "NcML Module" project, a BES module designed
3 // to allow NcML files to be used to be used as a wrapper to add
4 // AIS to existing datasets of any format.
5 //
6 // Copyright (c) 2009 OPeNDAP, Inc.
7 // Author: Michael Johnson <m.johnson@opendap.org>
8 //
9 // For more information, please also see the main website: http://opendap.org/
10 //
11 // This library is free software; you can redistribute it and/or
12 // modify it under the terms of the GNU Lesser General Public
13 // License as published by the Free Software Foundation; either
14 // version 2.1 of the License, or (at your option) any later version.
15 //
16 // This library is distributed in the hope that it will be useful,
17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 // Lesser General Public License for more details.
20 //
21 // You should have received a copy of the GNU Lesser General Public
22 // License along with this library; if not, write to the Free Software
23 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 //
25 // Please see the files COPYING and COPYRIGHT for more information on the GLPL.
26 //
27 // You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
29 #ifndef __NCML_MODULE__VALUESELEMENT_H__
30 #define __NCML_MODULE__VALUESELEMENT_H__
31 
32 #include "NCMLElement.h"
33 #include "NCMLDebug.h"
34 #include <sstream>
35 #include <string>
36 #include <vector>
37 
38 using std::string;
39 
40 namespace libdap {
41 class Array;
42 class BaseType;
43 }
44 
45 namespace ncml_module {
46 class NCMLParser;
47 class VariableElement;
48 
49 class ValuesElement: public NCMLElement {
50 private:
51  ValuesElement& operator=(const ValuesElement& rhs); // disallow
52 
53 public:
54  static const string _sTypeName;
55  static const vector<string> _sValidAttributes;
56 
57  ValuesElement();
58  ValuesElement(const ValuesElement& proto);
59  virtual ~ValuesElement();
60  virtual const string& getTypeName() const;
61  virtual ValuesElement* clone() const; // override clone with more specific subclass
62  virtual void setAttributes(const XMLAttributeMap& attrs);
63  virtual void handleBegin();
64  virtual void handleContent(const string& content);
65  virtual void handleEnd();
66  virtual string toString() const;
67 
68 private:
69  // Methods
70 
75  bool shouldAutoGenerateValues() const
76  {
77  return ((!_start.empty()) && (!_increment.empty()));
78  }
79 
85  void validateStartAndIncrementForVariableTypeOrThrow(libdap::BaseType& var) const;
86 
97  void setVariableValuesFromTokens(NCMLParser& p, libdap::BaseType& var);
98 
106  void setScalarVariableValuesFromTokens(NCMLParser& p, libdap::BaseType& var);
107 
121  void setVectorVariableValuesFromTokens(NCMLParser& p, libdap::BaseType& var);
122 
132  template<typename DAPType> void generateAndSetVectorValues(NCMLParser& p, libdap::Array* pArray);
133 
139  void autogenerateAndSetVariableValues(NCMLParser& p, libdap::BaseType& var);
140 
150  template<class DAPType, typename ValueType> void setScalarValue(libdap::BaseType& var, const string& valueAsToken);
151 
162  template<typename DAPType> void setVectorValues(libdap::Array* pArray, const std::vector<string>& valueTokens);
163 
165  void parseAndSetCharValue(libdap::BaseType& var, const string& valueAsToken);
166 
171  void parseAndSetCharValueArray(NCMLParser& p, libdap::Array* pVecVar, const std::vector<string>& tokens);
172 
177  std::string getNCMLTypeForVariable(NCMLParser& p) const;
178 
180  const VariableElement* getContainingVariableElement(NCMLParser& p) const;
181 
183  void setGotValuesOnOurVariableElement(NCMLParser& p);
184 
188  void dealWithEmptyStringValues();
189 
190  static vector<string> getValidAttributes();
191 
192 private:
193  // Data Rep
194  string _start;
195  string _increment;
196  string _separator; // defaults to whitespace
197 
198  // If we got handleContent successfully!
199  bool _gotContent;
200 
201  //TODO add comment
202  std::string _accumulated_content;
203  // Temp to tokenize the content on handleContent()
204  std::vector<string> _tokens;
205 };
206 
207 }
208 
209 #endif /* __NCML_MODULE__VALUESELEMENT_H__ */
ncml_module::ValuesElement::clone
virtual ValuesElement * clone() const
Definition: ValuesElement.cc:87
ncml_module::NCMLParser
Definition: NCMLParser.h:159
ncml_module::XMLAttributeMap
Definition: XMLHelpers.h:96
ncml_module::ValuesElement::toString
virtual string toString() const
Definition: ValuesElement.cc:277
ncml_module::ValuesElement
Definition: ValuesElement.h:49
libdap
Definition: BESDapFunctionResponseCache.h:35
ncml_module::VariableElement
Concrete class for NcML <variable> element.
Definition: VariableElement.h:58
ncml_module::ValuesElement::setAttributes
virtual void setAttributes(const XMLAttributeMap &attrs)
Definition: ValuesElement.cc:92
ncml_module::ValuesElement::getTypeName
virtual const string & getTypeName() const
Definition: ValuesElement.cc:81
ncml_module::NCMLElement
Base class for NcML element concrete classes.
Definition: NCMLElement.h:63
ncml_module
NcML Parser for adding/modifying/removing metadata (attributes) to existing local datasets using NcML...
Definition: AggregationElement.cc:72
ncml_module::ValuesElement::handleBegin
virtual void handleBegin()
Definition: ValuesElement.cc:111
ncml_module::ValuesElement::handleEnd
virtual void handleEnd()
Definition: ValuesElement.cc:216
ncml_module::ValuesElement::handleContent
virtual void handleContent(const string &content)
Definition: ValuesElement.cc:148