lsst::daf::persistence::PropertySetFormatter Class Reference

Formatter for persistence of PropertySet instances. More...

#include <PropertySetFormatter.h>

Inheritance diagram for lsst::daf::persistence::PropertySetFormatter:

Public Member Functions
virtual	~PropertySetFormatter (void)
virtual void	write (dafBase::Persistable const *persistable, dafPersist::Storage::Ptr storage, dafBase::PropertySet::Ptr additionalData)
virtual dafBase::Persistable *	read (dafPersist::Storage::Ptr storage, dafBase::PropertySet::Ptr additionalData)
virtual void	update (dafBase::Persistable *persistable, dafPersist::Storage::Ptr storage, dafBase::PropertySet::Ptr additionalData)
Public Member Functions inherited from lsst::daf::persistence::Formatter
virtual	~Formatter (void)
virtual void	write (lsst::daf::base::Persistable const *persistable, Storage::Ptr storage, lsst::daf::base::PropertySet::Ptr additionalData)=0
virtual lsst::daf::base::Persistable *	read (Storage::Ptr storage, lsst::daf::base::PropertySet::Ptr additionalData)=0
virtual void	update (lsst::daf::base::Persistable *persistable, Storage::Ptr storage, lsst::daf::base::PropertySet::Ptr additionalData)=0
Public Member Functions inherited from lsst::daf::base::Citizen
	Citizen (const std::type_info &)
	Citizen (Citizen const &)
	~Citizen ()
Citizen &	operator= (Citizen const &)
std::string	repr () const
	Return a string representation of a Citizen. More...
void	markPersistent (void)
	Mark a Citizen as persistent and not destroyed until process end. More...
memId	getId () const
	Return the Citizen's ID. More...

Static Public Member Functions
template<class Archive >
static void	delegateSerialize (Archive &ar, unsigned int const version, dafBase::Persistable *persistable)
Static Public Member Functions inherited from lsst::daf::persistence::Formatter
static Formatter::Ptr	lookupFormatter (std::string const &persistableType, lsst::pex::policy::Policy::Ptr policy)
static Formatter::Ptr	lookupFormatter (std::type_info const &persistableType, lsst::pex::policy::Policy::Ptr policy)
Static Public Member Functions inherited from lsst::daf::base::Citizen
static bool	hasBeenCorrupted ()
	Check all allocated blocks for corruption. More...
static memId	getNextMemId ()
	Return the memId of the next object to be allocated. More...
static int	init ()
	Called once when the memory system is being initialised. More...
static int	census (int, memId startingMemId=0)
	How many active Citizens are there? More...
static void	census (std::ostream &stream, memId startingMemId=0)
	Print a list of all active Citizens to stream, sorted by ID. More...
static const std::vector < const Citizen * > *	census ()
	Return a (newly allocated) std::vector of active Citizens sorted by ID. More...
static memId	setNewCallbackId (memId id)
	Call the NewCallback when block is allocated. More...
static memId	setDeleteCallbackId (memId id)
	Call the current DeleteCallback when block is deleted. More...
static memNewCallback	setNewCallback (memNewCallback func)
	Set the NewCallback function. More...
static memCallback	setDeleteCallback (memCallback func)
	Set the DeleteCallback function. More...
static memCallback	setCorruptionCallback (memCallback func)
	Set the CorruptionCallback function. More...

Private Member Functions
	PropertySetFormatter (pexPolicy::Policy::Ptr policy)

Static Private Member Functions
static Formatter::Ptr	createInstance (pexPolicy::Policy::Ptr policy)

Private Attributes
pexPolicy::Policy::Ptr	_policy

Static Private Attributes
static FormatterRegistration	registration

Additional Inherited Members
Public Types inherited from lsst::daf::persistence::Formatter
typedef boost::shared_ptr < Formatter >	Ptr
typedef Ptr(*	FactoryPtr )(lsst::pex::policy::Policy::Ptr)
Public Types inherited from lsst::daf::base::Citizen
enum	{ magicSentinel = 0xdeadbeef }
typedef unsigned long	memId
	Type of the block's ID. More...
