LIMA
Libre Multilingual Analyzer — C++ API
Loading...
Searching...
No Matches
Lima::Common::BagOfWords::BoWDocument Class Reference

represent a document as a Bag Of Word, with associated document properties. More...

#include <linguisticProcessing/common/BagOfWords/bowDocument.h>

Inheritance diagram for Lima::Common::BagOfWords::BoWDocument:
Lima::Common::Misc::GenericDocumentProperties Lima::Common::BagOfWords::BoWText Lima::Common::BagOfWords::BoWDocumentST

Public Member Functions

 BoWDocument ()
 
 BoWDocument (const BoWDocument &)
 
virtual ~BoWDocument ()
 
BoWDocument & operator= (const BoWDocument &)
 
virtual void clear () override
 
virtual void reinit () override
 
virtual void setProperties (const Misc::GenericDocumentProperties &properties)
 
- Public Member Functions inherited from Lima::Common::Misc::GenericDocumentProperties
 GenericDocumentProperties ()
 
 GenericDocumentProperties (const GenericDocumentProperties &)
 
virtual ~GenericDocumentProperties ()
 
GenericDocumentProperties & operator= (const GenericDocumentProperties &)
 
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)
 
- Public Member Functions inherited from Lima::Common::BagOfWords::BoWText
 BoWText ()
 
 BoWText (const BoWText &)
 
BoWText & operator= (const BoWText &)
 
virtual ~BoWText ()
 
void writeBoWText (std::ostream &stream)
 

Friends

LIMA_BOW_EXPORT std::ostream & operator<< (std::ostream &, const BoWDocument &)
 
LIMA_BOW_EXPORT QDebug & operator<< (QDebug &, const BoWDocument &)
 

Additional Inherited Members

- Public Types inherited from Lima::Common::Misc::GenericDocumentProperties
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 Attributes inherited from Lima::Common::BagOfWords::BoWText
std::string lang
 
- Protected Attributes inherited from Lima::Common::Misc::GenericDocumentProperties
GenericDocumentPropertiesPrivate * m_d
 

Detailed Description

represent a document as a Bag Of Word, with associated document properties.

Definition at line 54 of file bowDocument.h.

Constructor & Destructor Documentation

◆ BoWDocument() [1/2]

Lima::Common::BagOfWords::BoWDocument::BoWDocument ( )

Definition at line 81 of file bowDocument.cpp.

◆ BoWDocument() [2/2]

Lima::Common::BagOfWords::BoWDocument::BoWDocument ( const BoWDocument &  d)

Definition at line 91 of file bowDocument.cpp.

◆ ~BoWDocument()

Lima::Common::BagOfWords::BoWDocument::~BoWDocument ( )
virtual

Definition at line 104 of file bowDocument.cpp.

Member Function Documentation

◆ clear()

void Lima::Common::BagOfWords::BoWDocument::clear ( )
overridevirtual

Reimplemented from Lima::Common::BagOfWords::BoWText.

Definition at line 122 of file bowDocument.cpp.

◆ operator=()

BoWDocument & Lima::Common::BagOfWords::BoWDocument::operator= ( const BoWDocument &  d)

Definition at line 112 of file bowDocument.cpp.

◆ reinit()

void Lima::Common::BagOfWords::BoWDocument::reinit ( )
overridevirtual

Reimplemented from Lima::Common::Misc::GenericDocumentProperties.

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

Definition at line 139 of file bowDocument.cpp.

◆ setProperties()

void Lima::Common::BagOfWords::BoWDocument::setProperties ( const Misc::GenericDocumentProperties &  properties)
virtual

Definition at line 131 of file bowDocument.cpp.

Friends And Related Symbol Documentation

◆ operator<< [1/2]

LIMA_BOW_EXPORT QDebug & operator<< ( QDebug &  os,
const BoWDocument &  d 
)
friend

Definition at line 238 of file bowDocument.cpp.

◆ operator<< [2/2]

LIMA_BOW_EXPORT std::ostream & operator<< ( std::ostream &  os,
const BoWDocument &  d 
)
friend

Definition at line 231 of file bowDocument.cpp.


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