com.exalead.indexing.analysis.v10

Class Classifier

java.lang.Object

com.exalead.indexing.analysis.v10.SemanticProcessor

com.exalead.indexing.analysis.v10.Classifier

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

Direct Known Subclasses:

HierarchicalClassifier

public class Classifier
extends SemanticProcessor
implements com.exalead.util.Checkable, java.io.Serializable

A Classifier classifies a whole document according to the existing annotations on selected Document Chunks.
The annotations are matched against a learning resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Classifier.Transformer<T>
static interface	Classifier.Visitor

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.SemanticProcessor

SemanticProcessor.FromDataModel

Field Summary

Fields

Modifier and Type	Field and Description
boolean	addAnnotationsOnKeywords
java.lang.String	annotationName
boolean	collapseToken
static boolean	DEFAULT_ADD_ANNOTATIONS_ON_KEYWORDS
static boolean	DEFAULT_COLLAPSE_TOKEN
static java.lang.String	DEFAULT_EXCLUDED_LANGUAGES
static int	DEFAULT_EXTRA_ANNOTATIONS_MIN_TRUST_LEVEL
static java.lang.String	DEFAULT_EXTRA_PREFIX_ANNOTATIONS
static int	DEFAULT_MAX_ANNOTATIONS
static int	DEFAULT_MAX_KEYWORDS
static int	DEFAULT_MIN_KEYWORDS
static int	DEFAULT_MIN_TRUST_LEVEL
java.lang.String	excludedLanguages
int	extraAnnotationsMinTrustLevel
java.lang.String	extraPrefixAnnotations
java.lang.String	language
int	maxAnnotations
int	maxKeywords
int	minKeywords
int	minTrustLevel
java.lang.String	resourceDir

Fields inherited from class com.exalead.indexing.analysis.v10.SemanticProcessor

contexts, dataModelClass, dataModelProperty, dataModelState, DEFAULT_DISABLED, disabled, fromDataModel, name

Constructor Summary

Constructors