typedef memId(*	memNewCallback )(const memId cid)
	A function used to register a callback. More...
typedef memId(*	memCallback )(const Citizen *ptr)
Protected Member Functions inherited from lsst::daf::persistence::Formatter
	Formatter (std::type_info const &type)

Detailed Description

Formatter for persistence of PropertySet instances.

Definition at line 58 of file PropertySetFormatter.h.

Constructor & Destructor Documentation

lsst::daf::persistence::PropertySetFormatter::~PropertySetFormatter ( void  )

virtual

Minimal destructor.

Definition at line 95 of file PropertySetFormatter.cc.

                                                          {
}

lsst::daf::persistence::PropertySetFormatter::PropertySetFormatter ( pexPolicy::Policy::Ptr  policy )

private

Constructor.

Parameters

[in]

policy

Policy for configuring this Formatter

Definition at line 88 of file PropertySetFormatter.cc.

                               :
    dafPersist::Formatter(typeid(*this)), _policy(policy) {
}

Member Function Documentation

dafPersist::Formatter::Ptr lsst::daf::persistence::PropertySetFormatter::createInstance ( pexPolicy::Policy::Ptr  policy )

staticprivate

Factory method for PropertySetFormatter.

Parameters

[in]

policy

Policy for configuring the PropertySetFormatter

Returns

Shared pointer to a new instance

Definition at line 251 of file PropertySetFormatter.cc.

                               {
    return dafPersist::Formatter::Ptr(new dafPersist::PropertySetFormatter(policy));
}

template<class Archive >

void lsst::daf::persistence::PropertySetFormatter::delegateSerialize ( Archive &  ar, unsigned int const  version, dafBase::Persistable *  persistable  )

static

Serialize a PropertySet to a Boost archive. Handles text or XML archives, input or output.

Parameters

[in,out]	ar	Boost archive
[in]	version	Version of the PropertySet class
[in,out]	persistable	Pointer to the PropertySet as a Persistable

Definition at line 115 of file PropertySetFormatter.cc.

                                                                              {
    dafBase::PropertySet* ps =
        dynamic_cast<dafBase::PropertySet*>(persistable);
    if (ps == 0) {
        throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Serializing non-PropertySet");
    }
    ar & make_nvp("base",
                  boost::serialization::base_object<dafBase::Persistable>(*ps));

    std::vector<std::string> names;
    size_t nNames;
    if (Archive::is_saving::value) {
        names = ps->paramNames(false);
        nNames = names.size();
    }
    ar & make_nvp("nitems", nNames);

    char type;
    std::string name;
    for (size_t i = 0; i < nNames; ++i) {
        if (Archive::is_saving::value) {
            name = names[i];
            std::type_info const& id(ps->typeOf(name));

            if (id == typeid(bool)) type = 'b';
            else if (id == typeid(char)) type = 'c';
            else if (id == typeid(signed char)) type = 'y';
            else if (id == typeid(unsigned char)) type = 'C';
            else if (id == typeid(short)) type = 'w';
            else if (id == typeid(unsigned short)) type = 'W';
            else if (id == typeid(int)) type = 'i';
            else if (id == typeid(unsigned int)) type = 'I';
            else if (id == typeid(long)) type = 'l';
            else if (id == typeid(unsigned long)) type = 'L';
            else if (id == typeid(long long)) type = 'x';
            else if (id == typeid(unsigned long long)) type = 'X';
            else if (id == typeid(float)) type = 'f';
            else if (id == typeid(double)) type = 'd';
            else if (id == typeid(std::string)) type = 's';
            else if (id == typeid(dafBase::DateTime)) type = 'T';
            else if (id == typeid(dafBase::Persistable::Ptr)) type = 'p';
            else {
                throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError,
                                  name +
                                  ": Unknown type in PropertySet serialize");
            }
        }

        ar & make_nvp("name", name);
        ar & make_nvp("type", type);
        switch (type) {
        case 'b': serializeItem<Archive, bool>(ar, name, ps); break;
        case 'c': serializeItem<Archive, char>(ar, name, ps); break;
        case 'y': serializeItem<Archive, signed char>(ar, name, ps); break;
        case 'C': serializeItem<Archive, unsigned char>(ar, name, ps); break;
        case 'w': serializeItem<Archive, short>(ar, name, ps); break;
        case 'W': serializeItem<Archive, unsigned short>(ar, name, ps); break;
        case 'i': serializeItem<Archive, int>(ar, name, ps); break;
        case 'I': serializeItem<Archive, unsigned int>(ar, name, ps); break;
        case 'l': serializeItem<Archive, long>(ar, name, ps); break;
        case 'L': serializeItem<Archive, unsigned long>(ar, name, ps); break;
        case 'x': serializeItem<Archive, long long>(ar, name, ps); break;
        case 'X': serializeItem<Archive, unsigned long long>(ar, name, ps); break;
        case 'f': serializeItem<Archive, float>(ar, name, ps); break;
        case 'd': serializeItem<Archive, double>(ar, name, ps); break;
        case 's': serializeItem<Archive, std::string>(ar, name, ps); break;
        case 'T': serializeDateTime<Archive>(ar, name, ps); break;
        case 'p': serializeItem<Archive, dafBase::Persistable::Ptr>(ar, name, ps); break;
        default:
                  throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError,
                      std::string("Unknown type reading PropertySet") +
                      type + ", name = " + name);
        }
    }
}

