LIMA
Libre Multilingual Analyzer — C++ API
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | Friends | List of all members
Lima::Common::Misc::GenericDocumentProperties Class Reference

#include <common/Data/genericDocumentProperties.h>

Inheritance diagram for Lima::Common::Misc::GenericDocumentProperties:
Lima::Common::BagOfWords::BoWDocument Lima::DocumentsReader::AbstractStructuredDocumentElementWithProperties Lima::DocumentsReader::ContentStructuredDocument Lima::Common::BagOfWords::BoWDocumentST Lima::DocumentsReader::HierarchyDocumentElement Lima::DocumentsReader::IgnoredDocumentElement Lima::DocumentsReader::IndexingDocumentElement Lima::DocumentsReader::PresentationDocumentElement

Public Types

typedef std::map< std::string, uint64_t >::const_iterator IntPropertiesIterator
 Read access functions for all "only once valued" properties return an iterator Types may be any of (uint64_t), (std::string), (QDate) or (std::pair<QDate,QDate>) used for approximative date.
 
typedef std::map< std::string, std::string >::const_iterator StringPropertiesIterator
 
typedef std::map< std::string, QDate >::const_iterator DatePropertiesIterator
 
typedef std::map< std::string, std::pair< QDate, QDate > >::const_iterator DateIntervalPropertiesIterator
 

Public Member Functions

 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
 
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
 Read access functions for "only once valued" property propName.
 
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
 Read access functions for "multiple-valued" property propName Return a pair of iterator (begin,end) to iterate through values types may be any of:
 
std::pair< WeightedPropMultIter, WeightedPropMultIter > getMultipleWeightedPropValue (std::string propName) const
 
std::pair< IntPropertiesIterator, IntPropertiesIterator > getIntProperties () const
 
std::pair< StringPropertiesIterator, StringPropertiesIterator > getStringProperties () const
 
std::pair< DatePropertiesIterator, DatePropertiesIterator > getDateProperties () const
 
std::pair< DateIntervalPropertiesIterator, DateIntervalPropertiesIterator > getDateIntervalProperties () const
 
std::pair< MultiValuedPropertyIterator< std::string >, MultiValuedPropertyIterator< std::string > > getStringPropertyNames () const
 Read access functions for all "multiple valued" properties return an iterator of names Types may be any of (std::string) or (std::pair<std::string,float)
 
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 Attributes

GenericDocumentPropertiesPrivate * m_d
 

Friends

class GenericDocumentPropertiesPrivate
 
LIMA_DATA_EXPORT std::ostream & operator<< (std::ostream &, const GenericDocumentProperties &)
 
LIMA_DATA_EXPORT QTextStream & operator<< (QTextStream &, const GenericDocumentProperties &)
 
LIMA_DATA_EXPORT QDebug & operator<< (QDebug &, const GenericDocumentProperties &)
 

Detailed Description

Definition at line 57 of file genericDocumentProperties.h.

Member Typedef Documentation

◆ DateIntervalPropertiesIterator

typedef std::map<std::string,std::pair<QDate,QDate>>::const_iterator Lima::Common::Misc::GenericDocumentProperties::DateIntervalPropertiesIterator

Definition at line 119 of file genericDocumentProperties.h.

◆ DatePropertiesIterator

typedef std::map<std::string,QDate>::const_iterator Lima::Common::Misc::GenericDocumentProperties::DatePropertiesIterator

Definition at line 116 of file genericDocumentProperties.h.

◆ IntPropertiesIterator

typedef std::map<std::string,uint64_t>::const_iterator Lima::Common::Misc::GenericDocumentProperties::IntPropertiesIterator

Read access functions for all "only once valued" properties return an iterator Types may be any of (uint64_t), (std::string), (QDate) or (std::pair<QDate,QDate>) used for approximative date.

Definition at line 110 of file genericDocumentProperties.h.

◆ StringPropertiesIterator

typedef std::map<std::string,std::string>::const_iterator Lima::Common::Misc::GenericDocumentProperties::StringPropertiesIterator

Definition at line 113 of file genericDocumentProperties.h.

Constructor & Destructor Documentation

◆ GenericDocumentProperties() [1/2]

Lima::Common::Misc::GenericDocumentProperties::GenericDocumentProperties ( )

Definition at line 76 of file genericDocumentProperties.cpp.

◆ GenericDocumentProperties() [2/2]

Lima::Common::Misc::GenericDocumentProperties::GenericDocumentProperties ( const GenericDocumentProperties &  p)

