Defines a program for splitting a source text it into chunks with an id correspoding to a selecting expression. More...

Public Member Functions
virtual	~SegmenterInstanceInterface ()
	Destructor. More...

virtual void	defineSelectorExpression (int id, const std::string &expression)=0
	Defines an expression for selecting chunks from a document. More...

virtual void	defineSubSection (int startId, int endId, const std::string &expression)=0
	Defines an expression for identifying a sub section of the document. More...

virtual SegmenterContextInterface *	createContext (const analyzer::DocumentClass &dclass) const =0
	Creates a context for segmenting one document of a specified class. More...

virtual SegmenterMarkupContextInterface *	createMarkupContext (const analyzer::DocumentClass &dclass, const std::string &content) const =0
	Creates an instance of the segmenters document markup context. More...

virtual analyzer::FunctionView	view () const =0
	Get the definition of the function as structure for introspection. More...

Detailed Description

Defines a program for splitting a source text it into chunks with an id correspoding to a selecting expression.

Constructor & Destructor Documentation

virtual strus::SegmenterInstanceInterface::~SegmenterInstanceInterface ( )

inlinevirtual

Destructor.

virtual SegmenterContextInterface* strus::SegmenterInstanceInterface::createContext ( const analyzer::DocumentClass & dclass ) const

pure virtual

Creates a context for segmenting one document of a specified class.

Parameters

[in] dclass description of the document type and encoding to process

Returns: the segmenter context object (with ownership, to be desposed with delete by the caller)

virtual SegmenterMarkupContextInterface* strus::SegmenterInstanceInterface::createMarkupContext	(	const analyzer::DocumentClass &	dclass,
		const std::string &	content
	)		const

pure virtual

Creates an instance of the segmenters document markup context.

Parameters

[in]	dclass	description of the document type and encoding to process
[in]	content	document content to process (no chunkwise processing)

Returns: the segmenter markup object (with ownership, to be desposed with delete by the caller)

virtual void strus::SegmenterInstanceInterface::defineSelectorExpression	(	int	id,
		const std::string &	expression
	)

pure virtual

Defines an expression for selecting chunks from a document.

Parameters

[in]	id	identifier of the chunks that match to expression
[in]	expression	expression for selecting chunks

virtual void strus::SegmenterInstanceInterface::defineSubSection	(	int	startId,
		int	endId,
		const std::string &	expression
	)

pure virtual

Defines an expression for identifying a sub section of the document.

Parameters

[in]	startId	identifier to be returned when a sub section of this type starts
[in]	endId	identifier to be returned when a sub section of this type ends
[in]	expression	expression for selecting the sub section

virtual analyzer::FunctionView strus::SegmenterInstanceInterface::view ( ) const

pure virtual

Get the definition of the function as structure for introspection.

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

/home/patrick/Projects/github/strusAnalyzer/include/strus/segmenterInstanceInterface.hpp