genericDocumentProperties.h

Go to the documentation of this file.

// Copyright 2002-2013 CEA LIST
// SPDX-FileCopyrightText: 2022 CEA LIST <gael.de-chalendar@cea.fr>
//
// SPDX-License-Identifier: MIT
 
/************************************************************************
 *
 * @file       documentProperties.h
 * @author     Besancon Romaric (besanconr@zoe.cea.fr)
 * @date       Fri Oct 10 2003
 * @version    $Id$
 * copyright   Copyright (C) 2003-2012 by CEA LIST
 * Project     BagOfWords
 *
 * @brief      representation of generic properties of a document
 *
 *
 ***********************************************************************/
 
#ifndef GENERICDOCUMENTPROPERTIES_H
#define GENERICDOCUMENTPROPERTIES_H
 
#include "common/LimaCommon.h"
 
#include <QtCore/QDate>
 
#include <iostream>
#include <string>
#include <vector>
#include <map>
 
namespace Lima {
namespace Common {
namespace Misc {
 
template<typename ValT>
class MultiValuedPropertyIterator {
public:
  MultiValuedPropertyIterator(const typename std::map<std::string, std::vector<ValT> >::const_iterator pos);
  MultiValuedPropertyIterator(const MultiValuedPropertyIterator& orig);
  MultiValuedPropertyIterator& operator = (const MultiValuedPropertyIterator& orig);
  MultiValuedPropertyIterator& operator++(int);
  bool operator != (const MultiValuedPropertyIterator& orig ) const;
  bool operator == (const MultiValuedPropertyIterator& orig ) const;
  const std::string& operator *() const;
private:
  typename std::map<std::string,std::vector<ValT> >::const_iterator m_pos;
};
 
typedef std::vector<std::string>::const_iterator StringPropMultIter;
typedef std::vector<std::pair<std::string,float> >::const_iterator WeightedPropMultIter;
 
class GenericDocumentPropertiesPrivate;
class LIMA_DATA_EXPORT GenericDocumentProperties
{
  friend class GenericDocumentPropertiesPrivate;
 public:
  GenericDocumentProperties();
  GenericDocumentProperties(const GenericDocumentProperties&);
  virtual ~GenericDocumentProperties();
  GenericDocumentProperties& operator = (const GenericDocumentProperties&);
 
  virtual void reinit();
 
  virtual void read(std::istream& file);
  void write(std::ostream& file) const;
 
  friend LIMA_DATA_EXPORT std::ostream& operator << (std::ostream&, const GenericDocumentProperties&);
  friend LIMA_DATA_EXPORT QTextStream& operator << (QTextStream&, const GenericDocumentProperties&);
  friend LIMA_DATA_EXPORT QDebug& operator << (QDebug&, const GenericDocumentProperties&);
 
  virtual void print(std::ostream&) const;
  virtual void print(QTextStream&) const;
  virtual void print(QDebug&) const;
  virtual bool is_empty() const;
 
  std::pair<uint64_t, bool> getIntValue(std::string propName) const;
  std::pair<std::string, bool> getStringValue(std::string propName) const;
  std::pair<QDate, bool> getDateValue(std::string propName) const;
  std::pair<std::pair<QDate,QDate>, bool> getDateIntervalValue(std::string propName) const;
 
  std::pair< StringPropMultIter, StringPropMultIter > getMultipleStringPropValue(std::string propName) const;
  std::pair< WeightedPropMultIter, WeightedPropMultIter > getMultipleWeightedPropValue(std::string propName) const;
 
  typedef std::map<std::string,uint64_t>::const_iterator IntPropertiesIterator;
  std::pair<IntPropertiesIterator,IntPropertiesIterator> getIntProperties() const;
 
  typedef std::map<std::string,std::string>::const_iterator StringPropertiesIterator;
  std::pair<StringPropertiesIterator,StringPropertiesIterator> getStringProperties() const;
 
  typedef std::map<std::string,QDate>::const_iterator DatePropertiesIterator;
  std::pair<DatePropertiesIterator,DatePropertiesIterator> getDateProperties() const;
 
  typedef std::map<std::string,std::pair<QDate,QDate> >::const_iterator DateIntervalPropertiesIterator;
  std::pair<DateIntervalPropertiesIterator,DateIntervalPropertiesIterator> getDateIntervalProperties() const;
 
  std::pair<MultiValuedPropertyIterator<std::string>,MultiValuedPropertyIterator<std::string> > getStringPropertyNames() const;
  std::pair<MultiValuedPropertyIterator<std::pair<std::string,float> >,MultiValuedPropertyIterator<std::pair<std::string,float> > > getWeightedPropPropertyNames() const;
  void setIntValue(const std::string& propName, const uint64_t& val);
  void setStringValue(const std::string& propName, const std::string& val);
  void setDateValue(const std::string& propName, const QDate& val);
  void setDateIntervalValue(const std::string& propName, const std::pair<QDate,QDate>& val);
  void setMultipleStringPropValue(const std::string& propName, const std::vector<std::string>& val);
  void setMultipleWeightedPropValue(const std::string& propName, const std::vector<std::pair<std::string,float> >& val);
 
  void addStringValue(const std::string& propName, const std::string& str);
  void addWeightedPropValue(const std::string& propName, const std::pair<std::string,float>& str);
 
 protected:
   GenericDocumentPropertiesPrivate* m_d;
};
 
//***********************************************************************
// iterator for multi-valued properties
//***********************************************************************
template<typename ValT>
// Constructor
MultiValuedPropertyIterator<ValT>::MultiValuedPropertyIterator(
  const typename std::map<std::string,std::vector<ValT> >::const_iterator pos)
  : m_pos(pos) {
}
 
template<typename ValT>
MultiValuedPropertyIterator<ValT>::MultiValuedPropertyIterator(
  const MultiValuedPropertyIterator& orig)
  : m_pos(orig.m_pos) {
}
 
template<typename ValT>
MultiValuedPropertyIterator<ValT>& MultiValuedPropertyIterator<ValT>::operator = (
 const MultiValuedPropertyIterator<ValT>& orig ) {
  m_pos = orig.m_pos;
  return *this;
}
 
template<typename ValT>
MultiValuedPropertyIterator<ValT>& MultiValuedPropertyIterator<ValT>::operator++ (int) {
  m_pos++;
  return *this;
}
 
template<typename ValT>
bool MultiValuedPropertyIterator<ValT>::operator != ( const MultiValuedPropertyIterator<ValT>& orig ) const {
  return( m_pos != orig.m_pos );
}
 
template<typename ValT>
bool MultiValuedPropertyIterator<ValT>::operator == ( const MultiValuedPropertyIterator<ValT>& orig ) const {
  return( m_pos == orig.m_pos );
}
 
template<typename ValT>
const std::string& MultiValuedPropertyIterator<ValT>::operator *() const {
  return( (*m_pos).first );
}
 
 
} // end namespace Misc
} // end namespace Common
} // end namespace Lima
 
#endif