com.exalead.linguistic.v10

Class FrequencyAnalyzer

java.lang.Object

com.exalead.linguistic.v10.SemanticProcessor

com.exalead.linguistic.v10.FrequencyAnalyzer

All Implemented Interfaces:

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

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

Frequency-related toolbox

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	annotationDensity
static boolean	DEFAULT_TF_IDF
static java.lang.String	DEFAULT_TF_IDF_ANNOTATION
java.lang.String	densityOutputAnnotation
double	densityThreshold
boolean	tfIdf
java.lang.String	tfIdfAnnotation

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

contexts, name, src

Constructor Summary

Constructors

Constructor and Description
FrequencyAnalyzer()
FrequencyAnalyzer(FrequencyAnalyzer 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 FrequencyAnalyzer.
static FrequencyAnalyzer	fromString(java.lang.String s) String representation of this FrequencyAnalyzer.
java.lang.String	getAnnotationDensity() Searches for text spans where the relative amount of tokens covered by this annotation is above a given threshold
java.lang.String	getDensityOutputAnnotation() The annotation used to mark spans where the density is above the threshold
double	getDensityThreshold() Annotates text spans where the number of annotated alphanumerical tokens divided by the number of alphanumerical tokens is above this threshold
java.lang.String	getTfIdfAnnotation() Specifies that tf.idf is to be computed for this type of annotation instead of token forms
boolean	isTfIdf() tf.idf computation for each token by default
FrequencyAnalyzer	makeCopy() Creates and returns a deep copy of this FrequencyAnalyzer.
static FrequencyAnalyzer	readFrom(java.io.InputStream is) Read this FrequencyAnalyzer from an XML fragment.
void	setAnnotationDensity(java.lang.String annotationDensity) Searches for text spans where the relative amount of tokens covered by this annotation is above a given threshold
void	setDensityOutputAnnotation(java.lang.String densityOutputAnnotation) The annotation used to mark spans where the density is above the threshold
void	setDensityThreshold(double densityThreshold) Annotates text spans where the number of annotated alphanumerical tokens divided by the number of alphanumerical tokens is above this threshold
void	setTfIdf(boolean tfIdf) tf.idf computation for each token by default
void	setTfIdfAnnotation(java.lang.String tfIdfAnnotation) Specifies that tf.idf is to be computed for this type of annotation instead of token forms
java.lang.String	toString() String representation of this FrequencyAnalyzer.
FrequencyAnalyzer	withAnnotationDensity(java.lang.String annotationDensity)
FrequencyAnalyzer	withContexts(java.lang.String contexts)
FrequencyAnalyzer	withDensityOutputAnnotation(java.lang.String densityOutputAnnotation)
FrequencyAnalyzer	withDensityThreshold(double densityThreshold)
FrequencyAnalyzer	withName(java.lang.String name)
FrequencyAnalyzer	withSrc(java.lang.String src) Deprecated.
FrequencyAnalyzer	withTfIdf(boolean tfIdf)
FrequencyAnalyzer	withTfIdf(java.lang.Boolean tfIdf)
FrequencyAnalyzer	withTfIdfAnnotation(java.lang.String tfIdfAnnotation)
void	writeTo(java.io.OutputStream os) Write this FrequencyAnalyzer 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

tfIdf

public boolean tfIdf

DEFAULT_TF_IDF

public static final boolean DEFAULT_TF_IDF

See Also:

Constant Field Values

tfIdfAnnotation

public java.lang.String tfIdfAnnotation

DEFAULT_TF_IDF_ANNOTATION

public static final java.lang.String DEFAULT_TF_IDF_ANNOTATION

See Also:

Constant Field Values

annotationDensity

public java.lang.String annotationDensity

densityThreshold

public double densityThreshold

densityOutputAnnotation

public java.lang.String densityOutputAnnotation

Constructor Detail

FrequencyAnalyzer

public FrequencyAnalyzer()

FrequencyAnalyzer

public FrequencyAnalyzer(FrequencyAnalyzer o)

Copy constructor

Method Detail

withName

public FrequencyAnalyzer withName(java.lang.String name)

Overrides:

withName in class SemanticProcessor

withContexts

public FrequencyAnalyzer withContexts(java.lang.String contexts)

Overrides:

withContexts in class SemanticProcessor

withSrc

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

Deprecated.

Overrides:

withSrc in class SemanticProcessor

setTfIdf

public void setTfIdf(boolean tfIdf)

tf.idf computation for each token by default

isTfIdf

public boolean isTfIdf()

tf.idf computation for each token by default

withTfIdf

public FrequencyAnalyzer withTfIdf(boolean tfIdf)

withTfIdf

public FrequencyAnalyzer withTfIdf(java.lang.Boolean tfIdf)

setTfIdfAnnotation

public void setTfIdfAnnotation(java.lang.String tfIdfAnnotation)

Specifies that tf.idf is to be computed for this type of annotation instead of token forms

getTfIdfAnnotation

public java.lang.String getTfIdfAnnotation()

Specifies that tf.idf is to be computed for this type of annotation instead of token forms

withTfIdfAnnotation

public FrequencyAnalyzer withTfIdfAnnotation(java.lang.String tfIdfAnnotation)

setAnnotationDensity

public void setAnnotationDensity(java.lang.String annotationDensity)

Searches for text spans where the relative amount of tokens covered by this annotation is above a given threshold

getAnnotationDensity

public java.lang.String getAnnotationDensity()

Searches for text spans where the relative amount of tokens covered by this annotation is above a given threshold

withAnnotationDensity

public FrequencyAnalyzer withAnnotationDensity(java.lang.String annotationDensity)

setDensityThreshold

public void setDensityThreshold(double densityThreshold)

Annotates text spans where the number of annotated alphanumerical tokens divided by the number of alphanumerical tokens is above this threshold

getDensityThreshold

public double getDensityThreshold()

Annotates text spans where the number of annotated alphanumerical tokens divided by the number of alphanumerical tokens is above this threshold

withDensityThreshold

public FrequencyAnalyzer withDensityThreshold(double densityThreshold)

setDensityOutputAnnotation

public void setDensityOutputAnnotation(java.lang.String densityOutputAnnotation)

The annotation used to mark spans where the density is above the threshold

getDensityOutputAnnotation

public java.lang.String getDensityOutputAnnotation()

The annotation used to mark spans where the density is above the threshold

withDensityOutputAnnotation

public FrequencyAnalyzer withDensityOutputAnnotation(java.lang.String densityOutputAnnotation)

makeCopy

public FrequencyAnalyzer makeCopy()

Creates and returns a deep copy of this FrequencyAnalyzer.

Overrides:

makeCopy in class SemanticProcessor

readFrom

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

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

Overrides:

writeTo in class SemanticProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this FrequencyAnalyzer.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this FrequencyAnalyzer.

Overrides:

toString in class SemanticProcessor

check

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

Checks this FrequencyAnalyzer.

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