## Uses of Class
org.apache.lucene.queries.intervals.IntervalsSource

- Packages that use IntervalsSource
  Package | Description
  --- | ---
  org.apache.lucene.queries.intervals | Intervals queries

- - ### Uses of IntervalsSource in org.apache.lucene.queries.intervals

    Subclasses of IntervalsSource in org.apache.lucene.queries.intervals
    Modifier and Type | Class and Description
    --- | ---
    `class` | `FilteredIntervalsSource` An IntervalsSource that filters the intervals from another IntervalsSource

    Fields in org.apache.lucene.queries.intervals declared as IntervalsSource
    Modifier and Type | Field and Description
    --- | ---
    `protected IntervalsSource` | FilteredIntervalsSource.`in`

    Methods in org.apache.lucene.queries.intervals that return IntervalsSource
    Modifier and Type | Method and Description
    --- | ---
    `static IntervalsSource` | Intervals.`after(IntervalsSource source, IntervalsSource reference)` Returns intervals from the source that appear after intervals from the reference
    `static IntervalsSource` | Intervals.`atLeast(int minShouldMatch, IntervalsSource... sources)` Return intervals that span combinations of intervals from `minShouldMatch` of the sources
    `static IntervalsSource` | Intervals.`before(IntervalsSource source, IntervalsSource reference)` Returns intervals from the source that appear before intervals from the reference
    `static IntervalsSource` | Intervals.`containedBy(IntervalsSource small, IntervalsSource big)` Create a contained-by `IntervalsSource` Returns intervals from the small query that appear within intervals of the big query
    `static IntervalsSource` | Intervals.`containing(IntervalsSource big, IntervalsSource small)` Create a containing `IntervalsSource` Returns intervals from the big source that contain one or more intervals from the small source
    `static IntervalsSource` | Intervals.`extend(IntervalsSource source, int before, int after)` Create an `IntervalsSource` that wraps another source, extending its intervals by a number of positions before and after.
    `static IntervalsSource` | Intervals.`fixField(String field, IntervalsSource source)` Create an `IntervalsSource` that always returns intervals from a specific field This is useful for comparing intervals across multiple fields, for example fields that have been analyzed differently, allowing you to search for stemmed terms near unstemmed terms, etc.
    `static IntervalsSource` | FilteredIntervalsSource.`maxGaps(IntervalsSource in, int maxGaps)`
    `static IntervalsSource` | Intervals.`maxgaps(int gaps, IntervalsSource subSource)` Create an `IntervalsSource` that filters a sub-source by its gaps
    `static IntervalsSource` | FilteredIntervalsSource.`maxWidth(IntervalsSource in, int maxWidth)`
    `static IntervalsSource` | Intervals.`maxwidth(int width, IntervalsSource subSource)` Create an `IntervalsSource` that filters a sub-source by the width of its intervals
    `static IntervalsSource` | Intervals.`multiterm(Automaton automaton, int maxExpansions, String pattern)` Expert: Return an `IntervalsSource` over the disjunction of all terms that's accepted by the given automaton WARNING: Setting `maxExpansions` to higher than the default value of 128 can be both slow and memory-intensive
    `static IntervalsSource` | Intervals.`multiterm(Automaton automaton, String pattern)` Expert: Return an `IntervalsSource` over the disjunction of all terms that's accepted by the given automaton
    `static IntervalsSource` | Intervals.`nonOverlapping(IntervalsSource minuend, IntervalsSource subtrahend)` Create a non-overlapping IntervalsSource Returns intervals of the minuend that do not overlap with intervals from the subtrahend
    `static IntervalsSource` | Intervals.`notContainedBy(IntervalsSource small, IntervalsSource big)` Create a not-contained-by `IntervalsSource` Returns intervals from the small `IntervalsSource` that do not appear within intervals from the big `IntervalsSource`.
    `static IntervalsSource` | Intervals.`notContaining(IntervalsSource minuend, IntervalsSource subtrahend)` Create a not-containing `IntervalsSource` Returns intervals from the minuend that do not contain intervals of the subtrahend
    `static IntervalsSource` | Intervals.`notWithin(IntervalsSource minuend, int positions, IntervalsSource subtrahend)` Create a not-within `IntervalsSource` Returns intervals of the minuend that do not appear within a set number of positions of intervals from the subtrahend query
    `static IntervalsSource` | Intervals.`or(boolean rewrite, IntervalsSource... subSources)` Return an `IntervalsSource` over the disjunction of a set of sub-sources
    `static IntervalsSource` | Intervals.`or(boolean rewrite, List<IntervalsSource> subSources)` Return an `IntervalsSource` over the disjunction of a set of sub-sources
    `static IntervalsSource` | Intervals.`or(IntervalsSource... subSources)` Return an `IntervalsSource` over the disjunction of a set of sub-sources Automatically rewrites if wrapped by an interval source that is sensitive to internal gaps
    `static IntervalsSource` | Intervals.`or(List<IntervalsSource> subSources)` Return an `IntervalsSource` over the disjunction of a set of sub-sources
    `static IntervalsSource` | Intervals.`ordered(IntervalsSource... subSources)` Create an ordered `IntervalsSource` Returns intervals in which the subsources all appear in the given order
    `static IntervalsSource` | Intervals.`overlapping(IntervalsSource source, IntervalsSource reference)` Returns intervals from a source that overlap with intervals from another source
    `static IntervalsSource` | Intervals.`phrase(IntervalsSource... subSources)` Return an `IntervalsSource` exposing intervals for a phrase consisting of a list of IntervalsSources
    `static IntervalsSource` | Intervals.`phrase(String... terms)` Return an `IntervalsSource` exposing intervals for a phrase consisting of a list of terms
    `static IntervalsSource` | Intervals.`prefix(BytesRef prefix)` Return an `IntervalsSource` over the disjunction of all terms that begin with a prefix
    `static IntervalsSource` | Intervals.`prefix(BytesRef prefix, int maxExpansions)` Expert: Return an `IntervalsSource` over the disjunction of all terms that begin with a prefix WARNING: Setting `maxExpansions` to higher than the default value of 128 can be both slow and memory-intensive
    `static IntervalsSource` | Intervals.`term(BytesRef term)` Return an `IntervalsSource` exposing intervals for a term
    `static IntervalsSource` | Intervals.`term(BytesRef term, Predicate<BytesRef> payloadFilter)` Return an `IntervalsSource` exposing intervals for a term, filtered by the value of the term's payload at each position
    `static IntervalsSource` | Intervals.`term(String term)` Return an `IntervalsSource` exposing intervals for a term
    `static IntervalsSource` | Intervals.`term(String term, Predicate<BytesRef> payloadFilter)` Return an `IntervalsSource` exposing intervals for a term, filtered by the value of the term's payload at each position
    `static IntervalsSource` | Intervals.`unordered(IntervalsSource... subSources)` Create an unordered `IntervalsSource` Returns intervals in which all the subsources appear.
    `static IntervalsSource` | Intervals.`unorderedNoOverlaps(IntervalsSource a, IntervalsSource b)` Create an unordered `IntervalsSource` allowing no overlaps between subsources Returns intervals in which both the subsources appear and do not overlap.
    `static IntervalsSource` | Intervals.`wildcard(BytesRef wildcard)` Return an `IntervalsSource` over the disjunction of all terms that match a wildcard glob
    `static IntervalsSource` | Intervals.`wildcard(BytesRef wildcard, int maxExpansions)` Expert: Return an `IntervalsSource` over the disjunction of all terms that match a wildcard glob WARNING: Setting `maxExpansions` to higher than the default value of 128 can be both slow and memory-intensive
    `static IntervalsSource` | Intervals.`within(IntervalsSource source, int positions, IntervalsSource reference)` Returns intervals of the source that appear within a set number of positions of intervals from the reference

    Methods in org.apache.lucene.queries.intervals that return types with arguments of type IntervalsSource
    Modifier and Type | Method and Description
    --- | ---
    `Collection<IntervalsSource>` | FilteredIntervalsSource.`pullUpDisjunctions()`
    `abstract Collection<IntervalsSource>` | IntervalsSource.`pullUpDisjunctions()` Expert: return the set of disjunctions that make up this IntervalsSource Most implementations can return `Collections.singleton(this)`

    Methods in org.apache.lucene.queries.intervals with parameters of type IntervalsSource
    Modifier and Type | Method and Description
    --- | ---
    `static IntervalsSource` | Intervals.`after(IntervalsSource source, IntervalsSource reference)` Returns intervals from the source that appear after intervals from the reference
    `static IntervalsSource` | Intervals.`atLeast(int minShouldMatch, IntervalsSource... sources)` Return intervals that span combinations of intervals from `minShouldMatch` of the sources
    `static IntervalsSource` | Intervals.`before(IntervalsSource source, IntervalsSource reference)` Returns intervals from the source that appear before intervals from the reference
    `static IntervalsSource` | Intervals.`containedBy(IntervalsSource small, IntervalsSource big)` Create a contained-by `IntervalsSource` Returns intervals from the small query that appear within intervals of the big query
    `static IntervalsSource` | Intervals.`containing(IntervalsSource big, IntervalsSource small)` Create a containing `IntervalsSource` Returns intervals from the big source that contain one or more intervals from the small source
    `static IntervalsSource` | Intervals.`extend(IntervalsSource source, int before, int after)` Create an `IntervalsSource` that wraps another source, extending its intervals by a number of positions before and after.
    `static IntervalsSource` | Intervals.`fixField(String field, IntervalsSource source)` Create an `IntervalsSource` that always returns intervals from a specific field This is useful for comparing intervals across multiple fields, for example fields that have been analyzed differently, allowing you to search for stemmed terms near unstemmed terms, etc.
    `static IntervalsSource` | FilteredIntervalsSource.`maxGaps(IntervalsSource in, int maxGaps)`
    `static IntervalsSource` | Intervals.`maxgaps(int gaps, IntervalsSource subSource)` Create an `IntervalsSource` that filters a sub-source by its gaps
    `static IntervalsSource` | FilteredIntervalsSource.`maxWidth(IntervalsSource in, int maxWidth)`
    `static IntervalsSource` | Intervals.`maxwidth(int width, IntervalsSource subSource)` Create an `IntervalsSource` that filters a sub-source by the width of its intervals
    `static IntervalsSource` | Intervals.`nonOverlapping(IntervalsSource minuend, IntervalsSource subtrahend)` Create a non-overlapping IntervalsSource Returns intervals of the minuend that do not overlap with intervals from the subtrahend
    `static IntervalsSource` | Intervals.`notContainedBy(IntervalsSource small, IntervalsSource big)` Create a not-contained-by `IntervalsSource` Returns intervals from the small `IntervalsSource` that do not appear within intervals from the big `IntervalsSource`.
    `static IntervalsSource` | Intervals.`notContaining(IntervalsSource minuend, IntervalsSource subtrahend)` Create a not-containing `IntervalsSource` Returns intervals from the minuend that do not contain intervals of the subtrahend
    `static IntervalsSource` | Intervals.`notWithin(IntervalsSource minuend, int positions, IntervalsSource subtrahend)` Create a not-within `IntervalsSource` Returns intervals of the minuend that do not appear within a set number of positions of intervals from the subtrahend query
    `static IntervalsSource` | Intervals.`or(boolean rewrite, IntervalsSource... subSources)` Return an `IntervalsSource` over the disjunction of a set of sub-sources
    `static IntervalsSource` | Intervals.`or(IntervalsSource... subSources)` Return an `IntervalsSource` over the disjunction of a set of sub-sources Automatically rewrites if wrapped by an interval source that is sensitive to internal gaps
    `static IntervalsSource` | Intervals.`ordered(IntervalsSource... subSources)` Create an ordered `IntervalsSource` Returns intervals in which the subsources all appear in the given order
    `static IntervalsSource` | Intervals.`overlapping(IntervalsSource source, IntervalsSource reference)` Returns intervals from a source that overlap with intervals from another source
    `static IntervalsSource` | Intervals.`phrase(IntervalsSource... subSources)` Return an `IntervalsSource` exposing intervals for a phrase consisting of a list of IntervalsSources
    `static IntervalsSource` | Intervals.`unordered(IntervalsSource... subSources)` Create an unordered `IntervalsSource` Returns intervals in which all the subsources appear.
    `static IntervalsSource` | Intervals.`unorderedNoOverlaps(IntervalsSource a, IntervalsSource b)` Create an unordered `IntervalsSource` allowing no overlaps between subsources Returns intervals in which both the subsources appear and do not overlap.
    `static IntervalsSource` | Intervals.`within(IntervalsSource source, int positions, IntervalsSource reference)` Returns intervals of the source that appear within a set number of positions of intervals from the reference

    Method parameters in org.apache.lucene.queries.intervals with type arguments of type IntervalsSource
    Modifier and Type | Method and Description
    --- | ---
    `static IntervalsSource` | Intervals.`or(boolean rewrite, List<IntervalsSource> subSources)` Return an `IntervalsSource` over the disjunction of a set of sub-sources
    `static IntervalsSource` | Intervals.`or(List<IntervalsSource> subSources)` Return an `IntervalsSource` over the disjunction of a set of sub-sources

    Constructors in org.apache.lucene.queries.intervals with parameters of type IntervalsSource
    Constructor and Description
    `FilteredIntervalsSource(String name, IntervalsSource in)` Create a new FilteredIntervalsSource
    `IntervalQuery(String field, IntervalsSource intervalsSource)` Create a new IntervalQuery
    `IntervalQuery(String field, IntervalsSource intervalsSource, float pivot)` Create a new IntervalQuery with a scoring pivot
    `IntervalQuery(String field, IntervalsSource intervalsSource, float pivot, float exp)` Create a new IntervalQuery with a scoring pivot and exponent

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