com.exalead.linguistic.v10

Class Categorizer

java.lang.Object

com.exalead.linguistic.v10.SemanticProcessor

com.exalead.linguistic.v10.Categorizer

All Implemented Interfaces:

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

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

A Categorizer classifies a whole document per the existing annotations on
selected Document Chunks.

See Also:

Serialized Form

Nested Class Summary

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

SemanticProcessor.Transformer<T>, SemanticProcessor.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	annotationName
static int	DEFAULT_MAX_ANNOTATIONS
static int	DEFAULT_MAX_CATEGORY_LEVEL
static int	DEFAULT_MIN_KEYWORDS
static int	DEFAULT_MIN_TRUST_LEVEL
java.lang.String	language
int	maxAnnotations
int	maxCategoryLevel
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
Categorizer()
Categorizer(Categorizer 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)
void	check(boolean deep, java.lang.String errorContext) Checks this Categorizer.
static Categorizer	fromString(java.lang.String s) String representation of this Categorizer.
java.lang.String	getAnnotationName() Name of annotation to add.
java.lang.String	getLanguage() Language for which this processor is activated.
int	getMaxAnnotations() Maximum number of annotations to allow for a document.
int	getMaxCategoryLevel() Maximum category level (only used in hierarchical Bayesian).
int	getMinKeywords() The minimum number of keywords the categorizer must have to launch prediction on the document.
int	getMinTrustLevel() The minimum trust level the predictions must have to be set on the document.
java.lang.String	getResourceDir() URL for the resource (data://, file:// or resource://)
Categorizer	makeCopy() Creates and returns a deep copy of this Categorizer.
static Categorizer	readFrom(java.io.InputStream is) Read this Categorizer from an XML fragment.
void	setAnnotationName(java.lang.String annotationName) Name of annotation to add.
void	setLanguage(java.lang.String language) Language for which this processor is activated.
void	setMaxAnnotations(int maxAnnotations) Maximum number of annotations to allow for a document.
void	setMaxCategoryLevel(int maxCategoryLevel) Maximum category level (only used in hierarchical Bayesian).
void	setMinKeywords(int minKeywords) The minimum number of keywords the categorizer must have to launch prediction on the document.
void	setMinTrustLevel(int minTrustLevel) The minimum trust level the predictions must have to be set on the document.
void	setResourceDir(java.lang.String resourceDir) URL for the resource (data://, file:// or resource://)
java.lang.String	toString() String representation of this Categorizer.
Categorizer	withAnnotationName(java.lang.String annotationName)
Categorizer	withContexts(java.lang.String contexts)
Categorizer	withLanguage(java.lang.String language)
Categorizer	withMaxAnnotations(int maxAnnotations)
Categorizer	withMaxAnnotations(java.lang.Integer maxAnnotations)
Categorizer	withMaxCategoryLevel(int maxCategoryLevel)
Categorizer	withMaxCategoryLevel(java.lang.Integer maxCategoryLevel)
Categorizer	withMinKeywords(int minKeywords)
Categorizer	withMinKeywords(java.lang.Integer minKeywords)
Categorizer	withMinTrustLevel(int minTrustLevel)
Categorizer	withMinTrustLevel(java.lang.Integer minTrustLevel)
Categorizer	withName(java.lang.String name)
Categorizer	withResourceDir(java.lang.String resourceDir)
Categorizer	withSrc(java.lang.String src) Deprecated.
void	writeTo(java.io.OutputStream os) Write this Categorizer 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

maxAnnotations

public int maxAnnotations

DEFAULT_MAX_ANNOTATIONS

public static final int DEFAULT_MAX_ANNOTATIONS

See Also:

Constant Field Values

maxCategoryLevel

public int maxCategoryLevel

DEFAULT_MAX_CATEGORY_LEVEL

public static final int DEFAULT_MAX_CATEGORY_LEVEL

See Also:

Constant Field Values

minKeywords

public int minKeywords

DEFAULT_MIN_KEYWORDS

public static final int DEFAULT_MIN_KEYWORDS

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

Constructor Detail

Categorizer

public Categorizer()

Categorizer

public Categorizer(Categorizer o)

Copy constructor

Method Detail

withName

public Categorizer withName(java.lang.String name)

Overrides:

withName in class SemanticProcessor

withContexts

public Categorizer withContexts(java.lang.String contexts)

Overrides:

withContexts in class SemanticProcessor

withSrc

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

Deprecated.

Overrides:

withSrc in class SemanticProcessor

setResourceDir

public void setResourceDir(java.lang.String resourceDir)

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

getResourceDir

public java.lang.String getResourceDir()

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

withResourceDir

public Categorizer 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 Categorizer withAnnotationName(java.lang.String annotationName)

setLanguage

public void setLanguage(java.lang.String language)

Language for which this processor is activated.

getLanguage

public java.lang.String getLanguage()

Language for which this processor is activated.

withLanguage

public Categorizer withLanguage(java.lang.String language)

setMaxAnnotations

public void setMaxAnnotations(int maxAnnotations)

Maximum number of annotations to allow for a document.

getMaxAnnotations

public int getMaxAnnotations()

Maximum number of annotations to allow for a document.

withMaxAnnotations

public Categorizer withMaxAnnotations(int maxAnnotations)

withMaxAnnotations

public Categorizer withMaxAnnotations(java.lang.Integer maxAnnotations)

setMaxCategoryLevel

public void setMaxCategoryLevel(int maxCategoryLevel)

Maximum category level (only used in hierarchical Bayesian).

getMaxCategoryLevel

public int getMaxCategoryLevel()

Maximum category level (only used in hierarchical Bayesian).

withMaxCategoryLevel

public Categorizer withMaxCategoryLevel(int maxCategoryLevel)

withMaxCategoryLevel

public Categorizer withMaxCategoryLevel(java.lang.Integer maxCategoryLevel)

setMinKeywords

public void setMinKeywords(int minKeywords)

The minimum number of keywords the categorizer must have to launch prediction on the document.

getMinKeywords

public int getMinKeywords()

The minimum number of keywords the categorizer must have to launch prediction on the document.

withMinKeywords

public Categorizer withMinKeywords(int minKeywords)

withMinKeywords

public Categorizer withMinKeywords(java.lang.Integer minKeywords)

setMinTrustLevel

public void setMinTrustLevel(int minTrustLevel)

The minimum trust level the predictions must have to be set on the document.

getMinTrustLevel

public int getMinTrustLevel()

The minimum trust level the predictions must have to be set on the document.

withMinTrustLevel

public Categorizer withMinTrustLevel(int minTrustLevel)

withMinTrustLevel

public Categorizer withMinTrustLevel(java.lang.Integer minTrustLevel)

makeCopy

public Categorizer makeCopy()

Creates and returns a deep copy of this Categorizer.

Overrides:

makeCopy in class SemanticProcessor

readFrom

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

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

Overrides:

writeTo in class SemanticProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this Categorizer.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Categorizer.

Overrides:

toString in class SemanticProcessor

check

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

Checks this Categorizer.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class SemanticProcessor

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(SemanticProcessor.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class SemanticProcessor

Throws:

com.exalead.util.TypedException