Class MatchNoDocsQuery


  • public class MatchNoDocsQuery
    extends Query
    A query that matches no documents.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String reason  
    • Constructor Summary

      Constructors 
      Constructor Description
      MatchNoDocsQuery()
      Default constructor
      MatchNoDocsQuery​(java.lang.String reason)
      Provides a reason explaining why this query was used
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Weight createWeight​(IndexSearcher searcher, ScoreMode scoreMode, float boost)
      Expert: Constructs an appropriate Weight implementation for this query.
      boolean equals​(java.lang.Object o)
      Override and implement query instance equivalence properly in a subclass.
      int hashCode()
      Override and implement query hash code properly in a subclass.
      java.lang.String toString​(java.lang.String field)
      Prints a query to a string, with field assumed to be the default field and omitted.
      void visit​(QueryVisitor visitor)
      Recurse through the query tree, visiting any child queries.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • reason

        private final java.lang.String reason
    • Constructor Detail

      • MatchNoDocsQuery

        public MatchNoDocsQuery()
        Default constructor
      • MatchNoDocsQuery

        public MatchNoDocsQuery​(java.lang.String reason)
        Provides a reason explaining why this query was used
    • Method Detail

      • createWeight

        public Weight createWeight​(IndexSearcher searcher,
                                   ScoreMode scoreMode,
                                   float boost)
                            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
        scoreMode - How the produced scorers will be consumed.
        boost - The boost that is propagated by the parent queries.
        Throws:
        java.io.IOException
      • visit

        public void visit​(QueryVisitor visitor)
        Description copied from class: Query
        Recurse through the query tree, visiting any child queries.
        Specified by:
        visit in class Query
        Parameters:
        visitor - a QueryVisitor to be called by each query in the tree
      • toString

        public java.lang.String toString​(java.lang.String field)
        Description copied from class: Query
        Prints a query to a string, with field assumed to be the default field and omitted.
        Specified by:
        toString in class Query
      • equals

        public boolean equals​(java.lang.Object o)
        Description copied from class: Query
        Override and implement query instance equivalence properly in a subclass. This is required so that QueryCache works properly.

        Typically a query will be equal to another only if it's an instance of the same class and its document-filtering properties are identical to those of the other instance. Utility methods are provided for certain repetitive code.

        Specified by:
        equals in class Query
        See Also:
        Query.sameClassAs(Object), Query.classHash()
      • hashCode

        public int hashCode()
        Description copied from class: Query
        Override and implement query hash code properly in a subclass. This is required so that QueryCache works properly.
        Specified by:
        hashCode in class Query
        See Also:
        Query.equals(Object)