PIMItemIndex.hpp

Go to the documentation of this file.

/*
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
#ifndef PIMITEMINDEX_HPP_
#define PIMITEMINDEX_HPP_

#include <string>
#include <vector>
#include <helpers/SmartPtr.hpp>

namespace OpenAB {
enum PIMItemType
{
  eContact,   
  eEvent,     
  eTask       
};

class PIMItemIndex
{
  public:
    PIMItemIndex(OpenAB::PIMItemType t);

    virtual ~PIMItemIndex();

    struct PIMItemCheck
    {
        enum eFieldRole
        {
          eKey,      
          eConflict  
        };

        PIMItemCheck(const std::string& name, eFieldRole role) :
          fieldName(name),
          fieldRole(role),
          enabled(true)
        {}

        ~PIMItemCheck() {}

        std::string fieldName;
        eFieldRole fieldRole;
        bool enabled;
    };

    virtual bool operator==(const PIMItemIndex& other) const = 0;

    virtual bool operator!=(const PIMItemIndex& other) const = 0;

    virtual bool operator<(const PIMItemIndex& other) const = 0;

    virtual void addKeyField(const std::string& name, const std::string& value);

    virtual void addConflictField(const std::string& name, const std::string& value);

    virtual bool compare(const PIMItemIndex& other) const = 0;

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

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

    OpenAB::PIMItemType getType() const;

  protected:
    bool compareVectors(const std::vector<std::string>& v1,
                        const std::vector<std::string>& v2) const;

    std::vector<std::string> key_fields;
    std::vector<std::string> conflict_fields;
    std::vector<std::string> key_fields_names;
    std::vector<std::string> conflict_fields_names;

    mutable std::string cached_to_string;

  private:
    OpenAB::PIMItemType type;
};

} // namespace OpenAB

#endif // PIMITEMINDEX_HPP_