org.apache.lucene.search.regex

Class SpanRegexQuery

Implemented Interfaces:
Cloneable, org.apache.lucene.search.regex.RegexQueryCapable, Serializable

public class SpanRegexQuery
extends SpanQuery
implements org.apache.lucene.search.regex.RegexQueryCapable

A SpanQuery version of RegexQuery allowing regular expression queries to be nested within other SpanQuery subclasses.
See Also:
Serialized Form

Constructor Summary

SpanRegexQuery(Term term)

Method Summary

boolean
equals(Object o)
String
getField()
Returns the name of the field matched by this query.
org.apache.lucene.search.regex.RegexCapabilities
getRegexImplementation()
Spans
getSpans(IndexReader reader)
Expert: Returns the matches for this query in an index.
Term
getTerm()
Collection
getTerms()
Returns a collection of all terms matched by this query.
int
hashCode()
Query
rewrite(IndexReader reader)
Expert: called to re-write queries into primitive queries.
void
setRegexImplementation(org.apache.lucene.search.regex.RegexCapabilities impl)
String
toString(String field)
Prints a query to a string, with field as the default field for terms.

Methods inherited from class org.apache.lucene.search.spans.SpanQuery

createWeight, getField, getSpans, getTerms

Methods inherited from class org.apache.lucene.search.Query

clone, combine, createWeight, extractTerms, getBoost, getSimilarity, mergeBooleanQueries, rewrite, setBoost, toString, toString, weight

Constructor Details

SpanRegexQuery

public SpanRegexQuery(Term term)

Method Details

equals

public boolean equals(Object o)

getField

public String getField()
Returns the name of the field matched by this query.
Overrides:
getField in interface SpanQuery

getRegexImplementation

public org.apache.lucene.search.regex.RegexCapabilities getRegexImplementation()
Specified by:
getRegexImplementation in interface org.apache.lucene.search.regex.RegexQueryCapable

getSpans

public Spans getSpans(IndexReader reader)
            throws IOException
Expert: Returns the matches for this query in an index. Used internally to search for spans.
Overrides:
getSpans in interface SpanQuery

getTerm

public Term getTerm()

getTerms

public Collection getTerms()
Returns a collection of all terms matched by this query.
Overrides:
getTerms in interface SpanQuery

hashCode

public int hashCode()

rewrite

public Query rewrite(IndexReader reader)
            throws IOException
Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.
Overrides:
rewrite in interface Query

setRegexImplementation

public void setRegexImplementation(org.apache.lucene.search.regex.RegexCapabilities impl)
Specified by:
setRegexImplementation in interface org.apache.lucene.search.regex.RegexQueryCapable

toString

public String toString(String field)
Prints a query to a string, with field as the default field for terms.

The representation used is one that is supposed to be readable by QueryParser. However, there are the following limitations:

  • If the query was created by the parser, the printed representation may not be exactly what was parsed. For example, characters that need to be escaped will be represented without the required backslash.
  • Some of the more complicated queries (e.g. span queries) don't have a representation that can be parsed by QueryParser.
Overrides:
toString in interface Query

Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.