strusPython  0.14
Public Member Functions | Friends | List of all members
strus::DocumentAnalyzeQueue Class Reference

Analyzer object implementing a queue of analyze document tasks. More...

#include <bindingObjects.hpp>

Public Member Functions

 DocumentAnalyzeQueue (const DocumentAnalyzeQueue &o)
 Copy constructor. More...
 
 ~DocumentAnalyzeQueue ()
 Destructor. More...
 
void push (const String &content)
 Push a document into the queue to analyze. More...
 
void push (const String &content, const DocumentClass &dclass)
 Push a document into the queue to analyze. More...
 
bool hasMore () const
 Checks if there are more results to fetch. More...
 
Document fetch ()
 Processes the next field of the queue for fields to analyzer. Does the tokenization and normalization and creates some typed terms out of it according the definition of the field type given. More...
 

Friends

class DocumentAnalyzer
 Constructor used by Context. More...
 

Detailed Description

Analyzer object implementing a queue of analyze document tasks.

Remarks
Document analysis with this class reduces network roundtrips when using it as proxy

Constructor & Destructor Documentation

strus::DocumentAnalyzeQueue::DocumentAnalyzeQueue ( const DocumentAnalyzeQueue o)

Copy constructor.

strus::DocumentAnalyzeQueue::~DocumentAnalyzeQueue ( )
inline

Destructor.

Member Function Documentation

Document strus::DocumentAnalyzeQueue::fetch ( )

Processes the next field of the queue for fields to analyzer. Does the tokenization and normalization and creates some typed terms out of it according the definition of the field type given.

Returns
list of terms (query field analyzer result)
bool strus::DocumentAnalyzeQueue::hasMore ( ) const

Checks if there are more results to fetch.

Returns
true, if yes
void strus::DocumentAnalyzeQueue::push ( const String &  content)

Push a document into the queue to analyze.

Parameters
[in]contentcontent string of the document to analyze
void strus::DocumentAnalyzeQueue::push ( const String &  content,
const DocumentClass dclass 
)

Push a document into the queue to analyze.

Parameters
[in]contentcontent string of the document to analyze
[in]dclassdocument class of the document to analyze

Friends And Related Function Documentation

friend class DocumentAnalyzer
friend

Constructor used by Context.


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