dafBase::Persistable * lsst::daf::persistence::PropertySetFormatter::read ( dafPersist::Storage::Ptr  storage, dafBase::PropertySet::Ptr  additionalData  )

virtual

Definition at line 218 of file PropertySetFormatter.cc.

                                                                        {
    execTrace("PropertySetFormatter read start");
    dafBase::PropertySet* ps = new dafBase::PropertySet;
    if (typeid(*storage) == typeid(dafPersist::BoostStorage)) {
        execTrace("PropertySetFormatter read BoostStorage");
        dafPersist::BoostStorage* boost =
            dynamic_cast<dafPersist::BoostStorage*>(storage.get());
        boost->getIArchive() & *ps;
        execTrace("PropertySetFormatter read end");
        return ps;
    }
    else if (typeid(*storage) == typeid(dafPersist::XmlStorage)) {
        execTrace("PropertySetFormatter read XmlStorage");
        dafPersist::XmlStorage* xml =
            dynamic_cast<dafPersist::XmlStorage*>(storage.get());
        xml->getIArchive() & make_nvp("propertySet", *ps);
        execTrace("PropertySetFormatter read end");
        return ps;
    }
    throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Unrecognized Storage for PropertySet");
}

void lsst::daf::persistence::PropertySetFormatter::update ( dafBase::Persistable *  persistable, dafPersist::Storage::Ptr  storage, dafBase::PropertySet::Ptr  additionalData  )

virtual

Definition at line 241 of file PropertySetFormatter.cc.

                                                                         {
    throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Unexpected call to update for PropertySet");
}

void lsst::daf::persistence::PropertySetFormatter::write ( dafBase::Persistable const *  persistable, dafPersist::Storage::Ptr  storage, dafBase::PropertySet::Ptr  additionalData  )

virtual

