modnlp.idx.query

Class WordQuery

java.lang.Object

modnlp.idx.query.WordQuery

public class WordQuery
extends java.lang.Object

Tokenize and parse the keyword query

See Also:

Field Summary

Fields

Modifier and Type	Field and Description
static byte	LEFTWILDCARD_TYPE
static java.lang.String	QSEPTOKEN
static byte	REGEX_TYPE
static java.lang.String	REGEXPMARKER
static byte	RIGHTWILDCARD_TYPE
static char[]	SEPTKARR
static java.lang.String	SEPTOKEN
static byte	WORD_TYPE

Constructor Summary

Constructors

Constructor and Description
WordQuery(java.lang.String query, Dictionary dict, boolean cs) Creates a new WordQuery instance based on a query string, to be processed against dict.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFirstWord()
int	getIntervToWord(java.lang.String w)
java.lang.String	getKeyword()
WordForms	getKeyWordForms()
WordForms	getLeastFrequentWord()
Horizon	getLeftHorizon() Get a Horizon object conaining the maximum distances allowed in this query between the main keyword and the keywords to the left of it in the query expression.
Horizon	getRightHorizon() Get a Horizon object conaining the maximum distances allowed in this query between the main keyword and the keywords to the right of it in the query expression.
WordForms[]	getWFormsArray()
static java.lang.String	getWildcardsLHS(java.lang.String key)
static java.lang.String	getWildcardsRHS(java.lang.String key)
WordForms	getWordForms(int i)
boolean	isJustKeyword()
static boolean	isLeftWildcard(java.lang.String key)
static boolean	isRightWildcard(java.lang.String key)
static boolean	isValidQuery(java.lang.String q) Perform basic sanity check on a query (for use by clients, for instance, where full parsing of the query is impossible without accessing the server)
static boolean	isWildcard(java.lang.String key)
boolean	matchConcordance(java.lang.String cline, int ctx) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

QSEPTOKEN

public static final java.lang.String QSEPTOKEN

See Also:

Constant Field Values

REGEXPMARKER

public static final java.lang.String REGEXPMARKER

See Also:

Constant Field Values

SEPTKARR

public static char[] SEPTKARR

SEPTOKEN

public static java.lang.String SEPTOKEN

WORD_TYPE

public static final byte WORD_TYPE

See Also:

Constant Field Values

LEFTWILDCARD_TYPE

public static final byte LEFTWILDCARD_TYPE

See Also:

Constant Field Values

RIGHTWILDCARD_TYPE

public static final byte RIGHTWILDCARD_TYPE

See Also:

Constant Field Values

REGEX_TYPE

public static final byte REGEX_TYPE

See Also:

Constant Field Values

Constructor Detail

WordQuery

public WordQuery(java.lang.String query,
         Dictionary dict,
         boolean cs)
          throws WordQueryException

Creates a new WordQuery instance based on a query string, to be processed against dict. The query expression can be expressed in the following syntax: k_1[+[i_1]]k_2+[i_2]+k_3+...+[i_{n-1}]k_n]. where word_i can be a single keyword or a (Unix-style) wildcard (e.g. test* will retrive all words wich start with test (e.g. test, tests, testament, etc). i_n denotes the maximum number of intervening words between k_{n+1} and k_1.

The syntax also allows you to specify sequences of key words, and/or wildcards, and the maximum number of intervening words you wish to allow between each element in the sequence.

Examples:

Combinations of words and wildcards are also allowed, so
• Entering seen+before will find * ...never seen before... etc;
• entering seen+[1]before finds, in addition, ...seen her before..., ...seen ie before..., and all sequences in which there is at most one word between seen and before.
• Combinations of words and wildcards are also allowed, so entering know+before* will find ...know before..., ...know beforehand, etc.
• Regular expressions can also be used. Double-quoted strings will be interpreted as regexps. E.g. ".*less.*" will find ...less..., ...hopeless, hopelessness, etc. N.B.: much (perhaps most) of the functionality in this class should really be moved into modnlp.idx.database.Dictionary. Ideally, Dictionary should handle the functionality currently implemented in modnlp.idx.query.WordQuery.matchConcordance() and auxiliary methods, leaving only query parsing and related methods for WordQuery. This hasn't been done yet to preserve backward compatibility with tec-server

Parameters:

query - a String The query string

dict - a Dictionary the top-level index accessor class

cs - a boolean if true, the query is case sensitive.

Throws:

WordQueryException - if an error occurs

Method Detail

getKeyWordForms

public WordForms getKeyWordForms()

getWFormsArray

public WordForms[] getWFormsArray()

getRightHorizon

public Horizon getRightHorizon()

Get a Horizon object conaining the maximum distances allowed in this query between the main keyword and the keywords to the right of it in the query expression.

Returns:

a Horizon object or null if 1 or less keywords.

getLeftHorizon

public Horizon getLeftHorizon()

Get a Horizon object conaining the maximum distances allowed in this query between the main keyword and the keywords to the left of it in the query expression.

Returns:

a Horizon object or null if 1 or less keywords in query.

isLeftWildcard

public static final boolean isLeftWildcard(java.lang.String key)

isRightWildcard

public static final boolean isRightWildcard(java.lang.String key)

isWildcard

public static final boolean isWildcard(java.lang.String key)

getWildcardsLHS

public static java.lang.String getWildcardsLHS(java.lang.String key)

getWildcardsRHS

public static java.lang.String getWildcardsRHS(java.lang.String key)

getKeyword

public java.lang.String getKeyword()

getFirstWord

public java.lang.String getFirstWord()

isJustKeyword

public boolean isJustKeyword()

getLeastFrequentWord

public WordForms getLeastFrequentWord()

getWordForms

public WordForms getWordForms(int i)

matchConcordance

public boolean matchConcordance(java.lang.String cline,
                       int ctx)

Deprecated.

matchConcordance match cline against this query (represented after parseQuery() by queryArray and intervArray) NB: this method really belongs in Dictionary. TO DO: Check potential backward compat problems in tec-server and deprecate WordQuery.matchConcordance() in favour of Dictionary.matchConcordance().

Parameters:

cline - a String value

ctx - an int value

Returns:

true if cline matches, false otherwise.

getIntervToWord

public int getIntervToWord(java.lang.String w)

isValidQuery

public static boolean isValidQuery(java.lang.String q)

Perform basic sanity check on a query (for use by clients, for instance, where full parsing of the query is impossible without accessing the server)

Parameters:

q - a String value

Returns:

a boolean value