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

This is a BoW element used to represent a predicate (n-ary relation, template or semantic frame). More...

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

Inheritance diagram for Lima::Common::BagOfWords::BoWPredicate:
Lima::Common::BagOfWords::AbstractBoWElement

Public Member Functions

 BoWPredicate ()
 
 BoWPredicate (const BoWPredicate &)
 
 BoWPredicate (const Common::MediaticData::EntityType theType)
 
 BoWPredicate (const Common::MediaticData::EntityType theType, QMultiMap< Common::MediaticData::EntityType, boost::shared_ptr< AbstractBoWElement > > pRoles)
 
virtual ~BoWPredicate ()
 
virtual uint64_t size (void) const override
 size of the AbstractBoWElement is the number of parts in the token, 0 for a predicate
 
virtual BoWPredicate * clone () const override
 
BoWPredicate & operator= (const BoWPredicate &)
 
bool operator== (const BoWPredicate &)
 
MediaticData::EntityType getPredicateType (void) const
 
void setPredicateType (const MediaticData::EntityType &)
 
virtual BoWType getType () const override
 
virtual Lima::LimaString getString (void) const override
 
virtual uint64_t getPosition (void) const override
 
virtual uint64_t getLength (void) const override
 
virtual void setPosition (const uint64_t pos) override
 
virtual void setLength (const uint64_t len) override
 
virtual std::string getOutputUTF8String (const Common::PropertyCode::PropertyManager *macroManager=0) const override
 get a string of the predicate for output function
 
virtual std::string getIdUTF8String (void) const override
 function used to identify a bowtoken in a text (used in BowDumper)
 
const QMultiMap< Common::MediaticData::EntityType, boost::shared_ptr< AbstractBoWElement > > & roles () const
 
QMultiMap< Common::MediaticData::EntityType, boost::shared_ptr< AbstractBoWElement > > & roles ()
 
void setRoles (QMultiMap< Common::MediaticData::EntityType, boost::shared_ptr< Common::BagOfWords::AbstractBoWElement > > &pRoles)
 
virtual std::set< uint64_t > getVertices () const override
 returns the vertices of the predicate and the roles
 
- Public Member Functions inherited from Lima::Common::BagOfWords::AbstractBoWElement
 AbstractBoWElement ()
 
virtual ~AbstractBoWElement ()
 
virtual void clear ()
 

Protected Member Functions

 BoWPredicate (BoWPredicatePrivate &)
 

Friends

class BoWPredicatePrivate
 

Detailed Description

This is a BoW element used to represent a predicate (n-ary relation, template or semantic frame).

It has a type which is an entity type. It gives access to a collection of typed arguments, its roles.

Definition at line 32 of file BoWPredicate.h.

Constructor & Destructor Documentation

◆ BoWPredicate() [1/5]

Lima::Common::BagOfWords::BoWPredicate::BoWPredicate ( )

Definition at line 65 of file BoWPredicate.cpp.

◆ BoWPredicate() [2/5]

Lima::Common::BagOfWords::BoWPredicate::BoWPredicate ( const BoWPredicate &  ne)

Definition at line 84 of file BoWPredicate.cpp.

◆ BoWPredicate() [3/5]

Lima::Common::BagOfWords::BoWPredicate::BoWPredicate ( const Common::MediaticData::EntityType  theType)

Definition at line 70 of file BoWPredicate.cpp.

◆ BoWPredicate() [4/5]

Lima::Common::BagOfWords::BoWPredicate::BoWPredicate ( const Common::MediaticData::EntityType  theType,
QMultiMap< Common::MediaticData::EntityType, boost::shared_ptr< AbstractBoWElement > >  pRoles 
)

Definition at line 77 of file BoWPredicate.cpp.

◆ ~BoWPredicate()

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

Definition at line 95 of file BoWPredicate.cpp.

◆ BoWPredicate() [5/5]

Lima::Common::BagOfWords::BoWPredicate::BoWPredicate ( BoWPredicatePrivate &  d)
protected

Definition at line 89 of file BoWPredicate.cpp.

Member Function Documentation

◆ clone()

BoWPredicate * Lima::Common::BagOfWords::BoWPredicate::clone ( ) const
overridevirtual

Implements Lima::Common::BagOfWords::AbstractBoWElement.

Definition at line 144 of file BoWPredicate.cpp.

◆ getIdUTF8String()

std::string Lima::Common::BagOfWords::BoWPredicate::getIdUTF8String ( void  ) const
overridevirtual

function used to identify a bowtoken in a text (used in BowDumper)

Implements Lima::Common::BagOfWords::AbstractBoWElement.

