org.apache.nutch.searcher
Class Query

java.lang.Object
  org.apache.nutch.searcher.Query

All Implemented Interfaces:

Cloneable, Configurable, Writable

public final class Query
extends Object
implements Writable, Cloneable, Configurable

A Nutch query.

Nested Class Summary

static class	Query.Clause A query clause.
static class	Query.Phrase A phrase query clause.
static class	Query.Term A single-term query clause.

Field Summary

static org.apache.commons.logging.Log

LOG

Constructor Summary

Query()

Query(Configuration conf)

Method Summary

void	addProhibitedPhrase(String[] terms) Add a prohibited phrase in the default field.
void	addProhibitedPhrase(String[] terms, String field) Add a prohibited phrase in the specified field.
void	addProhibitedTerm(String term) Add a prohibited term in the default field.
void	addProhibitedTerm(String term, String field) Add a prohibited term in the specified field.
void	addRequiredPhrase(String[] terms) Add a required phrase in the default field.
void	addRequiredPhrase(String[] terms, String field) Add a required phrase in the specified field.
void	addRequiredTerm(String term) Add a required term in the default field.
void	addRequiredTerm(String term, String field) Add a required term in a specified field.
Object	clone()
boolean	equals(Object o)
Query.Clause[]	getClauses() Return all clauses.
Configuration	getConf()
QueryParams	getParams()
String[]	getTerms() Flattens a query into the set of text terms that it contains.
int	hashCode()
static void	main(String[] args) For debugging.
static Query	parse(String queryString, Configuration conf) Parse a query from a string.
static Query	parse(String queryString, String queryLang, Configuration conf) Parse a query from a string using a language specific analyzer.
static Query	read(DataInput in, Configuration conf)
void	readFields(DataInput in)
void	setConf(Configuration conf)
void	setParams(QueryParams context)
String	toString()
void	write(DataOutput out)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LOG

public static final org.apache.commons.logging.Log LOG

Constructor Detail

Query

public Query()

Query

public Query(Configuration conf)

Method Detail

setParams

public void setParams(QueryParams context)

getParams

public QueryParams getParams()

setConf

public void setConf(Configuration conf)

Specified by:

setConf in interface Configurable

getConf

public Configuration getConf()

Specified by:

getConf in interface Configurable

getClauses

public Query.Clause[] getClauses()

Return all clauses.

addRequiredTerm

public void addRequiredTerm(String term)

Add a required term in the default field.

addRequiredTerm

public void addRequiredTerm(String term,
                            String field)

Add a required term in a specified field.

addProhibitedTerm

public void addProhibitedTerm(String term)

Add a prohibited term in the default field.

addProhibitedTerm

public void addProhibitedTerm(String term,
                              String field)

Add a prohibited term in the specified field.

addRequiredPhrase

public void addRequiredPhrase(String[] terms)

Add a required phrase in the default field.

addRequiredPhrase

public void addRequiredPhrase(String[] terms,
                              String field)

Add a required phrase in the specified field.

addProhibitedPhrase

public void addProhibitedPhrase(String[] terms)

Add a prohibited phrase in the default field.

addProhibitedPhrase

public void addProhibitedPhrase(String[] terms,
                                String field)

Add a prohibited phrase in the specified field.

write

public void write(DataOutput out)
           throws IOException

Specified by:

write in interface Writable

Throws:

IOException

read

public static Query read(DataInput in,
                         Configuration conf)
                  throws IOException

Throws:

IOException

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

readFields in interface Writable

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Object clone()

Overrides:

clone in class Object

getTerms

public String[] getTerms()

Flattens a query into the set of text terms that it contains. These are terms which should be higlighted in matching documents.

parse

public static Query parse(String queryString,
                          String queryLang,
                          Configuration conf)
                   throws IOException

Parse a query from a string using a language specific analyzer.

Parameters:

queryString - is the raw query string to parse

queryLang - is a two-letters language code used to identify which NutchAnalyzer should be used to parse the query string.

Throws:

IOException

See Also:

AnalyzerFactory

parse

public static Query parse(String queryString,
                          Configuration conf)
                   throws IOException

Parse a query from a string.

Throws:

IOException

main

public static void main(String[] args)
                 throws Exception

For debugging.

Throws:

Exception