com.exalead.linguistic.v10

Class NGram

java.lang.Object

com.exalead.linguistic.v10.SemanticProcessor

com.exalead.linguistic.v10.NGram

All Implemented Interfaces:

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

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

The NGram processor annotates each sequence of minLength-maxLength words with a 'ngram' annotation.

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
boolean	addCanonicalForm Deprecated.
static boolean	DEFAULT_ADD_CANONICAL_FORM
static boolean	DEFAULT_DIFFERENTIATE_N_GRAMS
static java.lang.String	DEFAULT_FROM_TAGS
static java.lang.String	DEFAULT_IF_TAGS
static boolean	DEFAULT_KEEP_LONGEST_MATCH
static boolean	DEFAULT_MULTIVALUED
static java.lang.String	DEFAULT_SKIP_TAGS
static java.lang.String	DEFAULT_UNLESS_TAGS
boolean	differentiateNGrams
java.lang.String	fromTags
java.lang.String	ifTags
boolean	keepLongestMatch
int	maxLength
int	minLength
boolean	multivalued Deprecated.
java.lang.String	skipTags
java.lang.String	unlessTags

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

contexts, name, src

Constructor Summary

Constructors

Constructor and Description
NGram()
NGram(NGram 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 NGram.
static NGram	fromString(java.lang.String s) String representation of this NGram.
java.lang.String	getFromTags() The optional list of annotations (comma separated) sorted by priority that will be used to build the ngram.
java.lang.String	getIfTags() The optional list of annotation tags (comma separated) required to consider the current token.
int	getMaxLength() The maximum number of words.
int	getMinLength() The minimum number of words.
java.lang.String	getSkipTags() The optional list of annotation tags (comma separated) to skip/ignore.
java.lang.String	getUnlessTags() The optional list of annotation tags (comma separated) not-required to consider the current token.
boolean	isAddCanonicalForm() Deprecated.
boolean	isDifferentiateNGrams() Should the annotation be '2gram' instead of the constant 'ngram' in case of a bigram
boolean	isKeepLongestMatch() Only the longest match should be kept.
boolean	isMultivalued() Deprecated.
NGram	makeCopy() Creates and returns a deep copy of this NGram.
static NGram	readFrom(java.io.InputStream is) Read this NGram from an XML fragment.
void	setAddCanonicalForm(boolean addCanonicalForm) Deprecated.
void	setDifferentiateNGrams(boolean differentiateNGrams) Should the annotation be '2gram' instead of the constant 'ngram' in case of a bigram
void	setFromTags(java.lang.String fromTags) The optional list of annotations (comma separated) sorted by priority that will be used to build the ngram.
void	setIfTags(java.lang.String ifTags) The optional list of annotation tags (comma separated) required to consider the current token.
void	setKeepLongestMatch(boolean keepLongestMatch) Only the longest match should be kept.
void	setMaxLength(int maxLength) The maximum number of words.
void	setMinLength(int minLength) The minimum number of words.
void	setMultivalued(boolean multivalued) Deprecated.
void	setSkipTags(java.lang.String skipTags) The optional list of annotation tags (comma separated) to skip/ignore.
void	setUnlessTags(java.lang.String unlessTags) The optional list of annotation tags (comma separated) not-required to consider the current token.
java.lang.String	toString() String representation of this NGram.
NGram	withAddCanonicalForm(boolean addCanonicalForm) Deprecated.
NGram	withAddCanonicalForm(java.lang.Boolean addCanonicalForm) Deprecated.
NGram	withContexts(java.lang.String contexts)
NGram	withDifferentiateNGrams(boolean differentiateNGrams)
NGram	withDifferentiateNGrams(java.lang.Boolean differentiateNGrams)
NGram	withFromTags(java.lang.String fromTags)
NGram	withIfTags(java.lang.String ifTags)
NGram	withKeepLongestMatch(boolean keepLongestMatch)
NGram	withKeepLongestMatch(java.lang.Boolean keepLongestMatch)
NGram	withMaxLength(int maxLength)
NGram	withMaxLength(java.lang.Integer maxLength)
NGram	withMinLength(int minLength)
NGram	withMinLength(java.lang.Integer minLength)
NGram	withMultivalued(boolean multivalued) Deprecated.
NGram	withMultivalued(java.lang.Boolean multivalued) Deprecated.
NGram	withName(java.lang.String name)
NGram	withSkipTags(java.lang.String skipTags)
NGram	withSrc(java.lang.String src) Deprecated.
NGram	withUnlessTags(java.lang.String unlessTags)
void	writeTo(java.io.OutputStream os) Write this NGram 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

fromTags

public java.lang.String fromTags

DEFAULT_FROM_TAGS

public static final java.lang.String DEFAULT_FROM_TAGS

See Also:

Constant Field Values

ifTags

public java.lang.String ifTags

DEFAULT_IF_TAGS

public static final java.lang.String DEFAULT_IF_TAGS

See Also:

Constant Field Values

unlessTags

public java.lang.String unlessTags

DEFAULT_UNLESS_TAGS

public static final java.lang.String DEFAULT_UNLESS_TAGS

See Also:

Constant Field Values

skipTags

public java.lang.String skipTags

DEFAULT_SKIP_TAGS

public static final java.lang.String DEFAULT_SKIP_TAGS

See Also:

Constant Field Values

minLength

public int minLength

maxLength

public int maxLength

addCanonicalForm

@Deprecated
public boolean addCanonicalForm

Deprecated.

DEFAULT_ADD_CANONICAL_FORM

public static final boolean DEFAULT_ADD_CANONICAL_FORM

See Also:

Constant Field Values

multivalued

@Deprecated
public boolean multivalued

Deprecated.

DEFAULT_MULTIVALUED

public static final boolean DEFAULT_MULTIVALUED

See Also:

Constant Field Values

keepLongestMatch

public boolean keepLongestMatch

DEFAULT_KEEP_LONGEST_MATCH

public static final boolean DEFAULT_KEEP_LONGEST_MATCH

See Also:

Constant Field Values

differentiateNGrams

public boolean differentiateNGrams

DEFAULT_DIFFERENTIATE_N_GRAMS

public static final boolean DEFAULT_DIFFERENTIATE_N_GRAMS

See Also:

Constant Field Values

Constructor Detail

NGram

public NGram()

NGram

public NGram(NGram o)

Copy constructor

Method Detail

withName

public NGram withName(java.lang.String name)

Overrides:

withName in class SemanticProcessor

withContexts

public NGram withContexts(java.lang.String contexts)

Overrides:

withContexts in class SemanticProcessor

withSrc

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

Deprecated.

Overrides:

withSrc in class SemanticProcessor

setFromTags

public void setFromTags(java.lang.String fromTags)

The optional list of annotations (comma separated) sorted by priority that will be used to build the ngram.

getFromTags

public java.lang.String getFromTags()

The optional list of annotations (comma separated) sorted by priority that will be used to build the ngram.

withFromTags

public NGram withFromTags(java.lang.String fromTags)

setIfTags

public void setIfTags(java.lang.String ifTags)

The optional list of annotation tags (comma separated) required to consider the current token.

getIfTags

public java.lang.String getIfTags()

The optional list of annotation tags (comma separated) required to consider the current token.

withIfTags

public NGram withIfTags(java.lang.String ifTags)

setUnlessTags

public void setUnlessTags(java.lang.String unlessTags)

The optional list of annotation tags (comma separated) not-required to consider the current token.

getUnlessTags

public java.lang.String getUnlessTags()

The optional list of annotation tags (comma separated) not-required to consider the current token.

withUnlessTags

public NGram withUnlessTags(java.lang.String unlessTags)

setSkipTags

public void setSkipTags(java.lang.String skipTags)

The optional list of annotation tags (comma separated) to skip/ignore.

getSkipTags

public java.lang.String getSkipTags()

The optional list of annotation tags (comma separated) to skip/ignore.

withSkipTags

public NGram withSkipTags(java.lang.String skipTags)

setMinLength

public void setMinLength(int minLength)

The minimum number of words.

getMinLength

public int getMinLength()

The minimum number of words.

withMinLength

public NGram withMinLength(int minLength)

withMinLength

public NGram withMinLength(java.lang.Integer minLength)

setMaxLength

public void setMaxLength(int maxLength)

The maximum number of words.

getMaxLength

public int getMaxLength()

The maximum number of words.

withMaxLength

public NGram withMaxLength(int maxLength)

withMaxLength

public NGram withMaxLength(java.lang.Integer maxLength)

setAddCanonicalForm

@Deprecated
public void setAddCanonicalForm(boolean addCanonicalForm)

Deprecated.

isAddCanonicalForm

@Deprecated
public boolean isAddCanonicalForm()

Deprecated.

withAddCanonicalForm

@Deprecated
public NGram withAddCanonicalForm(boolean addCanonicalForm)

Deprecated.

withAddCanonicalForm

@Deprecated
public NGram withAddCanonicalForm(java.lang.Boolean addCanonicalForm)

Deprecated.

setMultivalued

@Deprecated
public void setMultivalued(boolean multivalued)

Deprecated.

isMultivalued

@Deprecated
public boolean isMultivalued()

Deprecated.

withMultivalued

@Deprecated
public NGram withMultivalued(boolean multivalued)

Deprecated.

withMultivalued

@Deprecated
public NGram withMultivalued(java.lang.Boolean multivalued)

Deprecated.

setKeepLongestMatch

public void setKeepLongestMatch(boolean keepLongestMatch)

Only the longest match should be kept.

isKeepLongestMatch

public boolean isKeepLongestMatch()

Only the longest match should be kept.

withKeepLongestMatch

public NGram withKeepLongestMatch(boolean keepLongestMatch)

withKeepLongestMatch

public NGram withKeepLongestMatch(java.lang.Boolean keepLongestMatch)

setDifferentiateNGrams

public void setDifferentiateNGrams(boolean differentiateNGrams)

Should the annotation be '2gram' instead of the constant 'ngram' in case of a bigram

isDifferentiateNGrams

public boolean isDifferentiateNGrams()

Should the annotation be '2gram' instead of the constant 'ngram' in case of a bigram

withDifferentiateNGrams

public NGram withDifferentiateNGrams(boolean differentiateNGrams)

withDifferentiateNGrams

public NGram withDifferentiateNGrams(java.lang.Boolean differentiateNGrams)

makeCopy

public NGram makeCopy()

Creates and returns a deep copy of this NGram.

Overrides:

makeCopy in class SemanticProcessor

readFrom

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

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

Overrides:

writeTo in class SemanticProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this NGram.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this NGram.

Overrides:

toString in class SemanticProcessor

check

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

Checks this NGram.

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