Definition at line 185 of file BoWPredicate.cpp.

◆ getLength()

uint64_t Lima::Common::BagOfWords::BoWPredicate::getLength ( void  ) const
overridevirtual

Implements Lima::Common::BagOfWords::AbstractBoWElement.

Definition at line 165 of file BoWPredicate.cpp.

◆ getOutputUTF8String()

std::string Lima::Common::BagOfWords::BoWPredicate::getOutputUTF8String ( const Common::PropertyCode::PropertyManager *  macroManager = 0) const
overridevirtual

get a string of the predicate for output function

Implements Lima::Common::BagOfWords::AbstractBoWElement.

Definition at line 177 of file BoWPredicate.cpp.

◆ getPosition()

uint64_t Lima::Common::BagOfWords::BoWPredicate::getPosition ( void  ) const
overridevirtual

Implements Lima::Common::BagOfWords::AbstractBoWElement.

Definition at line 164 of file BoWPredicate.cpp.

◆ getPredicateType()

MediaticData::EntityType Lima::Common::BagOfWords::BoWPredicate::getPredicateType ( void  ) const

Definition at line 119 of file BoWPredicate.cpp.

◆ getString()

Lima::LimaString Lima::Common::BagOfWords::BoWPredicate::getString ( void  ) const
overridevirtual

Implements Lima::Common::BagOfWords::AbstractBoWElement.

Definition at line 172 of file BoWPredicate.cpp.

◆ getType()

virtual BoWType Lima::Common::BagOfWords::BoWPredicate::getType ( ) const
inlineoverridevirtual

Reimplemented from Lima::Common::BagOfWords::AbstractBoWElement.

Definition at line 57 of file BoWPredicate.h.

◆ getVertices()

std::set< uint64_t > Lima::Common::BagOfWords::BoWPredicate::getVertices ( ) const
overridevirtual

returns the vertices of the predicate and the roles

Returns
the vertices of the predicate and the roles

FIXME Vertex of predicate is missing from the class definition. Cannot add it.

Implements Lima::Common::BagOfWords::AbstractBoWElement.

Definition at line 149 of file BoWPredicate.cpp.

◆ operator=()

BoWPredicate & Lima::Common::BagOfWords::BoWPredicate::operator= ( const BoWPredicate &  t)

Definition at line 100 of file BoWPredicate.cpp.

◆ operator==()

bool Lima::Common::BagOfWords::BoWPredicate::operator== ( const BoWPredicate &  t)

Definition at line 111 of file BoWPredicate.cpp.

◆ roles() [1/2]

QMultiMap< Common::MediaticData::EntityType, boost::shared_ptr< AbstractBoWElement > > & Lima::Common::BagOfWords::BoWPredicate::roles ( )

Definition at line 134 of file BoWPredicate.cpp.

◆ roles() [2/2]

const QMultiMap< Common::MediaticData::EntityType, boost::shared_ptr< AbstractBoWElement > > & Lima::Common::BagOfWords::BoWPredicate::roles ( ) const

Definition at line 129 of file BoWPredicate.cpp.

◆ setLength()

void Lima::Common::BagOfWords::BoWPredicate::setLength ( const uint64_t  len)
overridevirtual

Implements Lima::Common::BagOfWords::AbstractBoWElement.

Definition at line 167 of file BoWPredicate.cpp.

◆ setPosition()

void Lima::Common::BagOfWords::BoWPredicate::setPosition ( const uint64_t  pos)
overridevirtual

Implements Lima::Common::BagOfWords::AbstractBoWElement.

Definition at line 166 of file BoWPredicate.cpp.

◆ setPredicateType()

void Lima::Common::BagOfWords::BoWPredicate::setPredicateType ( const MediaticData::EntityType &  predicateType)

Definition at line 124 of file BoWPredicate.cpp.

◆ setRoles()

void Lima::Common::BagOfWords::BoWPredicate::setRoles ( QMultiMap< Common::MediaticData::EntityType, boost::shared_ptr< Common::BagOfWords::AbstractBoWElement > > &  pRoles)

Definition at line 139 of file BoWPredicate.cpp.

◆ size()

virtual uint64_t Lima::Common::BagOfWords::BoWPredicate::size ( void  ) const
inlineoverridevirtual

size of the AbstractBoWElement is the number of parts in the token, 0 for a predicate

Implements Lima::Common::BagOfWords::AbstractBoWElement.

Definition at line 47 of file BoWPredicate.h.

Friends And Related Symbol Documentation

◆ BoWPredicatePrivate

friend class BoWPredicatePrivate
friend

Definition at line 34 of file BoWPredicate.h.


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