Package org.apache.lucene.search

Class TermQuery

  • All Implemented Interfaces:
    java.lang.Cloneable
    public class TermQuery
extends Query
    A Query that matches documents containing a term. This may be combined with other terms with a BooleanQuery.

    • Constructor Summary

      Constructors 
      Constructor Description
      TermQuery​(Term t)
      Constructs a query for the term t.
      TermQuery​(Term t, int docFreq)
      Expert: constructs a TermQuery that will use the provided docFreq instead of looking up the docFreq against the searcher.
      TermQuery​(Term t, TermContext states)
      Expert: constructs a TermQuery that will use the provided docFreq instead of looking up the docFreq against the searcher.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Weight createWeight​(IndexSearcher searcher)
      Expert: Constructs an appropriate Weight implementation for this query.
      boolean equals​(java.lang.Object o)
      Returns true iff o is equal to this.
      void extractTerms​(java.util.Set<Term> terms)
      Expert: adds all terms occurring in this query to the terms set.
      Term getTerm()
      Returns the term of this query.
      int hashCode()
      Returns a hash code value for this object.
      java.lang.String toString​(java.lang.String field)
      Prints a user-readable version of this query.

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • TermQuery

        public TermQuery​(Term t)
        Constructs a query for the term t.

      • TermQuery

        public TermQuery​(Term t,
                 int docFreq)
        Expert: constructs a TermQuery that will use the provided docFreq instead of looking up the docFreq against the searcher.

      • TermQuery

        public TermQuery​(Term t,
                 TermContext states)
        Expert: constructs a TermQuery that will use the provided docFreq instead of looking up the docFreq against the searcher.

    • Method Detail

      • getTerm

        public Term getTerm()
        Returns the term of this query.

      • createWeight

        public Weight createWeight​(IndexSearcher searcher)
                    throws java.io.IOException
        Description copied from class: Query
        Expert: Constructs an appropriate Weight implementation for this query.

        Only implemented by primitive queries, which re-write to themselves.

        Overrides:
        createWeight in class Query
        Throws:
        java.io.IOException

      • extractTerms

        public void extractTerms​(java.util.Set<Term> terms)
        Description copied from class: Query
        Expert: adds all terms occurring in this query to the terms set. Only works if this query is in its rewritten form.
        Overrides:
        extractTerms in class Query

      • toString

        public java.lang.String toString​(java.lang.String field)
        Prints a user-readable version of this query.
        Specified by:
        toString in class Query

      • equals

        public boolean equals​(java.lang.Object o)
        Returns true iff o is equal to this.
        Overrides:
        equals in class Query

      • hashCode

        public int hashCode()
        Returns a hash code value for this object.
        Overrides:
        hashCode in class Query