com.exalead.mercury.mami.search.v20

Class NGramModule

java.lang.Object

com.exalead.mercury.mami.search.v20.QueryExpansionModule

com.exalead.mercury.mami.search.v20.NGramModule

All Implemented Interfaces:

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

public class NGramModule
extends QueryExpansionModule
implements com.exalead.util.Checkable, java.io.Serializable

Serve as a function for query expansion config in query prefix handlers.

See Also:

/>, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.mercury.mami.search.v20.QueryExpansionModule

QueryExpansionModule.Transformer<T>, QueryExpansionModule.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
boolean	addCanonicalForm
static boolean	DEFAULT_ADD_CANONICAL_FORM
static boolean	DEFAULT_KEEP_LONGEST_MATCH
static int	DEFAULT_MAX_SPAN
static int	DEFAULT_MIN_SPAN
static boolean	DEFAULT_WITH_LEMMATIZER
static boolean	DEFAULT_WITH_STOP_WORD_DICT
boolean	keepLongestMatch
int	maxSpan
int	minSpan
boolean	withLemmatizer
boolean	withStopWordDict

Fields inherited from class com.exalead.mercury.mami.search.v20.QueryExpansionModule

name

Constructor Summary

Constructors

Constructor and Description
NGramModule()
NGramModule(NGramModule o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(QueryExpansionModule.Transformer<T> transformer, T[] t)
void	accept(QueryExpansionModule.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this NGramModule.
static NGramModule	fromString(java.lang.String s) String representation of this NGramModule.
int	getMaxSpan() Maximal number of words (excluding stop words) in a generated related term.
int	getMinSpan() Minimum number of words (excluding stop words) in a generated related term.
boolean	isAddCanonicalForm()
boolean	isKeepLongestMatch() Keeps only the longest match. For example, if you have 5 tokens ('a', 'b', 'c', 'd', 'e') and 4 related terms 'a', 'a-c', 'b-c-d' and 'd-e'. This option will only keep 'b-c-d' and will remove all other related terms.
boolean	isWithLemmatizer() Adds a Lemmatizer to the list of processors automatically.
boolean	isWithStopWordDict() Adds a StopWord dictionary to the list of processors automatically.
NGramModule	makeCopy() Creates and returns a deep copy of this NGramModule.
static NGramModule	readFrom(java.io.InputStream is) Read this NGramModule from an XML fragment.
void	setAddCanonicalForm(boolean addCanonicalForm)
void	setKeepLongestMatch(boolean keepLongestMatch) Keeps only the longest match. For example, if you have 5 tokens ('a', 'b', 'c', 'd', 'e') and 4 related terms 'a', 'a-c', 'b-c-d' and 'd-e'. This option will only keep 'b-c-d' and will remove all other related terms.
void	setMaxSpan(int maxSpan) Maximal number of words (excluding stop words) in a generated related term.
void	setMinSpan(int minSpan) Minimum number of words (excluding stop words) in a generated related term.
void	setWithLemmatizer(boolean withLemmatizer) Adds a Lemmatizer to the list of processors automatically.
void	setWithStopWordDict(boolean withStopWordDict) Adds a StopWord dictionary to the list of processors automatically.
java.lang.String	toString() String representation of this NGramModule.
NGramModule	withAddCanonicalForm(boolean addCanonicalForm)
NGramModule	withAddCanonicalForm(java.lang.Boolean addCanonicalForm)
NGramModule	withKeepLongestMatch(boolean keepLongestMatch)
NGramModule	withKeepLongestMatch(java.lang.Boolean keepLongestMatch)
NGramModule	withMaxSpan(int maxSpan)
NGramModule	withMaxSpan(java.lang.Integer maxSpan)
NGramModule	withMinSpan(int minSpan)
NGramModule	withMinSpan(java.lang.Integer minSpan)
NGramModule	withName(java.lang.String name)
NGramModule	withWithLemmatizer(boolean withLemmatizer)
NGramModule	withWithLemmatizer(java.lang.Boolean withLemmatizer)
NGramModule	withWithStopWordDict(boolean withStopWordDict)
NGramModule	withWithStopWordDict(java.lang.Boolean withStopWordDict)
void	writeTo(java.io.OutputStream os) Write this NGramModule as an XML fragment

Methods inherited from class com.exalead.mercury.mami.search.v20.QueryExpansionModule

getName, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

minSpan

public int minSpan

DEFAULT_MIN_SPAN

public static final int DEFAULT_MIN_SPAN

See Also:

Constant Field Values

maxSpan

public int maxSpan

DEFAULT_MAX_SPAN

public static final int DEFAULT_MAX_SPAN

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

withLemmatizer

public boolean withLemmatizer

DEFAULT_WITH_LEMMATIZER

public static final boolean DEFAULT_WITH_LEMMATIZER

See Also:

Constant Field Values

withStopWordDict

public boolean withStopWordDict

DEFAULT_WITH_STOP_WORD_DICT

public static final boolean DEFAULT_WITH_STOP_WORD_DICT

See Also:

Constant Field Values

addCanonicalForm

public boolean addCanonicalForm

DEFAULT_ADD_CANONICAL_FORM

public static final boolean DEFAULT_ADD_CANONICAL_FORM

See Also:

Constant Field Values

Constructor Detail

NGramModule

public NGramModule()

NGramModule

public NGramModule(NGramModule o)

Copy constructor

Method Detail

withName

public NGramModule withName(java.lang.String name)

Overrides:

withName in class QueryExpansionModule

setMinSpan

public void setMinSpan(int minSpan)

Minimum number of words (excluding stop words) in a generated related term.

getMinSpan

public int getMinSpan()

Minimum number of words (excluding stop words) in a generated related term.

withMinSpan

public NGramModule withMinSpan(int minSpan)

withMinSpan

public NGramModule withMinSpan(java.lang.Integer minSpan)

setMaxSpan

public void setMaxSpan(int maxSpan)

Maximal number of words (excluding stop words) in a generated related term.

getMaxSpan

public int getMaxSpan()

Maximal number of words (excluding stop words) in a generated related term.

withMaxSpan

public NGramModule withMaxSpan(int maxSpan)

withMaxSpan

public NGramModule withMaxSpan(java.lang.Integer maxSpan)

setKeepLongestMatch

public void setKeepLongestMatch(boolean keepLongestMatch)

Keeps only the longest match.
For example, if you have 5 tokens ('a', 'b', 'c', 'd', 'e') and 4 related terms 'a', 'a-c', 'b-c-d' and 'd-e'.
This option will only keep 'b-c-d' and will remove all other related terms.

isKeepLongestMatch

public boolean isKeepLongestMatch()

Keeps only the longest match.
For example, if you have 5 tokens ('a', 'b', 'c', 'd', 'e') and 4 related terms 'a', 'a-c', 'b-c-d' and 'd-e'.
This option will only keep 'b-c-d' and will remove all other related terms.

withKeepLongestMatch

public NGramModule withKeepLongestMatch(boolean keepLongestMatch)

withKeepLongestMatch

public NGramModule withKeepLongestMatch(java.lang.Boolean keepLongestMatch)

setWithLemmatizer

public void setWithLemmatizer(boolean withLemmatizer)

Adds a Lemmatizer to the list of processors automatically.

isWithLemmatizer

public boolean isWithLemmatizer()

Adds a Lemmatizer to the list of processors automatically.

withWithLemmatizer

public NGramModule withWithLemmatizer(boolean withLemmatizer)

withWithLemmatizer

public NGramModule withWithLemmatizer(java.lang.Boolean withLemmatizer)

setWithStopWordDict

public void setWithStopWordDict(boolean withStopWordDict)

Adds a StopWord dictionary to the list of processors automatically.

isWithStopWordDict

public boolean isWithStopWordDict()

Adds a StopWord dictionary to the list of processors automatically.

withWithStopWordDict

public NGramModule withWithStopWordDict(boolean withStopWordDict)

withWithStopWordDict

public NGramModule withWithStopWordDict(java.lang.Boolean withStopWordDict)

setAddCanonicalForm

public void setAddCanonicalForm(boolean addCanonicalForm)

isAddCanonicalForm

public boolean isAddCanonicalForm()

withAddCanonicalForm

public NGramModule withAddCanonicalForm(boolean addCanonicalForm)

withAddCanonicalForm

public NGramModule withAddCanonicalForm(java.lang.Boolean addCanonicalForm)

makeCopy

public NGramModule makeCopy()

Creates and returns a deep copy of this NGramModule.

Overrides:

makeCopy in class QueryExpansionModule

readFrom

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

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

Overrides:

writeTo in class QueryExpansionModule

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this NGramModule.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this NGramModule.

Overrides:

toString in class QueryExpansionModule

check

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

Checks this NGramModule.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class QueryExpansionModule

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class QueryExpansionModule

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class QueryExpansionModule

Throws:

com.exalead.util.TypedException