ScanElement.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__SCAN_ELEMENT_H__
#define __NCML_MODULE__SCAN_ELEMENT_H__

#include "NCMLElement.h"
#include "AggMemberDataset.h"

namespace agg_util
{
  class DirectoryUtil;
};

namespace ncml_module
{
  // FDecls
  class NetcdfElement;
  class AggregationElement;

  class ScanElement : public NCMLElement
  {
  public: // class vars
    // Name of the element
    static const string _sTypeName;

      // All possible attributes for this element.
    static const vector<string> _sValidAttrs;

  private:
      ScanElement& operator=(const ScanElement& rhs); // disallow

  public:
    ScanElement();
    ScanElement(const ScanElement& proto);
    virtual ~ScanElement();

    virtual const string& getTypeName() const;
    virtual ScanElement* 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 string& ncoords() const;

    AggregationElement* getParent() const;

    void setParent(AggregationElement* pParent);

    bool shouldScanSubdirs() const;

    long getOlderThanAsSeconds() const;

    void getDatasetList(vector<NetcdfElement*>& datasets) const;

  private: // internal methods

    void setupFilters(agg_util::DirectoryUtil& scanner) const;

    void initSimpleDateFormats(const std::string& dateFormatMark);

    void deleteDateFormats() throw();

    std::string extractTimeFromFilename(const std::string& filename) const;

    static vector<string> getValidAttributes();

    void throwOnUnhandledAttributes();

    static std::string getTimeAsString(time_t theTime);

  private: // data rep
    string _location;
    string _suffix;
    string _regExp;
    string _subdirs;
    string _olderThan;
    string _dateFormatMark;
    string _enhance; // we're not implementing this one now.
    string _ncoords; // OPeNDAP EXTENSION to NcML.  Inherited by all matched datasets.

    // Back pointer to our parent
    AggregationElement* _pParent;

    // We use an opaque ptr (pimpl idiom) to push the
    // decl of the ICU classes to the .cc
    // to get config.h information as well as hide the icu headers.
    struct DateFormatters;
    DateFormatters* _pDateFormatters;
  };

}

#endif /* __NCML_MODULE__SCAN_ELEMENT_H__ */