org.apache.lucene.queryParser
Class MultiFieldQueryParser

java.lang.Object
  |
  +--org.apache.lucene.queryParser.QueryParser
        |
        +--org.apache.lucene.queryParser.MultiFieldQueryParser

All Implemented Interfaces:

QueryParserConstants

public class MultiFieldQueryParser

extends QueryParser

A QueryParser which constructs queries to search multiple fields.

Version:

$Revision: 1.2 $

Author:

Kelvin Tan

Field Summary

static int	NORMAL_FIELD
static int	PROHIBITED_FIELD
static int	REQUIRED_FIELD

Fields inherited from class org.apache.lucene.queryParser.QueryParser

jj_nt, lookingAhead, token, token_source

Fields inherited from interface org.apache.lucene.queryParser.QueryParserConstants

_ESCAPED_CHAR, _NUM_CHAR, _TERM_CHAR, _TERM_START_CHAR, _WHITESPACE, AND, Boost, CARAT, COLON, DEFAULT, EOF, FUZZY, LPAREN, MINUS, NOT, NUMBER, OR, PLUS, PREFIXTERM, QUOTED, RANGEEX, RANGEIN, RPAREN, SLOP, TERM, tokenImage, WILDTERM

Constructor Summary

MultiFieldQueryParser(CharStream stream)

MultiFieldQueryParser(QueryParserTokenManager tm)

MultiFieldQueryParser(String f, Analyzer a)

Method Summary

static Query	parse(String query, String[] fields, Analyzer analyzer) Parses a query which searches on the fields specified.
static Query	parse(String query, String[] fields, int[] flags, Analyzer analyzer) Parses a query, searching on the fields specified.

Methods inherited from class org.apache.lucene.queryParser.QueryParser

Clause, Conjunction, disable_tracing, enable_tracing, generateParseException, getNextToken, getPhraseSlop, getToken, main, Modifiers, parse, parse, Query, ReInit, ReInit, setPhraseSlop, Term

Methods inherited from class java.lang.Object

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

Field Detail

NORMAL_FIELD

public static final int NORMAL_FIELD

REQUIRED_FIELD

public static final int REQUIRED_FIELD

PROHIBITED_FIELD

public static final int PROHIBITED_FIELD

Constructor Detail

MultiFieldQueryParser

public MultiFieldQueryParser(QueryParserTokenManager tm)

MultiFieldQueryParser

public MultiFieldQueryParser(CharStream stream)

MultiFieldQueryParser

public MultiFieldQueryParser(String f,
                             Analyzer a)

Method Detail

parse

public static Query parse(String query,
                          String[] fields,
                          Analyzer analyzer)
                   throws ParseException

Parses a query which searches on the fields specified.

If x fields are specified, this effectively constructs:

 
 (field1:query) (field2:query) (field3:query)...(fieldx:query)
 
 

Parameters:

query - Query string to parse

fields - Fields to search on

analyzer - Analyzer to use

Throws:

ParserException - if query parsing fails

TokenMgrError - if query parsing fails

parse

public static Query parse(String query,
                          String[] fields,
                          int[] flags,
                          Analyzer analyzer)
                   throws ParseException

Parses a query, searching on the fields specified. Use this if you need to specify certain fields as required, and others as prohibited.

 Usage:
 
 String[] fields = {"filename", "contents", "description"};
 int[] flags = {MultiFieldQueryParser.NORMAL FIELD,
                MultiFieldQueryParser.REQUIRED FIELD,
                MultiFieldQueryParser.PROHIBITED FIELD,};
 parse(query, fields, flags, analyzer);
 
 

The code above would construct a query:

 
 (filename:query) +(contents:query) -(description:query)
 
 

Parameters:

query - Query string to parse

fields - Fields to search on

flags - Flags describing the fields

analyzer - Analyzer to use

Throws:

ParserException - if query parsing fails

TokenMgrError - if query parsing fails