Definition at line 81 of file genericDocumentProperties.cpp.

◆ ~GenericDocumentProperties()

Lima::Common::Misc::GenericDocumentProperties::~GenericDocumentProperties ( )
virtual

Definition at line 89 of file genericDocumentProperties.cpp.

Member Function Documentation

◆ addStringValue()

void Lima::Common::Misc::GenericDocumentProperties::addStringValue ( const std::string &  propName,
const std::string &  str 
)

Definition at line 287 of file genericDocumentProperties.cpp.

◆ addWeightedPropValue()

void Lima::Common::Misc::GenericDocumentProperties::addWeightedPropValue ( const std::string &  propName,
const std::pair< std::string, float > &  str 
)

Definition at line 311 of file genericDocumentProperties.cpp.

◆ getDateIntervalProperties()

std::pair< GenericDocumentProperties::DateIntervalPropertiesIterator, GenericDocumentProperties::DateIntervalPropertiesIterator > Lima::Common::Misc::GenericDocumentProperties::getDateIntervalProperties ( ) const

Definition at line 269 of file genericDocumentProperties.cpp.

◆ getDateIntervalValue()

std::pair< std::pair< QDate, QDate >, bool > Lima::Common::Misc::GenericDocumentProperties::getDateIntervalValue ( std::string  propName) const

Definition at line 185 of file genericDocumentProperties.cpp.

◆ getDateProperties()

std::pair< GenericDocumentProperties::DatePropertiesIterator, GenericDocumentProperties::DatePropertiesIterator > Lima::Common::Misc::GenericDocumentProperties::getDateProperties ( ) const

Definition at line 265 of file genericDocumentProperties.cpp.

◆ getDateValue()

std::pair< QDate, bool > Lima::Common::Misc::GenericDocumentProperties::getDateValue ( std::string  propName) const

Definition at line 172 of file genericDocumentProperties.cpp.

◆ getIntProperties()

std::pair< GenericDocumentProperties::IntPropertiesIterator, GenericDocumentProperties::IntPropertiesIterator > Lima::Common::Misc::GenericDocumentProperties::getIntProperties ( ) const

Definition at line 254 of file genericDocumentProperties.cpp.

◆ getIntValue()

std::pair< uint64_t, bool > Lima::Common::Misc::GenericDocumentProperties::getIntValue ( std::string  propName) const

Read access functions for "only once valued" property propName.

If property exists, return a pair (value,true) else return (default value,false) Types may be any of:

  • integer (uint64_t),
  • string (std::string),
  • date (QDate)
  • period (std::pair<QDate,QDate>) used for approximative date

Definition at line 146 of file genericDocumentProperties.cpp.

◆ getMultipleStringPropValue()

std::pair< StringPropMultIter, StringPropMultIter > Lima::Common::Misc::GenericDocumentProperties::getMultipleStringPropValue ( std::string  propName) const

Read access functions for "multiple-valued" property propName Return a pair of iterator (begin,end) to iterate through values types may be any of:

  • string (std::string),
  • weighted property (std::pair<std::string,float) used for result of filtering and categorization

Definition at line 200 of file genericDocumentProperties.cpp.

◆ getMultipleWeightedPropValue()

std::pair< WeightedPropMultIter, WeightedPropMultIter > Lima::Common::Misc::GenericDocumentProperties::getMultipleWeightedPropValue ( std::string  propName) const

Definition at line 215 of file genericDocumentProperties.cpp.

◆ getStringProperties()

std::pair< GenericDocumentProperties::StringPropertiesIterator, GenericDocumentProperties::StringPropertiesIterator > Lima::Common::Misc::GenericDocumentProperties::getStringProperties ( ) const

Definition at line 260 of file genericDocumentProperties.cpp.

◆ getStringPropertyNames()

std::pair< MultiValuedPropertyIterator< std::string >, MultiValuedPropertyIterator< std::string > > Lima::Common::Misc::GenericDocumentProperties::getStringPropertyNames ( ) const

Read access functions for all "multiple valued" properties return an iterator of names Types may be any of (std::string) or (std::pair<std::string,float)

Definition at line 274 of file genericDocumentProperties.cpp.

◆ getStringValue()

std::pair< std::string, bool > Lima::Common::Misc::GenericDocumentProperties::getStringValue ( std::string  propName) const

Definition at line 159 of file genericDocumentProperties.cpp.

◆ getWeightedPropPropertyNames()

std::pair< MultiValuedPropertyIterator< std::pair< std::string, float > >, MultiValuedPropertyIterator< std::pair< std::string, float > > > Lima::Common::Misc::GenericDocumentProperties::getWeightedPropPropertyNames ( ) const

