Package org.apache.solr.search
APIs and classes for parsing and processing search requests
-
Interface Summary Interface Description CacheRegenerator Implementations ofCacheRegenerator
are used in autowarming to populate a new cache based on an old cache.DocIterator Simple Iterator of document Ids which may include score information.DocList DocList
represents the result of a query: an ordered list of document ids with optional score.DocSet DocSet
represents an unordered set of Lucene Document Ids.DocSetProducer ExtendedQuery The ExtendedQuery interface provides extra metadata to a query.PostFilter The PostFilter interface provides a mechanism to further filter documents after they have already gone through the main query and other filters.SolrCache<K,V> Primary API for dealing with Solr's internal caches. -
Class Summary Class Description AbstractReRankQuery AnalyticsQuery Note: This API is experimental and may change in non backward-compatible ways in the futureBitDocSet BitDocSet
represents an unordered set of Lucene Document Ids using a BitSet.BitsFilteredDocIdSet This implementation supplies a filtered DocIdSet, that excludes all docids which are not in a Bits instance.BitsFilteredPostingsEnum BoolQParserPlugin Create a boolean query from sub queries.BoostQParserPlugin Create a boosted query from the input value.CacheConfig Contains the knowledge of how cache config is stored in the solrconfig.xml file, and implements a factory to create caches.CaffeineCache<K,V> A SolrCache backed by the Caffeine caching library [1].CollapsingQParserPlugin The CollapsingQParserPlugin is a PostFilter that performs field collapsing.CollapsingQParserPlugin.CollapseScore CollapsingQParserPlugin.CollapsingPostFilter CollapsingQParserPlugin.GroupHeadSelector Models all the information about how group head documents should be selectedComplexPhraseQParserPlugin Parse Solr's variant on the LuceneComplexPhraseQueryParser
syntax.CursorMark An object that encapsulates the basic information about the current Mark Point of a "Cursor" based request.DelegatingCollector A simple delegating collector where one can set the delegate after creationDisMaxQParser Query parser for dismax queriesDisMaxQParserPlugin Create a dismax query from the input value.DocListAndSet DocSetBuilder Adapted from DocIdSetBuilder to build DocSetsDocSetCollector DocSetCollector.ExpandingIntArray DocSetUtil DocSlice DocSlice
implements DocList as an array of docids and optional scores.EarlyTerminatingCollector A wrapperCollector
that throwsEarlyTerminatingCollectorException
) once a specified maximum number of documents are collected.ExportQParserPlugin ExtendedDismaxQParser Query parser that generates DisjunctionMaxQueries based on user configuration.ExtendedDismaxQParser.Clause ExtendedDismaxQParser.ExtendedDismaxConfiguration Simple container for configuration information used when parsing queriesExtendedDismaxQParser.ExtendedSolrQueryParser A subclass of SolrQueryParser that supports aliasing fields for constructing DisjunctionMaxQueries.ExtendedDismaxQParser.ExtendedSolrQueryParser.Alias A simple container for storing alias infoExtendedDismaxQParserPlugin An advanced multi-field query parser based on the DisMax parser.ExtendedQueryBase FastLRUCache<K,V> Deprecated. This cache implementation is deprecated and will be removed in Solr 9.0.FieldParams A class to hold "phrase slop" and "boost" parameters for pf, pf2, pf3 parametersFieldQParserPlugin Create a field query from the input value, applying text analysis and constructing a phrase query if appropriate.Filter Convenient base class for building queries that only perform matching, but no scoring.FilteredDocIdSet Abstract decorator class for a DocIdSet implementation that provides on-demand filtering/validation mechanism on a given DocIdSet.FloatPayloadValueSource FunctionQParser FunctionQParserPlugin Create a function query from the input value.FunctionRangeQParserPlugin Create a range query over a function.FunctionRangeQuery GraphTermsQParserPlugin The GraphTermsQuery builds a disjunction query from a list of terms.Grouping Basic Solr Grouping infrastructure.HashDocSet Deprecated. HashQParserPlugin syntax fq={!hash workers=11 worker=4 keys=field1,field2}IGainTermsQParserPlugin Insanity Deprecated. JoinQParserPlugin LegacyNumericRangeQueryBuilder Deprecated. Index with points and usePointRangeQueryBuilder
insteadLFUCache<K,V> Deprecated. This cache implementation is deprecated and will be removed in Solr 9.0.LRUCache<K,V> Deprecated. This cache implementation is deprecated and will be removed in Solr 9.0.LRUCache.CacheValue<V> LuceneQParser LuceneQParserPlugin Parse Solr's variant on the Lucene QueryParser syntax.MaxScoreCollector ACollector
for the maximum score value.MaxScoreQParser MaxScoreQParserPlugin Parses a query like Lucene query parser, but scoring with max score, not sum
Accepts the "tie" request parameter as with dismax.MinHashQParser The query parser can be used in two modes 1) where text is analysed and generates min hashes as part of normal lucene analysis 2) where text is pre-analysed and hashes are added as string to the index An analyzer can still be defined to support text based query against the text fieldMinHashQParserPlugin QParserPlugin
based onMinHashQParser
.NestedQParserPlugin Create a nested query, with the ability of that query to redefine its type via local parameters.NoOpRegenerator Cache regenerator that just populates the new cache with the old items.PayloadCheckQParserPlugin PayloadScoreQParserPlugin Creates a PayloadScoreQuery wrapping a SpanQuery created from the input value, applying text analysis and constructing SpanTermQuery or SpanNearQuery based on number of terms.PointMerger Merge multiple numeric point fields (segments) together.PointMerger.ValueIterator PrefixQParserPlugin Create a prefix query from the input value.QParser Note: This API is experimental and may change in non backward-compatible ways in the futureQParserPlugin QueryCommand A query request command to avoid having to change the method signatures if we want to pass additional information to the searcher.QueryContext QueryParsing Collection of static utilities useful for query parsing.QueryResult The result of a search.QueryResultKey A hash key encapsulating a query, a list of filters, and a sortQueryUtils RankQParserPlugin RankQParserPlugin
can be used to introduce document-depending scoring factors to ranking.RankQParserPlugin.RankQParser RankQuery Note: This API is experimental and may change in non backward-compatible ways in the futureRawQParserPlugin Create a term query from the input value without any text analysis or transformation whatsoever.ReRankCollector ReRankCollector.BoostedComp ReRankQParserPlugin ReRankWeight AWeight
used by reranking queries.ReturnFields A class representing the return fieldsSignificantTermsQParserPlugin SimpleQParserPlugin Create a query from the input value that will be parsed by Lucene's SimpleQueryParser.SolrCacheBase Common base class of reusable functionality for SolrCachesSolrCacheBase.AutoWarmCountRef Decides how many things to autowarm based on the size of another cacheSolrConstantScoreQuery A query that wraps a filter and simply returns a constant score equal to the query boost for every document in the filter.SolrCoreParser Assembles a QueryBuilder which uses Query objects from Solr'ssearch
module in addition to Query objects supported by the LuceneCoreParser
.SolrDocumentFetcher A helper class ofSolrIndexSearcher
for stored Document related matters including DocValue substitutions.SolrFieldCacheBean A SolrInfoBean that provides introspection of the Solr FieldCacheSolrFilter A SolrFilter extends the Lucene Filter and adds extra semantics such as passing on weight context info for function queries.SolrIndexSearcher SolrIndexSearcher adds schema awareness and caching functionality overIndexSearcher
.SolrIndexSearcher.DocsEnumState SolrIndexSearcher.ProcessedFilter INTERNAL: The response object fromSolrIndexSearcher.getProcessedFilter(DocSet, List)
.SolrQueryBuilder SolrQueryParser Solr's default query parser, a schema-driven superset of the classic lucene query parser.SolrQueryTimeoutImpl Implementation ofQueryTimeout
that is used by Solr.SolrReturnFields The default implementation of return fields parsing for Solr.SolrSpanQueryBuilder SortedIntDocSet SortedIntDocSet
represents a sorted set of Lucene Document Ids.Sorting Deprecated. customFieldType
s should use the helper methods in the base class.SortSpec SortSpec encapsulates a Lucene Sort and a count of the number of documents to return.SortSpecParsing SpatialBoxQParserPlugin SpatialFilterQParser SpatialFilterQParserPlugin Creates a spatial Filter based on the type of spatial point used.SpatialOptions StrParser Simple class to help with parsing a string.SurroundQParserPlugin Plugin for lucene/contrib Surround query parser, bringing SpanQuery support to Solr.SwitchQParserPlugin A QParserPlugin that acts like a "switch/case" statement.TermQParserPlugin Create a single term query from the input value equivalent to readableToIndexed().TermsQParserPlugin Finds documents whose specified field has any of the specified values.TextLogisticRegressionQParserPlugin Returns an AnalyticsQuery implementation that performs one Gradient Descent iteration of a result set to train a logistic regression model The TextLogitStream provides the parallel iterative framework for this class.TopLevelJoinQuery JoinQuery
implementation using global (top-level) DocValues ordinals to efficiently compare values in the "from" and "to" fields.ValueSourceParser A factory that parses user queries to generate ValueSource instances.WrappedQuery A simple query that wraps another query and implements ExtendedQuery.XmlQParserPlugin TheXmlQParserPlugin
extends theQParserPlugin
and supports the creation of queries from XML. -
Enum Summary Enum Description CollapsingQParserPlugin.GroupHeadSelectorType Grouping.Format Grouping.TotalCount SolrCache.State Enumeration of possible States for cache instances.SolrReturnFields.FIELD_SOURCES -
Exception Summary Exception Description EarlyTerminatingCollectorException Thrown byEarlyTerminatingCollector
when the maximum to abort the scoring / collection process early, when the specified maximum number of documents were collected.SyntaxError Simple checked exception for parsing errors