org.apache.nutch.searcher
Class Query

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

All Implemented Interfaces:

Cloneable, Writable

public final class Query

extends Object

implements Writable, Cloneable

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 Logger

LOG

Constructor Summary

Query()

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.
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) Parse a query from a string.
static Query	read(DataInput in)
void	readFields(DataInput in) Reads the fields of this object from in.
String	toString()
void	write(DataOutput out) Writes the fields of this object to out.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final Logger LOG

Constructor Detail

Query

public Query()

Method Detail

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

Description copied from interface: Writable

Writes the fields of this object to out.

Specified by:

write in interface Writable

Throws:

IOException

read

public static Query read(DataInput in)
                  throws IOException

Throws:

IOException

readFields

public void readFields(DataInput in)
                throws IOException

Description copied from interface: Writable

Reads the fields of this object from in. For efficiency, implementations should attempt to re-use storage in the existing object where possible.

Specified by:

readFields in interface Writable

Throws:

IOException

toString

public String toString()

equals

public boolean equals(Object o)

hashCode

public int hashCode()

clone

public Object clone()

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)
                   throws IOException

Parse a query from a string.

Throws:

IOException

main

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

For debugging.

Throws:

Exception