AbstractObject.h

/*-----------------------------------------------------------------------
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"; you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-----------------------------------------------------------------------*/
#pragma once

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

namespace COMMON_NS
{
    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_NS::EpcDocument* epcDocument;
        std::vector<RESQML2_NS::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_NS::EpcDocument::addGsoapProxy(AbstractObject* proxy);

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

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

        // Only for Activity. Can not use friendness between AbstractObject and Activity for circular dependencies reason.
        static void addActivityToResqmlObject(RESQML2_NS::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;
        tm getCreationAsTimeStructure() const;
        std::string getOriginator() const;
        std::string getDescription() const;
        time_t getLastUpdate() const;
        tm getLastUpdateAsTimeStructure() const;
        std::string getFormat() const;
        std::string getDescriptiveKeywords() const;
        std::string getVersionString() const;

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

        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;

        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_NS::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_NS::Activity*> & getActivitySet() const;

        unsigned int getActivityCount() const;

        RESQML2_NS::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;
    };
}