com.exalead.mot.components

Class VocabularyClassifier

java.lang.Object

com.exalead.gni.GNIObject

com.exalead.mot.core.Processor

com.exalead.mot.components.VocabularyClassifier

Direct Known Subclasses:

HierarchicalVocabularyClassifier

public class VocabularyClassifier
extends Processor

VocabularyClassifier. A processor to classify a document on its text. (uses supervised learning).

Field Summary

Fields

Modifier and Type	Field and Description
boolean	addAnnotationsOnKeywords If true, add tag to all matching token
java.lang.String	annotationName The tag set by the classifier
boolean	collapseToken If true all identical tokens are collapsed
int[]	excludedLanguages Language for which the vocabulary classifier is deactivated (works only if language=xx)
int	extraAnnotationsMinTrustLevel The minimum trust level to keep an extra annotations.
java.lang.String[]	extraPrefixAnnotations The optional list of prefix annotations to keep
int	maxAnnotations Max number of annotations per document
int	maxKeywords Max number of keywords to keep
int	minKeywords The minimum number of keywords per class
int	minTrustLevel Min trust level of categories to keep
java.lang.String	resource The processor resource

Fields inherited from class com.exalead.mot.core.Processor

fields, name

Constructor Summary

Constructors

Constructor and Description
VocabularyClassifier(java.lang.String name, java.lang.String resource, java.lang.String fields) Returns a new VocabularyClassifier processor.

Method Summary

Modifier and Type	Method and Description
protected void	finalize()
int	getNBToken() Get the total number of tokens.
int	getNBTokenInVocabulary() Get the number of tokens present in the vocabulary.
double	getScore(int classId) Get current score for a given class id.
double	getScore(java.lang.String className) Get current score for a given class name.
void	init(java.lang.String name, java.lang.String[] fields) Initialize the processor
protected void	init(java.lang.String name, java.lang.String resource, java.lang.String annotationName, java.lang.String[] fields, boolean collapseToken, boolean addAnnotationOnKeywords, int maxAnnotations, int minTrustLevel, int minKeywords, int maxKeywords, java.lang.String[] extraPrefixAnnotations, int extraAnnotationsMinTrustLevel, int[] excludedLanguages) Internals

Methods inherited from class com.exalead.mot.core.Processor

checkResource, destroy, getName, init

Methods inherited from class com.exalead.gni.GNIObject

printInternalCppPointer

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

resource

public java.lang.String resource

The processor resource

annotationName

public java.lang.String annotationName

The tag set by the classifier

collapseToken

public boolean collapseToken

If true all identical tokens are collapsed

addAnnotationsOnKeywords

public boolean addAnnotationsOnKeywords

If true, add tag to all matching token

maxAnnotations

public int maxAnnotations

Max number of annotations per document

minTrustLevel

public int minTrustLevel

Min trust level of categories to keep

maxKeywords

public int maxKeywords

Max number of keywords to keep

minKeywords

public int minKeywords

The minimum number of keywords per class

extraPrefixAnnotations

public java.lang.String[] extraPrefixAnnotations

The optional list of prefix annotations to keep

extraAnnotationsMinTrustLevel

public int extraAnnotationsMinTrustLevel

The minimum trust level to keep an extra annotations.

excludedLanguages

public int[] excludedLanguages

Language for which the vocabulary classifier is deactivated (works only if language=xx)

Constructor Detail

VocabularyClassifier

public VocabularyClassifier(java.lang.String name,
                            java.lang.String resource,
                            java.lang.String fields)

Returns a new VocabularyClassifier processor.

Parameters:

name - the processor's name.

resource - the processor's corresponding resource.

fields - the fields on which this processor is active.

Method Detail

init

public void init(java.lang.String name,
                 java.lang.String[] fields)

Initialize the processor

Specified by:

init in class Processor

Parameters:

name - Its name

fields - The list of fields on which it's active

getNBToken

public int getNBToken()

Get the total number of tokens.

Returns:

The number of tokens.

getNBTokenInVocabulary

public int getNBTokenInVocabulary()

Get the number of tokens present in the vocabulary.

Returns:

The number of tokens present in the vocabulary.

getScore

public double getScore(int classId)

Get current score for a given class id.

Parameters:

classId - The class identifier.

Returns:

The current score for this class.

getScore

public double getScore(java.lang.String className)

Get current score for a given class name.

Parameters:

className - The class name.

Returns:

The current score for this class.

init

protected void init(java.lang.String name,
                    java.lang.String resource,
                    java.lang.String annotationName,
                    java.lang.String[] fields,
                    boolean collapseToken,
                    boolean addAnnotationOnKeywords,
                    int maxAnnotations,
                    int minTrustLevel,
                    int minKeywords,
                    int maxKeywords,
                    java.lang.String[] extraPrefixAnnotations,
                    int extraAnnotationsMinTrustLevel,
                    int[] excludedLanguages)

Internals

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object