cel_datastore.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
//
// (C) 2003-2006 Celartem Technology Inc. All rights reserved.
//----------------------------------------------------------------------------

#ifndef _cel_datastore_h_
#define _cel_datastore_h_

#include "cel_string.h"
#include "cel_autoptr.h"
#include "cel_guid.h"
#include "cel_time.h"
#include "cel_serializable.h"
#include "cel_exception.h"

namespace Celartem
{
    class Stream;
    class BasicDataArray;

    class DataStore : public Serializable
    {
    public:
        //--------------------------------------------------------------------
        virtual AutoPtr<DataStore> addDataStore(
            const String& inName, UChar4 pathSep = '\0') = 0;

        virtual void set(
            const String& inName, Serializable *inSerializable,
            UChar4 pathSep = '\0') = 0;

        template<typename T> void setT(
            const String& inName, const T& inValue,
            UChar4 pathSep = '\0')
        {
            set(inName, new SerializableData<T>(inValue), pathSep);
        }


        virtual size_t getSize() const = 0;

        virtual String getName(size_t inIndex) const = 0;

        virtual AutoPtr<Serializable> at(size_t inIndex) = 0;

        virtual AutoPtr<const Serializable> at(size_t inIndex) const = 0;

        template<class T> AutoPtr<T> at(size_t inIndex)
        {
            AutoPtr<Serializable> s = at(inIndex);
            T *p = dynamic_cast<T *>(s.getPtr());
            if(!p)
                celThrow(errTypeMismatch);
            return p;
        }

        template<class T> AutoPtr<const T> at(size_t inIndex) const
        {
            AutoPtr<const Serializable> s = at(inIndex);
            const T *p = dynamic_cast<const T *>(s.getPtr());
            if(!p)
                celThrow(errTypeMismatch);
            return p;
        }

        virtual AutoPtr<Serializable> get(
            const String& inName, UChar4 pathSep = '\0') = 0;

        virtual AutoPtr<const Serializable> get(
            const String& inName, UChar4 pathSep = '\0') const = 0;

        template<class T> AutoPtr<T> get(
            const String& inName, UChar4 pathSep = '\0')
        {
            AutoPtr<Serializable> s = get(inName, pathSep);
            T *p = dynamic_cast<T *>(s.getPtr());
            if(!p)
            {
                celThrow2(
                    errTypeMismatch,
                    TO_MBS(format_utf8(
                        "Although the object type is %s, "
                        "you requested %s.",
                        Serializable::getClassName(
                            typeid(*s).name()).c_str(),
                        Serializable::getClassName(
                            typeid(T).name()).c_str()
                        )));
            }
            return p;
        }

        template<class T> AutoPtr<const T> get(
            const String& inName, UChar4 pathSep = '\0') const
        {
            AutoPtr<const Serializable> s = get(inName, pathSep);
            const T *p = dynamic_cast<const T *>(s.getPtr());
            if(!p)
                celThrow(errTypeMismatch);
            return p;
        }

        virtual void unlink(const String& inName, UChar4 pathSep = '\0') = 0;

        //--------------------------------------------------------------------
        void setProperty_U64(
            const String& inName, uint64_t v, UChar4 pathSep = '\0');

        void setProperty_I64(
            const String& inName, int64_t v, UChar4 pathSep = '\0');

        void setProperty_U32(
            const String& inName, u32 v, UChar4 pathSep = '\0');

        void setProperty_I32(
            const String& inName, i32 v, UChar4 pathSep = '\0');

        void setProperty_Double(
            const String& inName, double v, UChar4 pathSep = '\0');

        void setProperty(
            const String& inName, size_t v, UChar4 pathSep = '\0');

        void setProperty(
            const String& inName, const char *v, UChar4 pathSep = '\0');

        void setProperty(
            const String& inName, const utf8s& v, UChar4 pathSep = '\0');

        void setProperty(
            const String& inName, const String& v, UChar4 pathSep = '\0');

        void setProperty(
            const String& inName, const Time& v, UChar4 pathSep = '\0');

        void setProperty(
            const String& inName, const TimeSpan& v, UChar4 pathSep = '\0');

        void setProperty(
            const String& inName, const Guid& v, UChar4 pathSep = '\0');

        void setProperty(
            const String& inName, Serializable *inSerializable,
            UChar4 pathSep = '\0');

        //--------------------------------------------------------------------
        AutoPtr<DataStore> getAsDataStore(
            const String& inName, UChar4 pathSep = '\0');

        AutoPtr<const DataStore> getAsDataStore(
            const String& inName, UChar4 pathSep = '\0') const;

        //--------------------------------------------------------------------
        AutoPtr<BasicDataArray> getAsDataArray(
            const String& inName, UChar4 pathSep = '\0');

        AutoPtr<const BasicDataArray> getAsDataArray(
            const String& inName, UChar4 pathSep = '\0') const;

        ssize_t getAsInteger(
            const String& inName, UChar4 pathSep = '\0') const;

        size_t getAsUInteger(
            const String& inName, UChar4 pathSep = '\0') const;

        int64_t getAsInteger64(
            const String& inName, UChar4 pathSep = '\0') const;

        uint64_t getAsUInteger64(
            const String& inName, UChar4 pathSep = '\0') const;

        double getAsDouble(
            const String& inName, UChar4 pathSep = '\0') const;

        String getAsString(
            const String& inName, UChar4 pathSep = '\0') const;

        Time getAsTime(
            const String& inName, UChar4 pathSep = '\0') const;

        TimeSpan getAsTimeSpan(
            const String& inName, UChar4 pathSep = '\0') const;

        Guid getAsGUID(
            const String& inName, UChar4 pathSep = '\0') const;

        //--------------------------------------------------------------------
        bool doesExist(const String& inName, UChar4 pathSep = '\0') const;

        //--------------------------------------------------------------------
        String getClassOf(const String& inName, UChar4 pathSep = '\0') const;

        const Guid& getClassIdOf(
            const String& inName, UChar4 pathSep = '\0') const;

        //--------------------------------------------------------------------
        static AutoPtr<DataStore> create();

        static AutoPtr<DataStore> create(
            Stream *inStream);

        //--------------------------------------------------------------------
        static AutoPtr<Serializable> deserialize(
            Stream *inStream, size_t inLevel = 0, Endian inEndian = endianBig);

        //--------------------------------------------------------------------
        virtual void instructNoChecksum() = 0;

        //--------------------------------------------------------------------
        virtual AutoPtr<DataStore> duplicateDataStore() = 0;
    };


} // namespace Celartem

#endif // _cel_datastore_h_

---

This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:21:54 2008.