AbstractBoWElement.h

Go to the documentation of this file.

// Copyright 2014 CEA LIST
// SPDX-FileCopyrightText: 2022 CEA LIST <gael.de-chalendar@cea.fr>
//
// SPDX-License-Identifier: MIT
 
/************************************************************************
 * @file     AbstractBoWElement.h
 * @author   Gael de Chalendar <gael.de-chalendar@cea.fr>
 * @date     Thu Jul 24 2003
 * Copyright (C) 2014 by CEA LIST
 ***********************************************************************/
 
#ifndef ABSTRACTBOWELEMENT_H
#define ABSTRACTBOWELEMENT_H
 
#include "common/LimaCommon.h"
#include "linguisticProcessing/LinguisticProcessingCommon.h"
#include "common/Data/LimaString.h"
#include "linguisticProcessing/common/misc/positionLengthList.h"
#include <iostream>
#include <string>
#include <stdexcept>
#include <map>
#include <set>
#include <memory>
 
namespace Lima {
namespace Common {
namespace PropertyCode {
  class PropertyManager;
}
namespace BagOfWords {
 
#ifndef WIN32
enum class BoWType : unsigned short {
#else
enum BoWType {
#endif
  BOW_NOTYPE,                   
  BOW_TOKEN,                    
  BOW_TERM,                     
  BOW_NAMEDENTITY,              
  BOW_PREDICATE,                
};
 
LIMA_BOW_EXPORT uint8_t toInt(const BoWType& bt);
 
template <typename T>
T& operator<<(T& qd, const BoWType& bt) 
{
  if (bt == BoWType::BOW_NOTYPE) qd << "BOW_NOTYPE";
  else if (bt == BoWType::BOW_TOKEN) qd << "BOW_TOKEN";
  else if (bt == BoWType::BOW_TERM) qd << "BOW_TERM";
  else if (bt == BoWType::BOW_NAMEDENTITY) qd << "BOW_NAMEDENTITY";
  else if (bt == BoWType::BOW_PREDICATE) qd << "BOW_PREDICATE";
  else  qd << "UNDEFINED";
  return qd;
};
 
class LIMA_BOW_EXPORT AbstractBoWElement
{
public:
 
  AbstractBoWElement() {}
 
  virtual ~AbstractBoWElement() {}
 
  virtual void clear() {}
 
  virtual AbstractBoWElement* clone() const = 0;
 
  virtual uint64_t size(void) const = 0;
 
  virtual BoWType getType() const {return BoWType::BOW_NOTYPE;}
 
  virtual Lima::LimaString getString(void) const = 0;
 
  virtual uint64_t getPosition(void) const = 0;
  virtual uint64_t getLength(void) const = 0;
  virtual void setPosition(const uint64_t pos) = 0;
  virtual void setLength(const uint64_t len) = 0;
 
  virtual std::set< uint64_t > getVertices() const = 0;
 
  virtual std::string getOutputUTF8String(const Common::PropertyCode::PropertyManager* macroManager = 0) const = 0;
 
  virtual std::string getIdUTF8String() const = 0;
 
};
 
} // namespace BagOfWords
} // namespace Common
} // namespace Lima
 
#endif