com.exalead.linguistic.v10

Class VocabularyClassifier

java.lang.Object

com.exalead.linguistic.v10.SemanticProcessor

com.exalead.linguistic.v10.VocabularyClassifier

All Implemented Interfaces:

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

Direct Known Subclasses:

HierarchicalVocabularyClassifier

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

VocabularyClassifier classified a whole document per the existing annotations
on selected Document chunks, it uses a Bayesian classifier.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

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 boolean	DEFAULT_FORCE_MMAP
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
boolean	forceMmap
java.lang.String	language
int	maxAnnotations
int	maxKeywords
int	minKeywords
int	minTrustLevel
java.lang.String	resourceDir

Fields inherited from class com.exalead.linguistic.v10.SemanticProcessor

contexts, name, src

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(SemanticProcessor.Transformer<T> transformer, T[] t)
void	accept(SemanticProcessor.Visitor visitor)
<T> T	accept(VocabularyClassifier.Transformer<T> transformer, T[] t)
void	accept(VocabularyClassifier.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this VocabularyClassifier.
static VocabularyClassifier	fromString(java.lang.String s) String representation of this VocabularyClassifier.
java.lang.String	getAnnotationName() Name of annotation to add.
java.lang.String	getExcludedLanguages() Language for which the vocabulary classifier is deactivated (works only if language=xx, coma separated).
int	getExtraAnnotationsMinTrustLevel() The minimum trust level to keep an extra annotations
java.lang.String	getExtraPrefixAnnotations() The optional list of prefix annotations to keep (coma separated)
java.lang.String	getLanguage() Language for which the vocabulary classifier is activated.
int	getMaxAnnotations() Maximum number annotations per document.
int	getMaxKeywords() 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, add annotation to all matching tokens.
boolean	isCollapseToken() If true all identical tokens are collapsed.
boolean	isForceMmap() Force mmap of the resources (mem is shared but speed is affected)
VocabularyClassifier	makeCopy() Creates and returns a deep copy of this VocabularyClassifier.
static VocabularyClassifier	readFrom(java.io.InputStream is) Read this VocabularyClassifier from an XML fragment.
void	setAddAnnotationsOnKeywords(boolean addAnnotationsOnKeywords) If true, add annotation to all matching tokens.
void	setAnnotationName(java.lang.String annotationName) Name of 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, coma separated).
void	setExtraAnnotationsMinTrustLevel(int extraAnnotationsMinTrustLevel) The minimum trust level to keep an extra annotations
void	setExtraPrefixAnnotations(java.lang.String extraPrefixAnnotations) The optional list of prefix annotations to keep (coma separated)
void	setForceMmap(boolean forceMmap) Force mmap of the resources (mem is shared but speed is affected)
void	setLanguage(java.lang.String language) Language for which the vocabulary classifier is activated.
void	setMaxAnnotations(int maxAnnotations) Maximum number annotations per document.
void	setMaxKeywords(int maxKeywords) 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 VocabularyClassifier.
VocabularyClassifier	withAddAnnotationsOnKeywords(boolean addAnnotationsOnKeywords)
VocabularyClassifier	withAddAnnotationsOnKeywords(java.lang.Boolean addAnnotationsOnKeywords)
VocabularyClassifier	withAnnotationName(java.lang.String annotationName)
VocabularyClassifier	withCollapseToken(boolean collapseToken)
VocabularyClassifier	withCollapseToken(java.lang.Boolean collapseToken)
VocabularyClassifier	withContexts(java.lang.String contexts)
VocabularyClassifier	withExcludedLanguages(java.lang.String excludedLanguages)
VocabularyClassifier	withExtraAnnotationsMinTrustLevel(int extraAnnotationsMinTrustLevel)
VocabularyClassifier	withExtraAnnotationsMinTrustLevel(java.lang.Integer extraAnnotationsMinTrustLevel)
VocabularyClassifier	withExtraPrefixAnnotations(java.lang.String extraPrefixAnnotations)
VocabularyClassifier	withForceMmap(boolean forceMmap)
VocabularyClassifier	withForceMmap(java.lang.Boolean forceMmap)
VocabularyClassifier	withLanguage(java.lang.String language)
VocabularyClassifier	withMaxAnnotations(int maxAnnotations)
VocabularyClassifier	withMaxAnnotations(java.lang.Integer maxAnnotations)
VocabularyClassifier	withMaxKeywords(int maxKeywords)
VocabularyClassifier	withMaxKeywords(java.lang.Integer maxKeywords)
VocabularyClassifier	withMinKeywords(int minKeywords)
VocabularyClassifier	withMinKeywords(java.lang.Integer minKeywords)
VocabularyClassifier	withMinTrustLevel(int minTrustLevel)
VocabularyClassifier	withMinTrustLevel(java.lang.Integer minTrustLevel)
VocabularyClassifier	withName(java.lang.String name)
VocabularyClassifier	withResourceDir(java.lang.String resourceDir)
VocabularyClassifier	withSrc(java.lang.String src) Deprecated.
void	writeTo(java.io.OutputStream os) Write this VocabularyClassifier as an XML fragment

Methods inherited from class com.exalead.linguistic.v10.SemanticProcessor

getContexts, getName, getSrc, setContexts, setName, setSrc

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

forceMmap

