strus::analyzer::DocumentTerm Class Reference

Structure describing a typed document term. More...

#include <documentTerm.hpp>

Public Types
typedef int	Position

Public Member Functions
	DocumentTerm ()
	Default constructor. More...
	DocumentTerm (const DocumentTerm &o)
	Copy constructor. More...
	DocumentTerm (const std::string &t, const std::string &v, const Position &p)
	Constructor. More...
const std::string &	type () const
	Get the type name of the term. More...
const std::string &	value () const
	Get the value of the term. More...
Position	pos () const
	Get the ordinal position of the term. More...
void	setPos (const Position &pos_)
	Set the ordinal position of the term. More...
bool	operator< (const DocumentTerm &o) const
bool	defined () const
void	clear ()

Detailed Description

Structure describing a typed document term.

Member Typedef Documentation

typedef int strus::analyzer::DocumentTerm::Position

Constructor & Destructor Documentation

strus::analyzer::DocumentTerm::DocumentTerm ( )

inline

Default constructor.

strus::analyzer::DocumentTerm::DocumentTerm ( const DocumentTerm &  o )

inline

Copy constructor.

strus::analyzer::DocumentTerm::DocumentTerm ( const std::string &  t, const std::string &  v, const Position &  p  )

inline

Constructor.

Parameters

[in]	t	name of the term
[in]	v	value of the term
[in]	p	position of the term
[in]	l	length of the term

Member Function Documentation

void strus::analyzer::DocumentTerm::clear ( )

inline

bool strus::analyzer::DocumentTerm::defined ( ) const

inline

bool strus::analyzer::DocumentTerm::operator< ( const DocumentTerm &  o ) const

inline

Position strus::analyzer::DocumentTerm::pos ( ) const

inline

Get the ordinal position of the term.

Returns

ordinal position (word count index) of the term

void strus::analyzer::DocumentTerm::setPos ( const Position &  pos_ )

inline

Set the ordinal position of the term.

Parameters

[in]

pos_

ordinal position (word count index) of the term

const std::string& strus::analyzer::DocumentTerm::type ( ) const

inline

Get the type name of the term.

Returns

type name of the term

const std::string& strus::analyzer::DocumentTerm::value ( ) const

inline

Get the value of the term.

Returns

value of the term

---

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

• /home/patrick/Projects/github/strusAnalyzer/include/strus/analyzer/documentTerm.hpp