StringTableLookup.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 "common/AbstractObject.h"

namespace RESQML2_0_1_NS
{
    class DLL_IMPORT_OR_EXPORT StringTableLookup : public COMMON_NS::AbstractObject
    {
    public:

        StringTableLookup(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : COMMON_NS::AbstractObject(partialObject) {}

        StringTableLookup() {}

        StringTableLookup(soap* soapContext, const std::string & guid, const std::string & title);

        StringTableLookup(gsoap_resqml2_0_1::_resqml2__StringTableLookup* fromGsoap) : AbstractObject(fromGsoap) {}

        ~StringTableLookup() {}
        
        static const char* XML_TAG;
        virtual std::string getXmlTag() const {return XML_TAG;}

        void addCategoricalPropertyValues(class CategoricalProperty* categVal) {categoricalPropertyValuesSet.push_back(categVal);}

        bool containsKey(const long & longValue);

        unsigned int getItemCount() const;

        long getKeyAtIndex(const unsigned int & index) const;

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

        std::string getStringValue(const long & longValue);

        void addValue(const std::string & strValue, const long & longValue);

        void setValue(const std::string & strValue, const long & longValue);

        /*
        * Get the minimum value in this discrete properties. It reads it from file.
        * @return the minimum value if present in the file otherwise long.max.
        */
        LONG64 getMinimumValue();

        /*
        * Get the maximum value in this discrete properties. It reads it from file.
        * @return the maximum value if present in the file otherwise long.min.
        */
        LONG64 getMaximumValue();

        /*
        * Getter for the underlying map of the string lookup.
        */
#if (defined(_WIN32) && _MSC_VER >= 1600) || defined(__APPLE__)
        std::unordered_map<long, std::string> getMap() const;
#else
        std::tr1::unordered_map<long, std::string> getMap() const;
#endif

    protected:

        std::vector<epc::Relationship> getAllEpcRelationships() const;
        void importRelationshipSetFromEpc(COMMON_NS::EpcDocument* epcDoc) {}

        // XML backwards relationships
        std::vector<class CategoricalProperty*> categoricalPropertyValuesSet;
    };
}