public boolean forceMmap

DEFAULT_FORCE_MMAP

public static final boolean DEFAULT_FORCE_MMAP

See Also:

Constant Field Values

Constructor Detail

VocabularyClassifier

public VocabularyClassifier()

VocabularyClassifier

public VocabularyClassifier(VocabularyClassifier o)

Copy constructor

Method Detail

withName

public VocabularyClassifier withName(java.lang.String name)

Overrides:

withName in class SemanticProcessor

withContexts

public VocabularyClassifier withContexts(java.lang.String contexts)

Overrides:

withContexts in class SemanticProcessor

withSrc

@Deprecated
public VocabularyClassifier withSrc(java.lang.String src)

Deprecated.

Overrides:

withSrc 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 VocabularyClassifier withResourceDir(java.lang.String resourceDir)

setAnnotationName

public void setAnnotationName(java.lang.String annotationName)

Name of annotation to add.

getAnnotationName

public java.lang.String getAnnotationName()

Name of annotation to add.

withAnnotationName

public VocabularyClassifier 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 VocabularyClassifier 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, coma separated).

getExcludedLanguages

public java.lang.String getExcludedLanguages()

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

withExcludedLanguages

public VocabularyClassifier withExcludedLanguages(java.lang.String excludedLanguages)

setAddAnnotationsOnKeywords

public void setAddAnnotationsOnKeywords(boolean addAnnotationsOnKeywords)

If true, add annotation to all matching tokens.

isAddAnnotationsOnKeywords

public boolean isAddAnnotationsOnKeywords()

If true, add annotation to all matching tokens.

withAddAnnotationsOnKeywords

public VocabularyClassifier withAddAnnotationsOnKeywords(boolean addAnnotationsOnKeywords)

withAddAnnotationsOnKeywords

public VocabularyClassifier withAddAnnotationsOnKeywords(java.lang.Boolean addAnnotationsOnKeywords)

setMaxAnnotations

public void setMaxAnnotations(int maxAnnotations)

Maximum number annotations per document.

getMaxAnnotations

public int getMaxAnnotations()

Maximum number annotations per document.

withMaxAnnotations

public VocabularyClassifier withMaxAnnotations(int maxAnnotations)

withMaxAnnotations

public VocabularyClassifier 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 VocabularyClassifier withMinTrustLevel(int minTrustLevel)

withMinTrustLevel

public VocabularyClassifier withMinTrustLevel(java.lang.Integer minTrustLevel)

setMaxKeywords

public void setMaxKeywords(int maxKeywords)

Maximum number of keywords to keep.

getMaxKeywords

public int getMaxKeywords()

Maximum number of keywords to keep.

withMaxKeywords

public VocabularyClassifier withMaxKeywords(int maxKeywords)

withMaxKeywords

public VocabularyClassifier 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 VocabularyClassifier withMinKeywords(int minKeywords)

withMinKeywords

public VocabularyClassifier 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 VocabularyClassifier withCollapseToken(boolean collapseToken)

withCollapseToken

public VocabularyClassifier withCollapseToken(java.lang.Boolean collapseToken)

setExtraPrefixAnnotations

public void setExtraPrefixAnnotations(java.lang.String extraPrefixAnnotations)

The optional list of prefix annotations to keep (coma separated)

getExtraPrefixAnnotations

public java.lang.String getExtraPrefixAnnotations()

The optional list of prefix annotations to keep (coma separated)

withExtraPrefixAnnotations

public VocabularyClassifier withExtraPrefixAnnotations(java.lang.String extraPrefixAnnotations)

setExtraAnnotationsMinTrustLevel

public void setExtraAnnotationsMinTrustLevel(int extraAnnotationsMinTrustLevel)

The minimum trust level to keep an extra annotations

getExtraAnnotationsMinTrustLevel

public int getExtraAnnotationsMinTrustLevel()

The minimum trust level to keep an extra annotations

withExtraAnnotationsMinTrustLevel

public VocabularyClassifier withExtraAnnotationsMinTrustLevel(int extraAnnotationsMinTrustLevel)

withExtraAnnotationsMinTrustLevel

public VocabularyClassifier withExtraAnnotationsMinTrustLevel(java.lang.Integer extraAnnotationsMinTrustLevel)

setForceMmap

public void setForceMmap(boolean forceMmap)

Force mmap of the resources (mem is shared but speed is affected)

isForceMmap

public boolean isForceMmap()

Force mmap of the resources (mem is shared but speed is affected)

withForceMmap

public VocabularyClassifier withForceMmap(boolean forceMmap)

withForceMmap

public VocabularyClassifier withForceMmap(java.lang.Boolean forceMmap)

makeCopy

public VocabularyClassifier makeCopy()

Creates and returns a deep copy of this VocabularyClassifier.

Overrides:

makeCopy in class SemanticProcessor

readFrom

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

Read this VocabularyClassifier 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 VocabularyClassifier as an XML fragment

Overrides:

writeTo in class SemanticProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this VocabularyClassifier.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this VocabularyClassifier.

Overrides:

toString in class SemanticProcessor

check

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

Checks this VocabularyClassifier.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class SemanticProcessor

Throws:

com.exalead.util.TypedException

accept

public void accept(VocabularyClassifier.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(VocabularyClassifier.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