dca_wac::WacClassification Class Reference

#include <wac_classification.h>

Detailed Description

Defintion of the WacClassification class.

This class is used to create a WacClassification instance by using the static create() function.

A WacClassification instance can be used to create a WacClassifier instance.

A WacCategoriesInfo class can be retrieved by using the static getCategoriesInfo() function, which is used to enumerate all container objects.

Definition at line 61 of file wac_classification.h.

Public Member Functions
WacCategoriesInfo	getCategoriesInfo () const
	Retrieve the WacCategoriesInfo class. More...
WacClassifier	createClassifier (const dca::DbConnection &aDbConnection, const WacClassifierOptions &aWacClassifierOptions=WacClassifierOptions()) const
	Creates a WacClassifier that is used to classify WacInputData objects. More...
dca::LogLevel	setLogLevel (dca::LogLevel newLevel)
	Changes the log level of the package and returns the previously used loglevel. Usually the logging level is set to LOG_Notice. More...
bool	wacDetailsAvailable (const dca::UrlClassificationResults &res) const
	Returns whether or not a subsequent WAC classification may provide useful WAC information. If this functions returns true, a WAC classification could return a positive WAC result. More...

Static Public Member Functions
static WacClassification	create (const dca::DcaInstance &aDca, const dca::License &aLicense)
	Initializes the WacClassification module. More...

Static Public Attributes
static DCA_MODULE_ID_TYPE	ID
	The unique ID of the WAC classification module.

Member Function Documentation

create()

static WacClassification dca_wac::WacClassification::create ( const dca::DcaInstance &  aDca, const dca::License &  aLicense  )

static

Initializes the WacClassification module.

Parameters

[in]	aDca	A previously initialized DcaInstance object
[in]	aLicense	An initialized License object

Returns

An initialized WacClassification instance.

getCategoriesInfo()

WacCategoriesInfo dca_wac::WacClassification::getCategoriesInfo

(

)

const

Retrieve the WacCategoriesInfo class.

Returns

An initialized WacCategoriesInfo instance.

createClassifier()

WacClassifier dca_wac::WacClassification::createClassifier	(	const dca::DbConnection &	aDbConnection,
		const WacClassifierOptions &	aWacClassifierOptions = WacClassifierOptions()
	)		const

Creates a WacClassifier that is used to classify WacInputData objects.

Parameters

[in]	aDbConnection	An initialized database connection object.
[in]	aWacClassifierOptions	Options to use, if not provided the default options will be used

Returns

An initialized WacClassifier instance.

Exceptions

ExDca

- One of the following error codes (available by using dca::ExDca::getReturnCode() in your catch-handler) DCA Generic Error Codes

setLogLevel()

dca::LogLevel dca_wac::WacClassification::setLogLevel

(

dca::LogLevel

newLevel

)

Changes the log level of the package and returns the previously used loglevel. Usually the logging level is set to LOG_Notice.

Parameters

[in]

newLevel

The new LogLevel the class instance should use for logging

Returns

The previously used log level.

wacDetailsAvailable()

bool dca_wac::WacClassification::wacDetailsAvailable

(

const dca::UrlClassificationResults &

res

)

const

Returns whether or not a subsequent WAC classification may provide useful WAC information. If this functions returns true, a WAC classification could return a positive WAC result.

Parameters

[in]

res

The result of a previous URL classification call.

Returns

Whether or not a subsequent WAC classification may provide useful WAC information.

---

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

• wac_classification.h