Definition at line 281 of file genericDocumentProperties.cpp.

◆ is_empty()

bool Lima::Common::Misc::GenericDocumentProperties::is_empty ( ) const
virtual

Definition at line 230 of file genericDocumentProperties.cpp.

◆ operator=()

GenericDocumentProperties & Lima::Common::Misc::GenericDocumentProperties::operator= ( const GenericDocumentProperties &  p)

Definition at line 97 of file genericDocumentProperties.cpp.

◆ print() [1/3]

void Lima::Common::Misc::GenericDocumentProperties::print ( QDebug &  qts) const
virtual

Definition at line 749 of file genericDocumentProperties.cpp.

◆ print() [2/3]

void Lima::Common::Misc::GenericDocumentProperties::print ( QTextStream &  qts) const
virtual

Definition at line 741 of file genericDocumentProperties.cpp.

◆ print() [3/3]

void Lima::Common::Misc::GenericDocumentProperties::print ( std::ostream &  os) const
virtual

Definition at line 663 of file genericDocumentProperties.cpp.

◆ read()

void Lima::Common::Misc::GenericDocumentProperties::read ( std::istream &  file)
virtual

Reimplemented in Lima::Common::BagOfWords::BoWDocumentST.

Definition at line 390 of file genericDocumentProperties.cpp.

◆ reinit()

void Lima::Common::Misc::GenericDocumentProperties::reinit ( )
virtual

Reimplemented in Lima::Common::BagOfWords::BoWDocument, and Lima::Common::BagOfWords::BoWDocumentST.

Definition at line 340 of file genericDocumentProperties.cpp.

◆ setDateIntervalValue()

void Lima::Common::Misc::GenericDocumentProperties::setDateIntervalValue ( const std::string &  propName,
const std::pair< QDate, QDate > &  val 
)

Definition at line 127 of file genericDocumentProperties.cpp.

◆ setDateValue()

void Lima::Common::Misc::GenericDocumentProperties::setDateValue ( const std::string &  propName,
const QDate &  val 
)

Definition at line 121 of file genericDocumentProperties.cpp.

◆ setIntValue()

void Lima::Common::Misc::GenericDocumentProperties::setIntValue ( const std::string &  propName,
const uint64_t &  val 
)

Definition at line 115 of file genericDocumentProperties.cpp.

◆ setMultipleStringPropValue()

void Lima::Common::Misc::GenericDocumentProperties::setMultipleStringPropValue ( const std::string &  propName,
const std::vector< std::string > &  val 
)

Definition at line 134 of file genericDocumentProperties.cpp.

◆ setMultipleWeightedPropValue()

void Lima::Common::Misc::GenericDocumentProperties::setMultipleWeightedPropValue ( const std::string &  propName,
const std::vector< std::pair< std::string, float > > &  val 
)

Definition at line 139 of file genericDocumentProperties.cpp.

◆ setStringValue()

void Lima::Common::Misc::GenericDocumentProperties::setStringValue ( const std::string &  propName,
const std::string &  val 
)

Definition at line 109 of file genericDocumentProperties.cpp.

◆ write()

void Lima::Common::Misc::GenericDocumentProperties::write ( std::ostream &  file) const

Definition at line 521 of file genericDocumentProperties.cpp.

Friends And Related Symbol Documentation

◆ GenericDocumentPropertiesPrivate

friend class GenericDocumentPropertiesPrivate
friend

Definition at line 59 of file genericDocumentProperties.h.

◆ operator<< [1/3]

LIMA_DATA_EXPORT QDebug & operator<< ( QDebug &  os,
const GenericDocumentProperties &  p 
)
friend

Definition at line 653 of file genericDocumentProperties.cpp.

◆ operator<< [2/3]

LIMA_DATA_EXPORT QTextStream & operator<< ( QTextStream &  os,
const GenericDocumentProperties &  p 
)
friend

Definition at line 658 of file genericDocumentProperties.cpp.

◆ operator<< [3/3]

LIMA_DATA_EXPORT std::ostream & operator<< ( std::ostream &  os,
const GenericDocumentProperties &  p 
)
friend

Definition at line 648 of file genericDocumentProperties.cpp.

Member Data Documentation

◆ m_d

GenericDocumentPropertiesPrivate* Lima::Common::Misc::GenericDocumentProperties::m_d
protected

Definition at line 140 of file genericDocumentProperties.h.

The documentation for this class was generated from the following files: