dca::TextClassification Class Reference

#include <text_classification.h>

Detailed Description

The HTML Text Classification module class.

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

A TextClassification instance can be used to create an HtmlTextClassifier instance.

See also

HtmlTextClassifier, TextClassificationResults, TextClassificationResult, CategoriesInfo, HtmlText

// assume we have a valid DcaInstance (myDca) and License (myLicense)
 
// initialize the Text Classification module
dca::TextClassification myTextClassification = 
        dca::TextClassification::create( myDca, myLicense );
 
// create an HTML Text Classifier
dca::HtmlTextClassifier myHtmlTextClassifier = 
        myTextClassification.createHtmlClassifier();
 
// create an HTML text object
// assume we have the contents of a valid HTML page in std::string 
// myHtmlTextContents
dca::HtmlText myHtmlText = 
        dca::HtmlText::create( myDca, myHtmlTextContents );
 
// declare the classification results
dca::TextClassificationResults myTextClassificationResults;
 
// run the classification
dca::FunctionResult myResult = 
        myHtmlTextClassifier.classify( myHtmlText, myTextClassificationResults );
 
// if myResult returns false an error occured
if( !myResult ) {
        cout << "Received error from Text Classification (Error code: " <<
                myResult.getReturnCode() << ", Description: " <<
                myResult.getDescription() << ")." << endl;
        return;
}
 
if( !myTextClassificationResults.isCategorized() ) {
        cout << "No categories found for given HTML data." << endl;
        return;
}
 
// we received results and simply want to print them out
const DCA_SIZE_TYPE count = myTextClassificationResults.size();
 
// iterate through all matched categories
for( DCA_INDEX_TYPE i = 0; i < count; ++i ) {
        const dca::TextClassificationResult myTCResult = 
                myTextClassificationResults[ i ];
                
        cout << "Got result #" << (i+1) << " category id:" <<
                myTCResult.id() << ", Score:" <<
                myTCResult.score() << endl;
}

Definition at line 54 of file text_classification.h.

Public Member Functions
HtmlTextClassifier	createHtmlClassifier () const
	Creates a HtmlTextClassifier that is used to classify HtmlText objects. More...

Static Public Member Functions
static TextClassification	create (const DcaInstance &aDcaInstance, const License &aLicense)
	Initializes the TextClassification module. More...

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

Member Function Documentation

create()

static TextClassification dca::TextClassification::create ( const DcaInstance &  aDcaInstance, const License &  aLicense  )

static

Initializes the TextClassification module.

Parameters

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

Returns

An initialized TextClassification instance.

createHtmlClassifier()

HtmlTextClassifier dca::TextClassification::createHtmlClassifier

(

)

const

Creates a HtmlTextClassifier that is used to classify HtmlText objects.

Returns

An initialized HtmlTextClassifier instance.

Exceptions

ExDca

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

---

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

• text_classification.h