PolicySource.h

Go to the documentation of this file.

// -*- lsst-c++ -*-

/*
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 LSST Corporation.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */

#ifndef LSST_PEX_POLICY_SOURCE_H
#define LSST_PEX_POLICY_SOURCE_H

#include "lsst/pex/policy/Policy.h"
#include "lsst/pex/policy/PolicyParserFactory.h"
#include "lsst/pex/policy/SupportedFormats.h"

namespace lsst {
namespace pex {
namespace policy {

class PolicySource {
public:
    PolicySource(SupportedFormats::Ptr fmts = defaultFormats) : _formats(fmts) {
        if (defaultFormats->size() == 0) SupportedFormats::initDefaultFormats(*defaultFormats);
    }

    virtual ~PolicySource();

    //     /**
    //      * identifiers for the different supported formats
    //      */
    //     enum FormatType {

    //         /**  Unknown and unsupported */
    //         UNSUPPORTED,

    //         /**  XML format  */
    //         XML,

    //         /**  Policy authoring format (PAF)  */
    //         PAF,

    //         /**  Supported format but unknown  */
    //         UNKNOWN
    //     };

    //     /**
    //      * determine the format that the data is stored in and return its format
    //      * type identifier.  Note that UNKNOWN will be returned
    //      * if the format is supported--that is, the data can be read into a
    //      * Policy object--but otherwise does not have a defined type identifier
    //      * defined.  This may cause the first few records of the source to
    //      * be read.
    //      * @exception IOError   if an error occurs while reading the first few
    //      *                      characters of the source stream.
    //      */
    //     virtual FormatType getFormatType();

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


    virtual void load(Policy& policy) const = 0;
    virtual void load(Policy& policy) = 0;

    //     /**
    //      * returns true if the given string containing a content identifier
    //      * indicates that it contains dictionary data.  Dictionary data has
    //      * a content id of "<?cfg ... dictionary ?>" (where ... indicates
    //      * the format); policy data has an id of "<?cfg ... policy ?>".
    //      */
    //     static bool indicatesDictionary(const std::string& contentid) {
    //         return regex_search(contentid, DICTIONARY_CONTENT);
    //     }

    static SupportedFormats::Ptr defaultFormats;

    //     static const regex DICTIONARY_CONTENT;

protected:
    SupportedFormats::Ptr _formats;
};

}  // namespace policy
}  // namespace pex
}  // namespace lsst

#endif  // LSST_PEX_POLICY_SOURCE_H