strus::SegmenterInterface Class Reference

Defines an interface for creating instances of programs for document segmentation. More...

#include <segmenterInterface.hpp>

Public Member Functions
virtual	~SegmenterInterface ()
	Destructor. More...
virtual const char *	mimeType () const =0
	Get the mime type accepted by this segmenter. More...
virtual SegmenterInstanceInterface *	createInstance (const analyzer::SegmenterOptions &opts=analyzer::SegmenterOptions()) const =0
	Create a parameterizable segmenter instance. More...
virtual ContentIteratorInterface *	createContentIterator (const char *content, std::size_t contentsize, const std::vector< std::string > &attributes, const std::vector< std::string > &expressions, const analyzer::DocumentClass &dclass, const analyzer::SegmenterOptions &opts=analyzer::SegmenterOptions()) const =0
	Create an iterator on content for statistics. More...
virtual const char *	getDescription () const =0
	Get a description of the function for user help. More...

Detailed Description

Defines an interface for creating instances of programs for document segmentation.

Constructor & Destructor Documentation

virtual strus::SegmenterInterface::~SegmenterInterface ( )

inlinevirtual

Destructor.

Member Function Documentation

virtual ContentIteratorInterface* strus::SegmenterInterface::createContentIterator ( const char *  content, std::size_t  contentsize, const std::vector< std::string > &  attributes, const std::vector< std::string > &  expressions, const analyzer::DocumentClass &  dclass, const analyzer::SegmenterOptions &  opts = analyzer::SegmenterOptions()  ) const

pure virtual

Create an iterator on content for statistics.

Parameters

[in]	content	pointer to content
[in]	contentsize	size of content in bytes
[in]	attributes	attributes that should be included in the path expressions of the result
[in]	expressions	predefined selector expressions that are used for the outputs on a match
[in]	dclass	document class (encoding)
[in]	opts	segmenter options

Returns

content iterator interface (with ownership)

virtual SegmenterInstanceInterface* strus::SegmenterInterface::createInstance ( const analyzer::SegmenterOptions &  opts = analyzer::SegmenterOptions() ) const

pure virtual

Create a parameterizable segmenter instance.

virtual const char* strus::SegmenterInterface::getDescription ( ) const

pure virtual

Get a description of the function for user help.

Returns

the description string

virtual const char* strus::SegmenterInterface::mimeType ( ) const

pure virtual

Get the mime type accepted by this segmenter.

Returns

the mime type string

---

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

• /home/patrick/Projects/github/strusAnalyzer/include/strus/segmenterInterface.hpp