Class FunctionMatchQuery


  • public final class FunctionMatchQuery
    extends Query
    A query that retrieves all documents with a DoubleValues value matching a predicate

    This query works by a linear scan of the index, and is best used in conjunction with other queries that can restrict the number of documents visited

    • Field Detail

      • filter

        private final java.util.function.DoublePredicate filter
      • matchCost

        private final float matchCost
    • Constructor Detail

      • FunctionMatchQuery

        public FunctionMatchQuery​(DoubleValuesSource source,
                                  java.util.function.DoublePredicate filter)
        Create a FunctionMatchQuery with default TwoPhaseIterator matchCost - DEFAULT_MATCH_COST = 100.0f
        Parameters:
        source - a DoubleValuesSource to use for values
        filter - the predicate to match against
      • FunctionMatchQuery

        public FunctionMatchQuery​(DoubleValuesSource source,
                                  java.util.function.DoublePredicate filter,
                                  float matchCost)
        Create a FunctionMatchQuery
        Parameters:
        source - a DoubleValuesSource to use for values
        filter - the predicate to match against
        matchCost - to be returned by TwoPhaseIterator.matchCost()
    • Method Detail

      • 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
      • 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
      • 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
      • 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 that 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)