strusAnalyzer  0.17
Public Types | Public Member Functions | List of all members
strus::analyzer::SegmenterOptions Class Reference

Options to stear the segmenter behaviour or the structure of input if not self defined in the documents processed. More...

#include <segmenterOptions.hpp>

Public Types

typedef std::pair< std::string,
std::string > 
Item
 One option item. Interpretation depends on the segmenter implementation. More...
 

Public Member Functions

 SegmenterOptions ()
 Default constructor. More...
 
 SegmenterOptions (const SegmenterOptions &o)
 Copy constructor. More...
 
SegmenterOptionsoperator() (const std::string &name, const std::string &value)
 Define a new option. More...
 
const std::vector< Item > & items () const
 Get the list of all declared option items. More...
 

Detailed Description

Options to stear the segmenter behaviour or the structure of input if not self defined in the documents processed.

Note
Available options defined as key value pairs depend on the segmenter implementation
Options should not be needed and many facets of content analysis and document type detection are not possible with parts of the document content type defined outside of the segmenter. They are used as hack to handle some TSV formats with a structure definition that is not part of the document.

Member Typedef Documentation

typedef std::pair<std::string,std::string> strus::analyzer::SegmenterOptions::Item

One option item. Interpretation depends on the segmenter implementation.

Constructor & Destructor Documentation

strus::analyzer::SegmenterOptions::SegmenterOptions ( )
inline

Default constructor.

strus::analyzer::SegmenterOptions::SegmenterOptions ( const SegmenterOptions o)
inline

Copy constructor.

Member Function Documentation

const std::vector<Item>& strus::analyzer::SegmenterOptions::items ( ) const
inline

Get the list of all declared option items.

Returns
the option item list
SegmenterOptions& strus::analyzer::SegmenterOptions::operator() ( const std::string &  name,
const std::string &  value 
)
inline

Define a new option.

Parameters
[in]namename of the option (case insensitive)
[in]valuevalue of the option
Returns
this for cascading option definitions

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