com.exalead.indexing.analysis.v10

Class NGramsExtractor

java.lang.Object

com.exalead.indexing.analysis.v10.SemanticProcessor

com.exalead.indexing.analysis.v10.NGramsExtractor

All Implemented Interfaces:

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

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

Extracts normalized word-grams. N-grams are useful for spell checking and statistical processings. Annotations generated:

• "ngram"

See Also:

Serialized Form

Nested Class Summary

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

SemanticProcessor.FromDataModel, SemanticProcessor.Transformer<T>, SemanticProcessor.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX
static int	DEFAULT_MIN
int	max
int	min

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
NGramsExtractor()
NGramsExtractor(NGramsExtractor 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 NGramsExtractor.
static NGramsExtractor	fromString(java.lang.String s) String representation of this NGramsExtractor.
int	getMax() Maximum ngram size
int	getMin() Minimum ngram size
NGramsExtractor	makeCopy() Creates and returns a deep copy of this NGramsExtractor.
static NGramsExtractor	readFrom(java.io.InputStream is) Read this NGramsExtractor from an XML fragment.
void	setMax(int max) Maximum ngram size
void	setMin(int min) Minimum ngram size
java.lang.String	toString() String representation of this NGramsExtractor.
NGramsExtractor	withContexts(java.lang.String contexts)
NGramsExtractor	withDataModelClass(java.lang.String dataModelClass)
NGramsExtractor	withDataModelProperty(java.lang.String dataModelProperty)
NGramsExtractor	withDataModelState(java.lang.String dataModelState)
NGramsExtractor	withDisabled(boolean disabled)
NGramsExtractor	withDisabled(java.lang.Boolean disabled)
NGramsExtractor	withFromDataModel(SemanticProcessor fromDataModel)
NGramsExtractor	withMax(int max)
NGramsExtractor	withMax(java.lang.Integer max)
NGramsExtractor	withMin(int min)
NGramsExtractor	withMin(java.lang.Integer min)
NGramsExtractor	withName(java.lang.String name)
void	writeTo(java.io.OutputStream os) Write this NGramsExtractor 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

min

public int min

DEFAULT_MIN

public static final int DEFAULT_MIN

See Also:

Constant Field Values

max

public int max

DEFAULT_MAX

public static final int DEFAULT_MAX

See Also:

Constant Field Values

Constructor Detail

NGramsExtractor

public NGramsExtractor()

NGramsExtractor

public NGramsExtractor(NGramsExtractor o)

Copy constructor

Method Detail

withName

public NGramsExtractor withName(java.lang.String name)

Overrides:

withName in class SemanticProcessor

withContexts

public NGramsExtractor withContexts(java.lang.String contexts)

Overrides:

withContexts in class SemanticProcessor

withFromDataModel

public NGramsExtractor withFromDataModel(SemanticProcessor fromDataModel)

withDataModelState

public NGramsExtractor withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SemanticProcessor

withDataModelClass

public NGramsExtractor withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SemanticProcessor

withDataModelProperty

public NGramsExtractor withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SemanticProcessor

withDisabled

public NGramsExtractor withDisabled(boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

withDisabled

public NGramsExtractor withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

setMin

public void setMin(int min)

Minimum ngram size

getMin

public int getMin()

Minimum ngram size

withMin

public NGramsExtractor withMin(int min)

withMin

public NGramsExtractor withMin(java.lang.Integer min)

setMax

public void setMax(int max)

Maximum ngram size

getMax

public int getMax()

Maximum ngram size

withMax

public NGramsExtractor withMax(int max)

withMax

public NGramsExtractor withMax(java.lang.Integer max)

makeCopy

public NGramsExtractor makeCopy()

Creates and returns a deep copy of this NGramsExtractor.

Overrides:

makeCopy in class SemanticProcessor

readFrom

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

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

Overrides:

writeTo in class SemanticProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this NGramsExtractor.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this NGramsExtractor.

Overrides:

toString in class SemanticProcessor

check

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

Checks this NGramsExtractor.

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