dbread2object.h

/*
Copyright (c) 2015, 2016 Sidorov Dmitry

Permission is hereby granted, free of charge, to any person obtaining a copy of this software
and associated documentation files (the "Software"), to deal in the Software without restriction, 
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, 
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, 
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial 
portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT 
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN 
NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.  
*/

#ifndef DBREAD2OBJECT_H
#define DBREAD2OBJECT_H

#include "dbreader.h"

namespace dbframework {

/*!

    !!! The DBReader2Object class template is DEPRECATED !!! Use DBReader2Storage.

    The DBReader2Object template class is a special desccendant of DBReader. Inherit from DBReader2Object when
    you implement DBReader descendants that must store SQL-query execution result in the fields of some object.
    Descendants of DBReader2Object must implement DBReader::read method to read data from the current record of the
    SQL-query execution result and store it in the object's fields.
    fields.

    Template parameters.

    Dataset - see DBReader.

    Object is the class which instance is used to store data.
*/
template <class Dataset, class Object>
class [[deprecated("Use DBReader2Storage")]] DBReader2Object : public DBReader<Dataset> {
protected:
    /*!
        Pointer to the object that is used to store read data.
    */
    Object *m_object;
public:
    /*!
        Constructs DBReader2Object not assosiated with the object.
    */
    //DBReader2Object() : DBReader<Dataset>(), m_object(nullptr) {};
    /*!
        Constructs DBReader2Object assosiated with the object.
        @param[in] obj Pointer to the object that is used to store read data. The DBReader2Object doesn't take
        ownership of obj.
    */
    DBReader2Object(Object *obj = nullptr) : DBReader<Dataset>(), m_object(obj) {};
    /*!
        Get pointer to object used to store read data.
        @return Pointer to object used to store read data or nullptr if object wasn't assosiated.
    */
    virtual Object* object() {return m_object;};
    /*!
        Assosiate object used to store read data with DBReader2Object instance.
        @param[in] obj Pointer to object used to store read data. The DBReader2Object doesn't take
        ownership of obj.
    */
    virtual void setObject(Object* obj) {m_object = obj;};
};

}

#endif // DBREAD2OBJECT_H