AbstractObject.h

/*-----------------------------------------------------------------------
Copyright F2I-CONSULTING, (2014-2017)

philippe.verney@f2i-consulting.com

This software is a computer program whose purpose is to access to data formatted using Energistics standards.

This software is governed by the CeCILL-B license under French law and
abiding by the rules of distribution of free software.  You can  use, 
modify and/ or redistribute the software under the terms of the CeCILL-B
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info". 

As a counterpart to the access to the source code and  rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty  and the software's author,  the holder of the
economic rights,  and the successive licensors  have only  limited
liability. 

In this respect, the user's attention is drawn to the risks associated
with loading,  using,  modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean  that it is complicated to manipulate,  and  that  also
therefore means  that it is reserved for developers  and  experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or 
data to be ensured and,  more generally, to use and operate it in the 
same conditions as regards security. 

The fact that you are presently reading this means that you have had
knowledge of the CeCILL-B license and that you accept its terms.
-----------------------------------------------------------------------*/
#pragma once

#include "proxies/gsoap_resqml2_0_1H.h"
#include "proxies/gsoap_eml2_1H.h"
#include "common/EpcDocument.h"

namespace common
{
    class DLL_IMPORT_OR_EXPORT AbstractObject
    {
    private:
        gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject; // only in case of partial transfer

        void setUuid(const std::string & uuid);

        void pushBackExtraMetadataV2_0_1(const std::string & key, const std::string & value);

#if (defined(_WIN32) && _MSC_VER >= 1600) || defined(__APPLE__)
        std::unordered_map< std::string, std::string > getExtraMetadataSetV2_0_1() const;
#else
        std::tr1::unordered_map< std::string, std::string > getExtraMetadataSetV2_0_1() const;
#endif

        std::vector<std::string> getExtraMetadataV2_0_1(const std::string & key) const;

        unsigned int getExtraMetadataCountV2_0_1() const;

        std::string getExtraMetadataKeyAtIndexV2_0_1(const unsigned int & index) const;

        std::string getExtraMetadataStringValueAtIndexV2_0_1(const unsigned int & index) const;

    protected:

        enum EmlVersion {
            TWO_DOT_ZERO = 0,
            TWO_DOT_ONE = 1,
        };
        
        gsoap_resqml2_0_1::eml20__AbstractCitedDataObject* gsoapProxy2_0_1;
        gsoap_eml2_1::eml21__AbstractObject* gsoapProxy2_1;
        common::EpcDocument* epcDocument;
        std::vector<resqml2::Activity*> activitySet;

        bool updateXml; 

        //Default constructor
        AbstractObject();

        AbstractObject(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject);

        AbstractObject(gsoap_resqml2_0_1::eml20__AbstractCitedDataObject* proxy);

        AbstractObject(gsoap_eml2_1::eml21__AbstractObject* proxy);

        friend void common::EpcDocument::addGsoapProxy(AbstractObject* proxy);

        void initMandatoryMetadata();
        
        virtual void importRelationshipSetFromEpc(common::EpcDocument * epcDoc) = 0;
        friend void common::EpcDocument::updateAllRelationships();

        virtual std::vector<epc::Relationship> getAllEpcRelationships() const = 0;
        friend void common::EpcDocument::serialize(bool useZip64);

        // Only for Activity. Can not use friendness between AbstractObject and Activity for circular dependencies reason.
        static void addActivityToResqmlObject(resqml2::Activity* activity, AbstractObject* resqmlObject);

        void setMetadata(const std::string & guid, const std::string & title, const std::string & editor, const time_t & creation, const std::string & originator,
            const std::string & description, const time_t & lastUpdate, const std::string & format, const std::string & descriptiveKeywords);

        void cannotBePartial() const;

        void changeToPartialObject();

    public:
        virtual ~AbstractObject() {}

        bool isPartial() const {return partialObject != nullptr;}

        std::string getUuid() const;
        std::string getTitle() const;
        std::string getEditor() const;
        time_t getCreation() const;
        std::string getOriginator() const;
        std::string getDescription() const;
        time_t getLastUpdate() const;
        std::string getFormat() const;
        std::string getDescriptiveKeywords() const;

        void setTitle(const std::string & title);
        void setEditor(const std::string & editor);
        void setCreation(const time_t & creation);
        void setOriginator(const std::string & originator);
        void setDescription(const std::string & description);
        void setLastUpdate(const time_t & lastUpdate);
        void setFormat(const std::string & format);
        void setDescriptiveKeywords(const std::string & descriptiveKeywords);

        void setMetadata(const std::string & title, const std::string & editor, const time_t & creation, const std::string & originator,
            const std::string & description, const time_t & lastUpdate, const std::string & format, const std::string & descriptiveKeywords);

        void serializeIntoStream(std::ostream * stream);

        gsoap_resqml2_0_1::eml20__AbstractCitedDataObject* getGsoapProxy() const {return gsoapProxy2_0_1;}

        soap* getGsoapContext() const;

        int getGsoapType() const;

        gsoap_resqml2_0_1::eml20__DataObjectReference* newResqmlReference() const;
        gsoap_eml2_1::eml21__DataObjectReference* newEmlReference() const;

        gsoap_resqml2_0_1::resqml2__ContactElementReference* newResqmlContactElementReference() const;

        common::EpcDocument* getEpcDocument() const {return epcDocument;}

        virtual std::string getXmlNamespace() const;

        virtual std::string getXmlTag() const = 0;

        virtual std::string getResqmlVersion() const;

        virtual std::string getContentType() const;
        
        virtual std::string getPartNameInEpcDocument() const;

        std::string serializeIntoString();  

        void addAlias(const std::string & authority, const std::string & title);

        unsigned int getAliasCount() const;

        std::string getAliasAuthorityAtIndex(const unsigned int & index) const;

        std::string getAliasTitleAtIndex(const unsigned int & index) const;

        const std::vector<resqml2::Activity*> & getActivitySet() const;

        unsigned int getActivityCount() const;

        resqml2::Activity* getActivity (const unsigned int & index) const;

        void pushBackExtraMetadata(const std::string & key, const std::string & value);

#if (defined(_WIN32) && _MSC_VER >= 1600) || defined(__APPLE__)
        std::unordered_map< std::string, std::string > getExtraMetadataSet() const;
#else
        std::tr1::unordered_map< std::string, std::string > getExtraMetadataSet() const;
#endif

        std::vector<std::string> getExtraMetadata(const std::string & key) const;

        unsigned int getExtraMetadataCount() const;

        std::string getExtraMetadataKeyAtIndex(const unsigned int & index) const;

        std::string getExtraMetadataStringValueAtIndex(const unsigned int & index) const;
    };
}