Defines a description of the properties of an original document processed by the segmenter. More...

#include <documentClass.hpp>

Public Member Functions
	DocumentClass ()
	Default constructor. More...

	DocumentClass (const std::string &mimeType_)
	Constructor. More...

	DocumentClass (const std::string &mimeType_, const std::string &encoding_)
	Constructor. More...

	DocumentClass (const std::string &mimeType_, const std::string &encoding_, const std::string &scheme_)
	Constructor. More...

	DocumentClass (const DocumentClass &o)
	Copy constructor. More...

void	setMimeType (const std::string &mimeType_)
	Set the MIME type of the document class. More...

void	setScheme (const std::string &scheme_)
	Set the scheme identifier of the document class. More...

void	setEncoding (const std::string &encoding_)
	Set the character set encoding of the document class. More...

const std::string &	mimeType () const
	Get the MIME type of the document class. More...

const std::string &	scheme () const
	Get the scheme identifier of the document class. More...

const std::string &	encoding () const
	Get the character set encoding of the document class. More...

bool	defined () const
	Evaluate if this document class definition is defined. More...

int	level () const
	Evaluate the level of definition of the document class. More...

Detailed Description

Defines a description of the properties of an original document processed by the segmenter.

Constructor & Destructor Documentation

strus::analyzer::DocumentClass::DocumentClass ( )

inline

Default constructor.

strus::analyzer::DocumentClass::DocumentClass ( const std::string & mimeType_ )

inlineexplicit

Constructor.

strus::analyzer::DocumentClass::DocumentClass	(	const std::string &	mimeType_,
		const std::string &	encoding_
	)

inline

Constructor.

strus::analyzer::DocumentClass::DocumentClass	(	const std::string &	mimeType_,
		const std::string &	encoding_,
		const std::string &	scheme_
	)

inline

Constructor.

strus::analyzer::DocumentClass::DocumentClass ( const DocumentClass & o )

inline

Copy constructor.

Member Function Documentation

bool strus::analyzer::DocumentClass::defined ( ) const

inline

Evaluate if this document class definition is defined.

Returns: true if defined

const std::string& strus::analyzer::DocumentClass::encoding ( ) const

inline

Get the character set encoding of the document class.

Returns: the character set encoding string

int strus::analyzer::DocumentClass::level ( ) const

inline

Evaluate the level of definition of the document class.

Returns: level of definition

Note: this method is used to weight different oppinions of document class detection

const std::string& strus::analyzer::DocumentClass::mimeType ( ) const

inline

Get the MIME type of the document class.

Returns: the document MIME type string

const std::string& strus::analyzer::DocumentClass::scheme ( ) const

inline

Get the scheme identifier of the document class.

Returns: the document scheme identifier

void strus::analyzer::DocumentClass::setEncoding ( const std::string & encoding_ )

inline

Set the character set encoding of the document class.

Parameters

[in] the character set encoding string

void strus::analyzer::DocumentClass::setMimeType ( const std::string & mimeType_ )

inline

Set the MIME type of the document class.

Parameters

[in] the document MIME type string

void strus::analyzer::DocumentClass::setScheme ( const std::string & scheme_ )

inline

Set the scheme identifier of the document class.

Parameters

[in] the document scheme identifier

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

/home/patrick/Projects/github/strusAnalyzer/include/strus/analyzer/documentClass.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation