strusAnalyzer  0.17
Public Member Functions | List of all members
strus::TokenMarkupContextInterface Class Referenceabstract

Interface for annotation of text in one document. More...

#include <tokenMarkupContextInterface.hpp>

Public Member Functions

virtual ~TokenMarkupContextInterface ()
 Destructor. More...
 
virtual void putMarkup (const analyzer::Position &start, const analyzer::Position &end, const analyzer::TokenMarkup &markup, unsigned int level)=0
 Define a marker for a span in the text. More...
 
virtual std::string markupDocument (const analyzer::DocumentClass &dclass, const std::string &content) const =0
 Get the original document content with all markups declared inserted. More...
 

Detailed Description

Interface for annotation of text in one document.

Constructor & Destructor Documentation

virtual strus::TokenMarkupContextInterface::~TokenMarkupContextInterface ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual std::string strus::TokenMarkupContextInterface::markupDocument ( const analyzer::DocumentClass dclass,
const std::string &  content 
) const
pure virtual

Get the original document content with all markups declared inserted.

Parameters
[in]dclassdocument class of document to markup
[in]contentcontent string of document to markup
Returns
the marked up document content
virtual void strus::TokenMarkupContextInterface::putMarkup ( const analyzer::Position start,
const analyzer::Position end,
const analyzer::TokenMarkup markup,
unsigned int  level 
)
pure virtual

Define a marker for a span in the text.

Parameters
[in]startstart of the item to mark
[in]endthe end of the item to mark
[in]markuptag structure to use for markup
[in]levelsort of priority (areas with a higher level markup are superseding the ones with lover level. It is also used as criterion to resolve conflicts)

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