Class SpanNotQuery


  • public final class SpanNotQuery
    extends SpanQuery
    Removes matches which overlap with another SpanQuery or which are within x tokens before or y tokens after another SpanQuery.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      class  SpanNotQuery.SpanNotWeight
      Creates SpanNotQuery scorer instances
    • Constructor Summary

      Constructors 
      Constructor Description
      SpanNotQuery​(SpanQuery include, SpanQuery exclude)
      Construct a SpanNotQuery matching spans from include which have no overlap with spans from exclude.
      SpanNotQuery​(SpanQuery include, SpanQuery exclude, int dist)
      Construct a SpanNotQuery matching spans from include which have no overlap with spans from exclude within dist tokens of include.
      SpanNotQuery​(SpanQuery include, SpanQuery exclude, int pre, int post)
      Construct a SpanNotQuery matching spans from include which have no overlap with spans from exclude within pre tokens before or post tokens of include.
    • Field Detail

      • pre

        private final int pre
      • post

        private final int post
    • Constructor Detail

      • SpanNotQuery

        public SpanNotQuery​(SpanQuery include,
                            SpanQuery exclude)
        Construct a SpanNotQuery matching spans from include which have no overlap with spans from exclude.
      • SpanNotQuery

        public SpanNotQuery​(SpanQuery include,
                            SpanQuery exclude,
                            int dist)
        Construct a SpanNotQuery matching spans from include which have no overlap with spans from exclude within dist tokens of include. Inversely, a negative dist value may be used to specify a certain amount of allowable overlap.
      • SpanNotQuery

        public SpanNotQuery​(SpanQuery include,
                            SpanQuery exclude,
                            int pre,
                            int post)
        Construct a SpanNotQuery matching spans from include which have no overlap with spans from exclude within pre tokens before or post tokens of include. Inversely, negative values for pre and/or post allow a certain amount of overlap to occur.
    • Method Detail

      • getInclude

        public SpanQuery getInclude()
        Return the SpanQuery whose matches are filtered.
      • getExclude

        public SpanQuery getExclude()
        Return the SpanQuery whose matches must not overlap those returned.
      • getField

        public java.lang.String getField()
        Description copied from class: SpanQuery
        Returns the name of the field matched by this query.
        Specified by:
        getField in class SpanQuery
      • 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
      • createWeight

        public SpanWeight 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.

        Specified by:
        createWeight in class SpanQuery
        scoreMode - How the produced scorers will be consumed.
        boost - The boost that is propagated by the parent queries.
        Throws:
        java.io.IOException
      • rewrite

        public Query rewrite​(IndexSearcher indexSearcher)
                      throws java.io.IOException
        Description copied from class: Query
        Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.

        Callers are expected to call rewrite multiple times if necessary, until the rewritten query is the same as the original query.

        The rewrite process may be able to make use of IndexSearcher's executor and be executed in parallel if the executor is provided.

        However, if any of the intermediary queries do not satisfy the new API, parallel rewrite is not possible for any subsequent sub-queries. To take advantage of this API, the entire query tree must override this method.

        Overrides:
        rewrite in class Query
        Throws:
        java.io.IOException
        See Also:
        IndexSearcher.rewrite(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
      • equalsTo

        private boolean equalsTo​(SpanNotQuery other)
      • 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)