com.exalead.indexing.analysis.v10

Class HierarchicalClassifier

java.lang.Object

com.exalead.indexing.analysis.v10.SemanticProcessor

com.exalead.indexing.analysis.v10.Classifier

com.exalead.indexing.analysis.v10.HierarchicalClassifier

All Implemented Interfaces:

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

public class HierarchicalClassifier
extends Classifier
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/interfaces inherited from class com.exalead.indexing.analysis.v10.Classifier

Classifier.Transformer<T>, Classifier.Visitor

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

SemanticProcessor.FromDataModel

Field Summary

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

addAnnotationsOnKeywords, annotationName, collapseToken, DEFAULT_ADD_ANNOTATIONS_ON_KEYWORDS, DEFAULT_COLLAPSE_TOKEN, DEFAULT_EXCLUDED_LANGUAGES, DEFAULT_EXTRA_ANNOTATIONS_MIN_TRUST_LEVEL, DEFAULT_EXTRA_PREFIX_ANNOTATIONS, DEFAULT_MAX_ANNOTATIONS, DEFAULT_MAX_KEYWORDS, DEFAULT_MIN_KEYWORDS, DEFAULT_MIN_TRUST_LEVEL, excludedLanguages, extraAnnotationsMinTrustLevel, extraPrefixAnnotations, language, maxAnnotations, maxKeywords, minKeywords, minTrustLevel, 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
HierarchicalClassifier()
HierarchicalClassifier(HierarchicalClassifier 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 HierarchicalClassifier.
static HierarchicalClassifier	fromString(java.lang.String s) String representation of this HierarchicalClassifier.
HierarchicalClassifier	makeCopy() Creates and returns a deep copy of this HierarchicalClassifier.
static HierarchicalClassifier	readFrom(java.io.InputStream is) Read this HierarchicalClassifier from an XML fragment.
java.lang.String	toString() String representation of this HierarchicalClassifier.
HierarchicalClassifier	withAddAnnotationsOnKeywords(boolean addAnnotationsOnKeywords)
HierarchicalClassifier	withAddAnnotationsOnKeywords(java.lang.Boolean addAnnotationsOnKeywords)
HierarchicalClassifier	withAnnotationName(java.lang.String annotationName)
HierarchicalClassifier	withCollapseToken(boolean collapseToken)
HierarchicalClassifier	withCollapseToken(java.lang.Boolean collapseToken)
HierarchicalClassifier	withContexts(java.lang.String contexts)
HierarchicalClassifier	withDataModelClass(java.lang.String dataModelClass)
HierarchicalClassifier	withDataModelProperty(java.lang.String dataModelProperty)
HierarchicalClassifier	withDataModelState(java.lang.String dataModelState)
HierarchicalClassifier	withDisabled(boolean disabled)
HierarchicalClassifier	withDisabled(java.lang.Boolean disabled)
HierarchicalClassifier	withExcludedLanguages(java.lang.String excludedLanguages)
HierarchicalClassifier	withExtraAnnotationsMinTrustLevel(int extraAnnotationsMinTrustLevel)
HierarchicalClassifier	withExtraAnnotationsMinTrustLevel(java.lang.Integer extraAnnotationsMinTrustLevel)
HierarchicalClassifier	withExtraPrefixAnnotations(java.lang.String extraPrefixAnnotations)
HierarchicalClassifier	withFromDataModel(SemanticProcessor fromDataModel)
HierarchicalClassifier	withLanguage(java.lang.String language)
HierarchicalClassifier	withMaxAnnotations(int maxAnnotations)
HierarchicalClassifier	withMaxAnnotations(java.lang.Integer maxAnnotations)
HierarchicalClassifier	withMaxKeywords(int maxKeywords)
HierarchicalClassifier	withMaxKeywords(java.lang.Integer maxKeywords)
HierarchicalClassifier	withMinKeywords(int minKeywords)
HierarchicalClassifier	withMinKeywords(java.lang.Integer minKeywords)
HierarchicalClassifier	withMinTrustLevel(int minTrustLevel)
HierarchicalClassifier	withMinTrustLevel(java.lang.Integer minTrustLevel)
HierarchicalClassifier	withName(java.lang.String name)
HierarchicalClassifier	withResourceDir(java.lang.String resourceDir)
void	writeTo(java.io.OutputStream os) Write this HierarchicalClassifier as an XML fragment

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

getAnnotationName, getExcludedLanguages, getExtraAnnotationsMinTrustLevel, getExtraPrefixAnnotations, getLanguage, getMaxAnnotations, getMaxKeywords, getMinKeywords, getMinTrustLevel, getResourceDir, isAddAnnotationsOnKeywords, isCollapseToken, setAddAnnotationsOnKeywords, setAnnotationName, setCollapseToken, setExcludedLanguages, setExtraAnnotationsMinTrustLevel, setExtraPrefixAnnotations, setLanguage, setMaxAnnotations, setMaxKeywords, setMinKeywords, setMinTrustLevel, setResourceDir

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

Constructor Detail

HierarchicalClassifier

public HierarchicalClassifier()

HierarchicalClassifier

public HierarchicalClassifier(HierarchicalClassifier o)

Copy constructor

Method Detail

withResourceDir

public HierarchicalClassifier withResourceDir(java.lang.String resourceDir)

Overrides:

withResourceDir in class Classifier

withAnnotationName

public HierarchicalClassifier withAnnotationName(java.lang.String annotationName)

Overrides:

withAnnotationName in class Classifier

withLanguage

public HierarchicalClassifier withLanguage(java.lang.String language)

Overrides:

withLanguage in class Classifier

withExcludedLanguages

public HierarchicalClassifier withExcludedLanguages(java.lang.String excludedLanguages)

Overrides:

withExcludedLanguages in class Classifier

withAddAnnotationsOnKeywords

public HierarchicalClassifier withAddAnnotationsOnKeywords(boolean addAnnotationsOnKeywords)

Overrides:

withAddAnnotationsOnKeywords in class Classifier

withAddAnnotationsOnKeywords

public HierarchicalClassifier withAddAnnotationsOnKeywords(java.lang.Boolean addAnnotationsOnKeywords)

Overrides:

withAddAnnotationsOnKeywords in class Classifier

withMaxAnnotations

public HierarchicalClassifier withMaxAnnotations(int maxAnnotations)

Overrides:

withMaxAnnotations in class Classifier

withMaxAnnotations

public HierarchicalClassifier withMaxAnnotations(java.lang.Integer maxAnnotations)

Overrides:

withMaxAnnotations in class Classifier

withMinTrustLevel

public HierarchicalClassifier withMinTrustLevel(int minTrustLevel)

Overrides:

withMinTrustLevel in class Classifier

withMinTrustLevel

public HierarchicalClassifier withMinTrustLevel(java.lang.Integer minTrustLevel)

Overrides:

withMinTrustLevel in class Classifier

withMaxKeywords

public HierarchicalClassifier withMaxKeywords(int maxKeywords)

Overrides:

withMaxKeywords in class Classifier

withMaxKeywords

public HierarchicalClassifier withMaxKeywords(java.lang.Integer maxKeywords)

Overrides:

withMaxKeywords in class Classifier

withMinKeywords

public HierarchicalClassifier withMinKeywords(int minKeywords)

Overrides:

withMinKeywords in class Classifier

withMinKeywords

public HierarchicalClassifier withMinKeywords(java.lang.Integer minKeywords)

Overrides:

withMinKeywords in class Classifier

withCollapseToken

public HierarchicalClassifier withCollapseToken(boolean collapseToken)

Overrides:

withCollapseToken in class Classifier

withCollapseToken

public HierarchicalClassifier withCollapseToken(java.lang.Boolean collapseToken)

Overrides:

withCollapseToken in class Classifier

withExtraPrefixAnnotations

public HierarchicalClassifier withExtraPrefixAnnotations(java.lang.String extraPrefixAnnotations)

Overrides:

withExtraPrefixAnnotations in class Classifier

withExtraAnnotationsMinTrustLevel

public HierarchicalClassifier withExtraAnnotationsMinTrustLevel(int extraAnnotationsMinTrustLevel)

Overrides:

withExtraAnnotationsMinTrustLevel in class Classifier

withExtraAnnotationsMinTrustLevel

public HierarchicalClassifier withExtraAnnotationsMinTrustLevel(java.lang.Integer extraAnnotationsMinTrustLevel)

Overrides:

withExtraAnnotationsMinTrustLevel in class Classifier

withName

public HierarchicalClassifier withName(java.lang.String name)

Overrides:

withName in class Classifier

withContexts

public HierarchicalClassifier withContexts(java.lang.String contexts)

Overrides:

withContexts in class Classifier

withFromDataModel

public HierarchicalClassifier withFromDataModel(SemanticProcessor fromDataModel)

Overrides:

withFromDataModel in class Classifier

withDataModelState

public HierarchicalClassifier withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class Classifier

withDataModelClass

public HierarchicalClassifier withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class Classifier

withDataModelProperty

public HierarchicalClassifier withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class Classifier

withDisabled

public HierarchicalClassifier withDisabled(boolean disabled)

Overrides:

withDisabled in class Classifier

withDisabled

public HierarchicalClassifier withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class Classifier

makeCopy

public HierarchicalClassifier makeCopy()

Creates and returns a deep copy of this HierarchicalClassifier.

Overrides:

makeCopy in class Classifier

readFrom

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

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

Overrides:

writeTo in class Classifier

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this HierarchicalClassifier.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this HierarchicalClassifier.

Overrides:

toString in class Classifier

check

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

Checks this HierarchicalClassifier.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Classifier

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class Classifier

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class Classifier

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class Classifier

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class Classifier

Throws:

com.exalead.util.TypedException