Constructor and Description
Classifier()
Classifier(Classifier o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(Classifier.Transformer<T> transformer, T[] t)
void	accept(Classifier.Visitor visitor)
<T> T	accept(SemanticProcessor.Transformer<T> transformer, T[] t)
void	accept(SemanticProcessor.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this Classifier.
static Classifier	fromString(java.lang.String s) String representation of this Classifier.
java.lang.String	getAnnotationName() Name of the annotation to add.
java.lang.String	getExcludedLanguages() Language for which the vocabulary classifier is deactivated (works only if language=xx, comma-separated).
int	getExtraAnnotationsMinTrustLevel() The minimum trust level to keep an extra annotation.
java.lang.String	getExtraPrefixAnnotations() The optional list of prefix annotations to keep (comma-separated).
java.lang.String	getLanguage() Language for which the vocabulary classifier is activated.
int	getMaxAnnotations() Maximum number of annotations per document.
int	getMaxKeywords() The maximum number of keywords to keep.
int	getMinKeywords() The minimum number of keywords per class.
int	getMinTrustLevel() The minimum trust level of categories to keep.
java.lang.String	getResourceDir() URL for the vocabulary resource (data://, file;// or resource://)
boolean	isAddAnnotationsOnKeywords() If true, it adds annotations to all matching tokens.
boolean	isCollapseToken() If true, all identical tokens are collapsed.
Classifier	makeCopy() Creates and returns a deep copy of this Classifier.
static Classifier	readFrom(java.io.InputStream is) Read this Classifier from an XML fragment.
void	setAddAnnotationsOnKeywords(boolean addAnnotationsOnKeywords) If true, it adds annotations to all matching tokens.
void	setAnnotationName(java.lang.String annotationName) Name of the annotation to add.
void	setCollapseToken(boolean collapseToken) If true, all identical tokens are collapsed.
void	setExcludedLanguages(java.lang.String excludedLanguages) Language for which the vocabulary classifier is deactivated (works only if language=xx, comma-separated).
void	setExtraAnnotationsMinTrustLevel(int extraAnnotationsMinTrustLevel) The minimum trust level to keep an extra annotation.
void	setExtraPrefixAnnotations(java.lang.String extraPrefixAnnotations) The optional list of prefix annotations to keep (comma-separated).
void	setLanguage(java.lang.String language) Language for which the vocabulary classifier is activated.
void	setMaxAnnotations(int maxAnnotations) Maximum number of annotations per document.
void	setMaxKeywords(int maxKeywords) The maximum number of keywords to keep.
void	setMinKeywords(int minKeywords) The minimum number of keywords per class.
void	setMinTrustLevel(int minTrustLevel) The minimum trust level of categories to keep.
void	setResourceDir(java.lang.String resourceDir) URL for the vocabulary resource (data://, file;// or resource://)
java.lang.String	toString() String representation of this Classifier.
Classifier	withAddAnnotationsOnKeywords(boolean addAnnotationsOnKeywords)
Classifier	withAddAnnotationsOnKeywords(java.lang.Boolean addAnnotationsOnKeywords)
Classifier	withAnnotationName(java.lang.String annotationName)
Classifier	withCollapseToken(boolean collapseToken)
Classifier	withCollapseToken(java.lang.Boolean collapseToken)
Classifier	withContexts(java.lang.String contexts)
Classifier	withDataModelClass(java.lang.String dataModelClass)
Classifier	withDataModelProperty(java.lang.String dataModelProperty)
Classifier	withDataModelState(java.lang.String dataModelState)
Classifier	withDisabled(boolean disabled)
Classifier	withDisabled(java.lang.Boolean disabled)
Classifier	withExcludedLanguages(java.lang.String excludedLanguages)
Classifier	withExtraAnnotationsMinTrustLevel(int extraAnnotationsMinTrustLevel)
Classifier	withExtraAnnotationsMinTrustLevel(java.lang.Integer extraAnnotationsMinTrustLevel)
Classifier	withExtraPrefixAnnotations(java.lang.String extraPrefixAnnotations)
Classifier	withFromDataModel(SemanticProcessor fromDataModel)
Classifier	withLanguage(java.lang.String language)
Classifier	withMaxAnnotations(int maxAnnotations)
Classifier	withMaxAnnotations(java.lang.Integer maxAnnotations)
Classifier	withMaxKeywords(int maxKeywords)
Classifier	withMaxKeywords(java.lang.Integer maxKeywords)
Classifier	withMinKeywords(int minKeywords)
Classifier	withMinKeywords(java.lang.Integer minKeywords)
Classifier	withMinTrustLevel(int minTrustLevel)
Classifier	withMinTrustLevel(java.lang.Integer minTrustLevel)
Classifier	withName(java.lang.String name)
Classifier	withResourceDir(java.lang.String resourceDir)
void	writeTo(java.io.OutputStream os) Write this Classifier as an XML fragment

Methods inherited from class com.exalead.indexing.analysis.v10.SemanticProcessor

getContexts, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getName, isDisabled, setContexts, setDataModelClass, setDataModelProperty, setDataModelState, setDisabled, setFromDataModel, setName

Methods inherited from class java.lang.Object

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

Field Detail

resourceDir

public java.lang.String resourceDir

annotationName

public java.lang.String annotationName

language

public java.lang.String language

excludedLanguages

public java.lang.String excludedLanguages

DEFAULT_EXCLUDED_LANGUAGES

public static final java.lang.String DEFAULT_EXCLUDED_LANGUAGES

See Also:

Constant Field Values

addAnnotationsOnKeywords

public boolean addAnnotationsOnKeywords

DEFAULT_ADD_ANNOTATIONS_ON_KEYWORDS

public static final boolean DEFAULT_ADD_ANNOTATIONS_ON_KEYWORDS

See Also:

Constant Field Values

maxAnnotations

public int maxAnnotations

DEFAULT_MAX_ANNOTATIONS

public static final int DEFAULT_MAX_ANNOTATIONS

See Also:

Constant Field Values

minTrustLevel

public int minTrustLevel

DEFAULT_MIN_TRUST_LEVEL

public static final int DEFAULT_MIN_TRUST_LEVEL

See Also:

Constant Field Values

maxKeywords

public int maxKeywords

DEFAULT_MAX_KEYWORDS

public static final int DEFAULT_MAX_KEYWORDS

See Also:

Constant Field Values

minKeywords

public int minKeywords

DEFAULT_MIN_KEYWORDS

public static final int DEFAULT_MIN_KEYWORDS

See Also:

Constant Field Values

collapseToken

public boolean collapseToken

DEFAULT_COLLAPSE_TOKEN

public static final boolean DEFAULT_COLLAPSE_TOKEN

See Also:

Constant Field Values

extraPrefixAnnotations

public java.lang.String extraPrefixAnnotations

DEFAULT_EXTRA_PREFIX_ANNOTATIONS

public static final java.lang.String DEFAULT_EXTRA_PREFIX_ANNOTATIONS

See Also:

Constant Field Values

extraAnnotationsMinTrustLevel

public int extraAnnotationsMinTrustLevel

DEFAULT_EXTRA_ANNOTATIONS_MIN_TRUST_LEVEL

public static final int DEFAULT_EXTRA_ANNOTATIONS_MIN_TRUST_LEVEL

See Also:

Constant Field Values

Constructor Detail

Classifier

public Classifier()

Classifier

public Classifier(Classifier o)

Copy constructor

Method Detail

withName

public Classifier withName(java.lang.String name)

Overrides:

withName in class SemanticProcessor

withContexts

public Classifier withContexts(java.lang.String contexts)

Overrides:

withContexts in class SemanticProcessor

withFromDataModel

public Classifier withFromDataModel(SemanticProcessor fromDataModel)

withDataModelState

public Classifier withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SemanticProcessor

withDataModelClass

public Classifier withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SemanticProcessor

withDataModelProperty

public Classifier withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SemanticProcessor

withDisabled

public Classifier withDisabled(boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

withDisabled

public Classifier withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

setResourceDir

public void setResourceDir(java.lang.String resourceDir)

URL for the vocabulary resource (data://, file;// or resource://)

getResourceDir

public java.lang.String getResourceDir()

URL for the vocabulary resource (data://, file;// or resource://)

withResourceDir

public Classifier withResourceDir(java.lang.String resourceDir)

setAnnotationName

public void setAnnotationName(java.lang.String annotationName)

Name of the annotation to add.

getAnnotationName

public java.lang.String getAnnotationName()

Name of the annotation to add.

withAnnotationName

public Classifier withAnnotationName(java.lang.String annotationName)

setLanguage

public void setLanguage(java.lang.String language)

Language for which the vocabulary classifier is activated.

getLanguage

public java.lang.String getLanguage()

Language for which the vocabulary classifier is activated.

withLanguage

public Classifier withLanguage(java.lang.String language)

setExcludedLanguages

public void setExcludedLanguages(java.lang.String excludedLanguages)

Language for which the vocabulary classifier is deactivated (works only if language=xx, comma-separated).

getExcludedLanguages

public java.lang.String getExcludedLanguages()

Language for which the vocabulary classifier is deactivated (works only if language=xx, comma-separated).

withExcludedLanguages

public Classifier withExcludedLanguages(java.lang.String excludedLanguages)

setAddAnnotationsOnKeywords

public void setAddAnnotationsOnKeywords(boolean addAnnotationsOnKeywords)

If true, it adds annotations to all matching tokens.

isAddAnnotationsOnKeywords

public boolean isAddAnnotationsOnKeywords()

If true, it adds annotations to all matching tokens.

withAddAnnotationsOnKeywords

public Classifier withAddAnnotationsOnKeywords(boolean addAnnotationsOnKeywords)

withAddAnnotationsOnKeywords

public Classifier withAddAnnotationsOnKeywords(java.lang.Boolean addAnnotationsOnKeywords)

setMaxAnnotations

public void setMaxAnnotations(int maxAnnotations)

Maximum number of annotations per document.

getMaxAnnotations

public int getMaxAnnotations()

Maximum number of annotations per document.

withMaxAnnotations

public Classifier withMaxAnnotations(int maxAnnotations)

withMaxAnnotations

public Classifier withMaxAnnotations(java.lang.Integer maxAnnotations)

setMinTrustLevel

public void setMinTrustLevel(int minTrustLevel)

The minimum trust level of categories to keep.

getMinTrustLevel

public int getMinTrustLevel()

The minimum trust level of categories to keep.

withMinTrustLevel

public Classifier withMinTrustLevel(int minTrustLevel)

withMinTrustLevel

public Classifier withMinTrustLevel(java.lang.Integer minTrustLevel)

setMaxKeywords

public void setMaxKeywords(int maxKeywords)

The maximum number of keywords to keep.

getMaxKeywords

public int getMaxKeywords()

The maximum number of keywords to keep.

withMaxKeywords

public Classifier withMaxKeywords(int maxKeywords)

withMaxKeywords

public Classifier withMaxKeywords(java.lang.Integer maxKeywords)

setMinKeywords

public void setMinKeywords(int minKeywords)

The minimum number of keywords per class.

getMinKeywords

public int getMinKeywords()

The minimum number of keywords per class.

withMinKeywords

public Classifier withMinKeywords(int minKeywords)

withMinKeywords

public Classifier withMinKeywords(java.lang.Integer minKeywords)

setCollapseToken

public void setCollapseToken(boolean collapseToken)

If true, all identical tokens are collapsed.

isCollapseToken

public boolean isCollapseToken()

If true, all identical tokens are collapsed.

withCollapseToken

public Classifier withCollapseToken(boolean collapseToken)

withCollapseToken

public Classifier withCollapseToken(java.lang.Boolean collapseToken)

setExtraPrefixAnnotations

public void setExtraPrefixAnnotations(java.lang.String extraPrefixAnnotations)

The optional list of prefix annotations to keep (comma-separated).

getExtraPrefixAnnotations

public java.lang.String getExtraPrefixAnnotations()

The optional list of prefix annotations to keep (comma-separated).

withExtraPrefixAnnotations

public Classifier withExtraPrefixAnnotations(java.lang.String extraPrefixAnnotations)

setExtraAnnotationsMinTrustLevel

public void setExtraAnnotationsMinTrustLevel(int extraAnnotationsMinTrustLevel)

The minimum trust level to keep an extra annotation.

getExtraAnnotationsMinTrustLevel

public int getExtraAnnotationsMinTrustLevel()

The minimum trust level to keep an extra annotation.

withExtraAnnotationsMinTrustLevel

public Classifier withExtraAnnotationsMinTrustLevel(int extraAnnotationsMinTrustLevel)

withExtraAnnotationsMinTrustLevel

public Classifier withExtraAnnotationsMinTrustLevel(java.lang.Integer extraAnnotationsMinTrustLevel)

makeCopy

public Classifier makeCopy()

Creates and returns a deep copy of this Classifier.

Overrides:

makeCopy in class SemanticProcessor

readFrom

public static Classifier readFrom(java.io.InputStream is)
                           throws javax.xml.bind.JAXBException

Read this Classifier from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this Classifier as an XML fragment

Overrides:

writeTo in class SemanticProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static Classifier fromString(java.lang.String s)
                             throws javax.xml.bind.JAXBException,
                                    java.io.UnsupportedEncodingException

String representation of this Classifier.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Classifier.

Overrides:

toString in class SemanticProcessor

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this Classifier.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class SemanticProcessor

Throws:

com.exalead.util.TypedException

accept

public void accept(Classifier.Visitor visitor)
            throws com.exalead.util.TypedException

Throws:

com.exalead.util.TypedException

accept

public void accept(SemanticProcessor.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class SemanticProcessor

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(Classifier.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(SemanticProcessor.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class SemanticProcessor

Throws:

com.exalead.util.TypedException