Uses of Class
org.apache.lucene.search.spans.SpanQuery

Packages that use SpanQuery

Package	Description
org.apache.lucene.payloads	Experimental classes for interacting with payloads
org.apache.lucene.queries.payloads	The payloads package provides Query mechanisms for finding and using payloads.
org.apache.lucene.queryparser.complexPhrase	QueryParser which permits complex phrase query syntax eg "(john jon jonathan~) peters*"
org.apache.lucene.queryparser.surround.query	This package contains SrndQuery and its subclasses.
org.apache.lucene.queryparser.xml	Parser that produces Lucene Query objects from XML streams.
org.apache.lucene.queryparser.xml.builders	XML Parser factories for different Lucene Query/Filters.
org.apache.lucene.search.highlight	Highlighting search terms.
org.apache.lucene.search.spans	The calculus of spans.
org.apache.lucene.search.uhighlight	The UnifiedHighlighter -- a flexible highlighter that can get offsets from postings, term vectors, or analysis.
org.apache.lucene.util	Some utility classes.

Uses of SpanQuery in org.apache.lucene.payloads

Methods in org.apache.lucene.payloads with parameters of type SpanQuery

Modifier and Type	Method	Description
private void	PayloadSpanUtil.getPayloads(Collection<byte[]> payloads, SpanQuery query)

Uses of SpanQuery in org.apache.lucene.queries.payloads

Subclasses of SpanQuery in org.apache.lucene.queries.payloads

Modifier and Type	Class	Description
class	PayloadScoreQuery	A Query class that uses a PayloadFunction to modify the score of a wrapped SpanQuery
class	SpanPayloadCheckQuery	Only return those matches that have a specific payload at the given position.

Fields in org.apache.lucene.queries.payloads declared as SpanQuery

Modifier and Type	Field	Description
protected final SpanQuery	SpanPayloadCheckQuery.match
private final SpanQuery	PayloadScoreQuery.wrappedQuery

Constructors in org.apache.lucene.queries.payloads with parameters of type SpanQuery

Modifier	Constructor	Description
	PayloadScoreQuery(SpanQuery wrappedQuery, PayloadFunction function, PayloadDecoder decoder)	Creates a new PayloadScoreQuery that includes the underlying span scores
	PayloadScoreQuery(SpanQuery wrappedQuery, PayloadFunction function, PayloadDecoder decoder, boolean includeSpanScore)	Creates a new PayloadScoreQuery
	SpanPayloadCheckQuery(SpanQuery match, List<BytesRef> payloadToMatch)

Uses of SpanQuery in org.apache.lucene.queryparser.complexPhrase

Method parameters in org.apache.lucene.queryparser.complexPhrase with type arguments of type SpanQuery

Modifier and Type	Method	Description
private void	ComplexPhraseQueryParser.ComplexPhraseQuery.addComplexPhraseClause(List<SpanQuery> spanClauses, BooleanQuery qc)

Uses of SpanQuery in org.apache.lucene.queryparser.surround.query

Fields in org.apache.lucene.queryparser.surround.query with type parameters of type SpanQuery

Modifier and Type	Field	Description
private HashMap<SpanQuery,Float>	SpanNearClauseFactory.weightBySpanQuery

Methods in org.apache.lucene.queryparser.surround.query that return SpanQuery

Modifier and Type	Method	Description
SpanQuery	SpanNearClauseFactory.makeSpanClause()

Methods in org.apache.lucene.queryparser.surround.query with parameters of type SpanQuery

Modifier and Type	Method	Description
protected void	SpanNearClauseFactory.addSpanQueryWeighted(SpanQuery sq, float weight)

Uses of SpanQuery in org.apache.lucene.queryparser.xml

Methods in org.apache.lucene.queryparser.xml that return SpanQuery

Modifier and Type	Method	Description
SpanQuery	CoreParser.getSpanQuery(Element e)
(package private) SpanQuery	CoreParser.parseAsSpanQuery(InputStream xmlStream)

Uses of SpanQuery in org.apache.lucene.queryparser.xml.builders

Methods in org.apache.lucene.queryparser.xml.builders that return SpanQuery

