scriptella.driver.lucene

Class LuceneQuery

java.lang.Object

scriptella.driver.lucene.LuceneQuery

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, ParametersCallback

public class LuceneQuery
extends java.lang.Object
implements ParametersCallback, java.io.Closeable

Query for Lucene indexed data.

Version:

1.0

Author:

Kirill Volgin

Constructor Summary

Constructors

Constructor and Description
LuceneQuery(java.lang.String indexPath, ParametersCallback parametersCallback, QueryCallback queryCallback) Creates a query for Lucene index.

Method Summary

Modifier and Type	Method and Description
void	close()
void	execute(java.io.Reader queryReader, java.util.Collection<java.lang.String> fields, java.lang.Boolean useMultiFieldParser, java.lang.Boolean useLowercaseExpandedTerms) Executes a query.
java.lang.Object	getParameter(java.lang.String name) Returns the value of parameter specified by name.

Methods inherited from class java.lang.Object

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

Constructor Detail

LuceneQuery

public LuceneQuery(java.lang.String indexPath,
                   ParametersCallback parametersCallback,
                   QueryCallback queryCallback)

Creates a query for Lucene index.

Parameters:

indexPath - path to lucene index

parametersCallback - parameters to use.

queryCallback - callback to use for result set iteration.

Method Detail

execute

public void execute(java.io.Reader queryReader,
                    java.util.Collection<java.lang.String> fields,
                    java.lang.Boolean useMultiFieldParser,
                    java.lang.Boolean useLowercaseExpandedTerms)

Executes a query.

Parameters:

queryReader - query content reader. Closed after this method completes.

fields - fields to be searched

useMultiFieldParser - whether MultiFieldQueryParser or QueryParser to be used

useLowercaseExpandedTerms - whether terms of wildcard, prefix, fuzzy and range queries are to be automatically lower-cased or not

getParameter

public java.lang.Object getParameter(java.lang.String name)

Description copied from interface: ParametersCallback

Returns the value of parameter specified by name.

The callback internally delegates a call to parent callbacks if the parameter cannot be found.

Specified by:

getParameter in interface ParametersCallback

Parameters:

name - parameter name. Providers are allowed (but not required) to ignore a case of the name parameter to comply with their internal model. For example JDBC drivers are case-insensitive to column names.

Returns:

parameter value or null if parameter doesn't exist.

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException