net::strus::api::DocumentClass Class Reference

Defines a description of the properties of a document content processed by the analyzer. More...

#include <bindingObjects.hpp>

Public Member Functions
	DocumentClass ()
	Default constructor. More...
	DocumentClass (const String &mimeType_)
	Constructor. More...
	DocumentClass (const String &mimeType_, const String &encoding_)
	Constructor. More...
	DocumentClass (const String &mimeType_, const String &encoding_, const String &scheme_)
	Constructor. More...
	DocumentClass (const DocumentClass &o)
	Copy constructor. More...
bool	valid () const
	Check if this document class is valid. More...
void	setMimeType (const String &mimeType_)
	Set the MIME type of the document class. More...
void	setScheme (const String &scheme_)
	Set the scheme identifier of the document class. More...
void	setEncoding (const String &encoding_)
	Set the character set encoding of the document class. More...
const String &	mimeType () const
	Get the MIME type of the document class. More...
const String &	scheme () const
	Get the scheme identifier of the document class. More...
const String &	encoding () const
	Get the character set encoding of the document class. More...

Detailed Description

Defines a description of the properties of a document content processed by the analyzer.

Constructor & Destructor Documentation

net::strus::api::DocumentClass::DocumentClass ( )

inline

Default constructor.

net::strus::api::DocumentClass::DocumentClass ( const String &  mimeType_ )

inlineexplicit

Constructor.

net::strus::api::DocumentClass::DocumentClass ( const String &  mimeType_, const String &  encoding_  )

inline

Constructor.

net::strus::api::DocumentClass::DocumentClass ( const String &  mimeType_, const String &  encoding_, const String &  scheme_  )

inline

Constructor.

net::strus::api::DocumentClass::DocumentClass ( const DocumentClass &  o )

inline

Copy constructor.

Member Function Documentation

const String& net::strus::api::DocumentClass::encoding ( ) const

inline

Get the character set encoding of the document class.

Returns

the character set encoding string

const String& net::strus::api::DocumentClass::mimeType ( ) const

inline

Get the MIME type of the document class.

Returns

the document MIME type string

const String& net::strus::api::DocumentClass::scheme ( ) const

inline

Get the scheme identifier of the document class.

Returns

the document scheme identifier

void net::strus::api::DocumentClass::setEncoding ( const String &  encoding_ )

inline

Set the character set encoding of the document class.

Parameters

[in]

encoding_

the character set encoding as string

void net::strus::api::DocumentClass::setMimeType ( const String &  mimeType_ )

inline

Set the MIME type of the document class.

Parameters

[in]

mimeType_

the document MIME type string

void net::strus::api::DocumentClass::setScheme ( const String &  scheme_ )

inline

Set the scheme identifier of the document class.

Parameters

[in]

scheme_

the document scheme identifier

bool net::strus::api::DocumentClass::valid ( ) const

inline

Check if this document class is valid.

Returns

true, if yes

---

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

• /home/patrick/Projects/github/strusBindings/include/strus/bindingObjects.hpp