Modifier and Type	Method	Description
SpanQuery	BoostingTermBuilder.getSpanQuery(Element e)
SpanQuery	SpanFirstBuilder.getSpanQuery(Element e)
SpanQuery	SpanNearBuilder.getSpanQuery(Element e)
SpanQuery	SpanNotBuilder.getSpanQuery(Element e)
SpanQuery	SpanOrBuilder.getSpanQuery(Element e)
SpanQuery	SpanOrTermsBuilder.getSpanQuery(Element e)
SpanQuery	SpanPositionRangeBuilder.getSpanQuery(Element e)
SpanQuery	SpanQueryBuilder.getSpanQuery(Element e)
SpanQuery	SpanQueryBuilderFactory.getSpanQuery(Element e)
SpanQuery	SpanTermBuilder.getSpanQuery(Element e)

Uses of SpanQuery in org.apache.lucene.search.highlight

Methods in org.apache.lucene.search.highlight with parameters of type SpanQuery

Modifier and Type	Method	Description
protected void	WeightedSpanTermExtractor.collectSpanQueryFields(SpanQuery spanQuery, Set<String> fieldNames)
protected void	WeightedSpanTermExtractor.extractWeightedSpanTerms(Map<String,WeightedSpanTerm> terms, SpanQuery spanQuery, float boost)	Fills a Map with WeightedSpanTerms using the terms from the supplied SpanQuery.
protected boolean	WeightedSpanTermExtractor.mustRewriteQuery(SpanQuery spanQuery)

Uses of SpanQuery in org.apache.lucene.search.spans

Subclasses of SpanQuery in org.apache.lucene.search.spans

Modifier and Type	Class	Description
final class	FieldMaskingSpanQuery	Wrapper to allow SpanQuery objects participate in composite single-field SpanQueries by 'lying' about their search field.
final class	SpanBoostQuery	Counterpart of BoostQuery for spans.
final class	SpanContainingQuery	Keep matches that contain another SpanScorer.
(package private) class	SpanContainQuery
class	SpanFirstQuery	Matches spans near the beginning of a field.
class	SpanMultiTermQueryWrapper<Q extends MultiTermQuery>	Wraps any MultiTermQuery as a SpanQuery, so it can be nested within other SpanQuery classes.
class	SpanNearQuery	Matches spans which are near one another.
private static class	SpanNearQuery.SpanGapQuery
final class	SpanNotQuery	Removes matches which overlap with another SpanQuery or which are within x tokens before or y tokens after another SpanQuery.
final class	SpanOrQuery	Matches the union of its clauses.
class	SpanPositionCheckQuery	Base class for filtering a SpanQuery based on the position of a match.
class	SpanPositionRangeQuery	Checks to see if the SpanPositionCheckQuery.getMatch() lies between a start and end position See SpanFirstQuery for a derivation that is optimized for the case where start position is 0.
class	SpanTermQuery	Matches spans containing a term.
final class	SpanWithinQuery	Keep matches that are contained within another Spans.

Fields in org.apache.lucene.search.spans declared as SpanQuery

Modifier and Type	Field	Description
(package private) SpanQuery	SpanContainQuery.big
private SpanQuery	SpanNotQuery.exclude
private SpanQuery	SpanNotQuery.include
(package private) SpanQuery	SpanContainQuery.little
private final SpanQuery	FieldMaskingSpanQuery.maskedQuery
protected SpanQuery	SpanPositionCheckQuery.match
private final SpanQuery	SpanBoostQuery.query

Fields in org.apache.lucene.search.spans with type parameters of type SpanQuery

Modifier and Type	Field	Description
private final List<SpanQuery>	SpanNearQuery.Builder.clauses
protected List<SpanQuery>	SpanNearQuery.clauses
private List<SpanQuery>	SpanOrQuery.clauses
private final TopTermsRewrite<List<SpanQuery>>	SpanMultiTermQueryWrapper.TopTermsSpanBooleanQueryRewrite.delegate

Methods in org.apache.lucene.search.spans that return SpanQuery

