com.bigdata.rdf.lexicon

Class ITextIndexer.FullTextQuery

java.lang.Object

com.bigdata.rdf.lexicon.ITextIndexer.FullTextQuery

All Implemented Interfaces:

Serializable

Enclosing interface:

ITextIndexer<A extends IHit>

public static class ITextIndexer.FullTextQuery
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ITextIndexer.FullTextQuery(String query)
ITextIndexer.FullTextQuery(String query, String languageCode, boolean prefixMatch)
ITextIndexer.FullTextQuery(String query, String languageCode, boolean prefixMatch, String matchRegex, boolean matchAllTerms, boolean matchExact)
ITextIndexer.FullTextQuery(String query, String languageCode, boolean prefixMatch, String matchRegex, boolean matchAllTerms, boolean matchExact, double minCosine, double maxCosine, int minRank, int maxRank)
ITextIndexer.FullTextQuery(String query, String languageCode, boolean prefixMatch, String matchRegex, boolean matchAllTerms, boolean matchExact, double minCosine, double maxCosine, int minRank, int maxRank, long timeout, TimeUnit unit) Construct a full text query.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getLanguageCode()
String	getMatchRegex()
double	getMaxCosine()
int	getMaxRank()
double	getMinCosine()
int	getMinRank()
String	getQuery()
long	getTimeout()
TimeUnit	getTimeUnit()
int	hashCode()
boolean	isMatchAllTerms()
boolean	isMatchExact()
boolean	isPrefixMatch()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ITextIndexer.FullTextQuery

public ITextIndexer.FullTextQuery(String query)

ITextIndexer.FullTextQuery

public ITextIndexer.FullTextQuery(String query,
                          String languageCode,
                          boolean prefixMatch)

ITextIndexer.FullTextQuery

public ITextIndexer.FullTextQuery(String query,
                          String languageCode,
                          boolean prefixMatch,
                          String matchRegex,
                          boolean matchAllTerms,
                          boolean matchExact)

ITextIndexer.FullTextQuery

public ITextIndexer.FullTextQuery(String query,
                          String languageCode,
                          boolean prefixMatch,
                          String matchRegex,
                          boolean matchAllTerms,
                          boolean matchExact,
                          double minCosine,
                          double maxCosine,
                          int minRank,
                          int maxRank)

ITextIndexer.FullTextQuery

public ITextIndexer.FullTextQuery(String query,
                          String languageCode,
                          boolean prefixMatch,
                          String matchRegex,
                          boolean matchAllTerms,
                          boolean matchExact,
                          double minCosine,
                          double maxCosine,
                          int minRank,
                          int maxRank,
                          long timeout,
                          TimeUnit unit)

Construct a full text query.

Parameters:

query - The query (it will be parsed into tokens).

languageCode - The language code that should be used when tokenizing the query -or- null to use the default Locale ).

prefixMatch - When true, the matches will be on tokens which include the query tokens as a prefix. This includes exact matches as a special case when the prefix is the entire token, but it also allows longer matches. For example, free will be an exact match on free but a partial match on freedom. When false, only exact matches will be made.

matchRegex - A regex filter to apply to the search.

matchAllTerms - if true, return only hits that match all search terms

matchExact - if true, return only hits that have an exact match of the search string

minCosine - The minimum cosine that will be returned (in [0:maxCosine]). If you specify a minimum cosine of ZERO (0.0) you can drag in a lot of basically useless search results.

maxCosine - The maximum cosine that will be returned (in [minCosine:1.0]). Useful for evaluating in relevance ranges.

minRank - The min rank of the search result.

maxRank - The max rank of the search result.

timeout - The timeout -or- ZERO (0) for NO timeout (this is equivalent to using Long.MAX_VALUE).

unit - The unit in which the timeout is expressed.

Method Detail

getQuery

public String getQuery()

Returns:

the query

getLanguageCode

public String getLanguageCode()

Returns:

the languageCode

isPrefixMatch

public boolean isPrefixMatch()

Returns:

the prefixMatch

getMatchRegex

public String getMatchRegex()

Returns:

the match regex filter to apply

isMatchAllTerms

public boolean isMatchAllTerms()

Returns:

the matchAllTerms

isMatchExact

public boolean isMatchExact()

Returns:

the matchExact

getMinCosine

public double getMinCosine()

Returns:

the minCosine

getMaxCosine

public double getMaxCosine()

Returns:

the maxCosine

getMinRank

public int getMinRank()

Returns:

the minRank

getMaxRank

public int getMaxRank()

Returns:

the maxRank

getTimeout

public long getTimeout()

Returns:

the timeout

getTimeUnit

public TimeUnit getTimeUnit()

Returns:

the unit

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object