Definition at line 98 of file PropertySetFormatter.cc.

                                          {
    execTrace("PropertySetFormatter write start");
    dafBase::PropertySet const* ps =
        dynamic_cast<dafBase::PropertySet const*>(persistable);
    if (ps == 0) {
        throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Persisting non-PropertySet");
    }
    if (typeid(*storage) == typeid(dafPersist::BoostStorage)) {
        execTrace("PropertySetFormatter write BoostStorage");
        dafPersist::BoostStorage* boost =
            dynamic_cast<dafPersist::BoostStorage*>(storage.get());
        boost->getOArchive() & *ps;
        execTrace("PropertySetFormatter write end");
        return;
    }
    else if (typeid(*storage) == typeid(dafPersist::XmlStorage)) {
        execTrace("PropertySetFormatter write XmlStorage");
        dafPersist::XmlStorage* xml =
            dynamic_cast<dafPersist::XmlStorage*>(storage.get());
        xml->getOArchive() & make_nvp("propertySet", *ps);
        execTrace("PropertySetFormatter write end");
        return;
    }
    else if (typeid(*storage) == typeid(dafPersist::DbStorage)) {
        execTrace("PropertySetFormatter write DbStorage");
        dafPersist::DbStorage* db =
            dynamic_cast<dafPersist::DbStorage*>(storage.get());

        std::string itemName = additionalData->getAsString("itemName");
        std::string tableName = itemName;
        pexPolicy::Policy::Ptr itemPolicy;
        if (_policy && _policy->exists(itemName)) {
            itemPolicy = _policy->getPolicy(itemName);
            if (itemPolicy->exists("TableName")) {
                tableName = itemPolicy->getString("TableName");
            }
        }
        db->setTableForInsert(tableName);

        std::vector<std::string> list;
        if (itemPolicy && itemPolicy->exists("KeyList")) {
            pexPolicy::Policy::StringArray const& array(
                itemPolicy->getStringArray("KeyList"));
            for (pexPolicy::Policy::StringArray::const_iterator it =
                 array.begin(); it != array.end(); ++it) {
                list.push_back(*it);
            }
        }
        else {
            list = ps->paramNames(false);
        }

        for (std::vector<std::string>::const_iterator it = list.begin();
             it != list.end(); ++it) {
            std::string::size_type split = it->find('=');
            std::string colName;
            std::string key;
            if (split == std::string::npos) {
                colName = key = *it;
            }
            else {
                colName = it->substr(0, split);
                key = it->substr(split + 1);
            }

            if (!ps->exists(key)) {
                db->setColumnToNull(colName);
                continue;
            }

            std::type_info const& type(ps->typeOf(key));

            if (type == typeid(bool)) {
                db->setColumn<bool>(colName, ps->get<bool>(key));
            }
            else if (type == typeid(char)) {
                db->setColumn<char>(colName, ps->get<char>(key));
            }
            else if (type == typeid(short)) {
                db->setColumn<short>(colName, ps->get<short>(key));
            }
            else if (type == typeid(int)) {
                db->setColumn<int>(colName, ps->get<int>(key));
            }
            else if (type == typeid(long)) {
                db->setColumn<long>(colName, ps->get<long>(key));
            }
            else if (type == typeid(long long)) {
                db->setColumn<long long>(colName, ps->get<long long>(key));
            }
            else if (type == typeid(float)) {
                db->setColumn<float>(colName, ps->get<float>(key));
            }
            else if (type == typeid(double)) {
                db->setColumn<double>(colName, ps->get<double>(key));
            }
            else if (type == typeid(std::string)) {
                db->setColumn<std::string>(colName, ps->get<std::string>(key));
            }
            else if (type == typeid(dafBase::DateTime)) {
                db->setColumn<dafBase::DateTime>(
                    colName, ps->get<dafBase::DateTime>(key));
            }
            else {
                throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError,
                    std::string("Unknown type ") + type.name() +
                    " in PropertySetFormatter write");
            }
        }
        db->insertRow();
        execTrace("PropertySetFormatter write end");
        return;
    }

    throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Unrecognized Storage for PropertySet");
}

Member Data Documentation

pexPolicy::Policy::Ptr lsst::daf::persistence::PropertySetFormatter::_policy

private

Definition at line 80 of file PropertySetFormatter.h.

dafPersist::FormatterRegistration lsst::daf::persistence::PropertySetFormatter::registration

staticprivate

Register this Formatter subclass through a static instance of FormatterRegistration.

Definition at line 84 of file PropertySetFormatter.h.

---

The documentation for this class was generated from the following files:

• /home/lsstsw/stack/Linux64/daf_persistence/11.0-1-g7418c06/include/lsst/daf/persistence/PropertySetFormatter.h
• /home/lsstsw/stack/Linux64/daf_persistence/11.0-1-g7418c06/src/PropertySetFormatter.cc
• /home/lsstsw/stack/Linux64/daf_persistence/11.0-1-g7418c06/include/lsst/daf/persistence/PropertySetFormatter.cc