Modifier and Type	Method	Description
SpanQuery	SpanContainQuery.getBig()
SpanQuery[]	SpanNearQuery.getClauses()	Return the clauses whose spans are matched.
SpanQuery[]	SpanOrQuery.getClauses()	Return the clauses whose spans are matched.
SpanQuery	SpanNotQuery.getExclude()	Return the SpanQuery whose matches must not overlap those returned.
SpanQuery	SpanNotQuery.getInclude()	Return the SpanQuery whose matches are filtered.
SpanQuery	SpanContainQuery.getLittle()
SpanQuery	FieldMaskingSpanQuery.getMaskedQuery()
SpanQuery	SpanPositionCheckQuery.getMatch()
SpanQuery	SpanBoostQuery.getQuery()	Return the wrapped SpanQuery.
abstract SpanQuery	SpanMultiTermQueryWrapper.SpanRewriteMethod.rewrite(IndexReader reader, MultiTermQuery query)
SpanQuery	SpanMultiTermQueryWrapper.TopTermsSpanBooleanQueryRewrite.rewrite(IndexReader reader, MultiTermQuery query)

Methods in org.apache.lucene.search.spans with parameters of type SpanQuery

Modifier and Type	Method	Description
SpanNearQuery.Builder	SpanNearQuery.Builder.addClause(SpanQuery clause)	Add a new clause
private final void	SpanOrQuery.addClause(SpanQuery clause)	Adds a clause to this query
private Similarity.SimScorer	SpanWeight.buildSimWeight(SpanQuery query, IndexSearcher searcher, Map<Term,TermStates> termStates, float boost)

Constructors in org.apache.lucene.search.spans with parameters of type SpanQuery

Modifier	Constructor	Description
	FieldMaskingSpanQuery(SpanQuery maskedQuery, String maskedField)
	SpanBoostQuery(SpanQuery query, float boost)	Sole constructor: wrap query in such a way that the produced scores will be boosted by boost.
	SpanContainingQuery(SpanQuery big, SpanQuery little)	Construct a SpanContainingQuery matching spans from big that contain at least one spans from little.
(package private)	SpanContainQuery(SpanQuery big, SpanQuery little)
	SpanFirstQuery(SpanQuery match, int end)	Construct a SpanFirstQuery matching spans in match whose end position is less than or equal to end.
	SpanNearQuery(SpanQuery[] clausesIn, int slop, boolean inOrder)	Construct a SpanNearQuery.
	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.
	SpanOrQuery(SpanQuery... clauses)	Construct a SpanOrQuery merging the provided clauses.
	SpanPositionCheckQuery(SpanQuery match)
	SpanPositionRangeQuery(SpanQuery match, int start, int end)
	SpanWeight(SpanQuery query, IndexSearcher searcher, Map<Term,TermStates> termStates, float boost)	Create a new SpanWeight
	SpanWithinQuery(SpanQuery big, SpanQuery little)	Construct a SpanWithinQuery matching spans from little that are inside of big.

Uses of SpanQuery in org.apache.lucene.search.uhighlight

Fields in org.apache.lucene.search.uhighlight with type parameters of type SpanQuery

Modifier and Type	Field	Description
private final Set<SpanQuery>	PhraseHelper.spanQueries

Methods in org.apache.lucene.search.uhighlight that return types with arguments of type SpanQuery

Modifier and Type	Method	Description
Set<SpanQuery>	PhraseHelper.getSpanQueries()

Methods in org.apache.lucene.search.uhighlight with parameters of type SpanQuery

Modifier and Type	Method	Description
protected Boolean	UnifiedHighlighter.requiresRewrite(SpanQuery spanQuery)	When highlighting phrases accurately, we need to know which SpanQuery's need to have Query.rewrite(IndexReader) called on them.

Constructor parameters in org.apache.lucene.search.uhighlight with type arguments of type SpanQuery

Modifier	Constructor	Description
	PhraseHelper(Query query, String field, Predicate<String> fieldMatcher, Function<SpanQuery,Boolean> rewriteQueryPred, Function<Query,Collection<Query>> preExtractRewriteFunction, boolean ignoreQueriesNeedingRewrite)	Constructor.

Uses of SpanQuery in org.apache.lucene.util

Methods in org.apache.lucene.util that return SpanQuery

Modifier and Type	Method	Description
protected SpanQuery	QueryBuilder.createSpanQuery(TokenStream in, String field)	Creates a span query from the tokenstream.