Package org.apache.solr.search

APIs and classes for parsing and processing search requests

Interface Summary

Interface	Description
CacheRegenerator	Implementations of CacheRegenerator 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.
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 future
BitDocSet	A FixedBitSet based implementation of a DocSet.
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].
CancellableCollector	Allows a query to be cancelled
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 selected
ComplexPhraseQParserPlugin	Parse Solr's variant on the Lucene ComplexPhraseQueryParser syntax.
CpuAllowedLimit	Enforces a CPU-time based timeout on a given SolrQueryRequest, as specified by the cpuAllowed query parameter.
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 creation
DisMaxQParser	Query parser for dismax queries
DisMaxQParserPlugin	Create a dismax query from the input value.
DocListAndSet	A struct whose only purpose is to hold both a DocList and a DocSet so that both may be returned from a single method.
DocSet	An immutable ordered set of Lucene Document Ids.
DocSetBuilder	Adapted from DocIdSetBuilder to build DocSets
DocSetCollector
DocSetCollector.ExpandingIntArray
DocSetUtil
DocSlice	DocSlice implements DocList as an array of docids and optional scores.
DocValuesIteratorCache	A helper class for random-order value access over docValues (such as in the case of useDocValuesAsStored).
DocValuesIteratorCache.FieldDocValuesSupplier	Supplies (and coordinates arbitrary-order value retrieval over) docValues iterators for a particular field, encapsulating the logic of iterator creation, reuse/caching, and advancing.
EarlyTerminatingCollector	A wrapper Collector that throws EarlyTerminatingCollectorException) once a specified maximum number of documents are collected.
ExportQParserPlugin
ExportQParserPlugin.ExportQParser
ExportQParserPlugin.ExportQuery
ExtendedDismaxQParser	Query parser that generates DisjunctionMaxQueries based on user configuration.
ExtendedDismaxQParser.Clause
ExtendedDismaxQParser.ExtendedDismaxConfiguration	Simple container for configuration information used when parsing queries
ExtendedDismaxQParser.ExtendedSolrQueryParser	A subclass of SolrQueryParser that supports aliasing fields for constructing DisjunctionMaxQueries.
ExtendedDismaxQParser.ExtendedSolrQueryParser.Alias	A simple container for storing alias info
ExtendedDismaxQParserPlugin	An advanced multi-field query parser based on the DisMax parser.
ExtendedQueryBase
FieldParams	A class to hold "phrase slop" and "boost" parameters for pf, pf2, pf3 parameters
FieldQParserPlugin	Create a field query from the input value, applying text analysis and constructing a phrase query if appropriate.
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.
HashQParserPlugin	syntax fq={!hash workers=11 worker=4 keys=field1,field2}
IGainTermsQParserPlugin
JoinQParserPlugin
LegacyNumericRangeQueryBuilder	Deprecated. Index with points and use PointRangeQueryBuilder instead
LuceneQParser
LuceneQParserPlugin	Parse Solr's variant on the Lucene QueryParser syntax.
MatchCostQuery	Wraps a Query to customize the TwoPhaseIterator.matchCost().
MaxScoreCollector	A Collector 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 field
MinHashQParserPlugin	QParserPlugin based on MinHashQParser.
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.
NumericHidingLeafReader	Deprecated.
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 future
QParserPlugin
QueryCommand	A query request command to avoid having to change the method signatures if we want to pass additional information to the searcher.
QueryContext
QueryLimits	Represents the limitations on the query.
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 sort
QueryUtils
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 future
RawQParserPlugin	Create a term query from the input value without any text analysis or transformation whatsoever.
ReRankCollector
ReRankCollector.BoostedComp
ReRankQParserPlugin
ReRankScaler
ReRankScaler.MinMaxExplain
ReRankScaler.ReRankScalerExplain
ReRankWeight	A Weight used by reranking queries.
ReturnFields	A class representing the return fields
SignificantTermsQParserPlugin
SimpleQParserPlugin	Create a query from the input value that will be parsed by Lucene's SimpleQueryParser.
SolrCacheBase	Common base class of reusable functionality for SolrCaches
SolrCacheBase.AutoWarmCountRef	Decides how many things to autowarm based on the size of another cache
SolrCoreParser	Assembles a QueryBuilder which uses Query objects from Solr's search module in addition to Query objects supported by the Lucene CoreParser.
SolrDocumentFetcher	A helper class of SolrIndexSearcher for stored Document related matters including DocValue substitutions.
SolrFieldCacheBean	A SolrInfoBean that provides introspection of the Solr FieldCache
SolrIndexSearcher	SolrIndexSearcher adds schema awareness and caching functionality over IndexSearcher.
SolrIndexSearcher.DocsEnumState
SolrIndexSearcher.ProcessedFilter	INTERNAL: The response object from SolrIndexSearcher.getProcessedFilter(DocSet, List).
SolrQueryBuilder
SolrQueryParser	Solr's default query parser, a schema-driven superset of the classic lucene query parser.
SolrReturnFields	The default implementation of return fields parsing for Solr.
SolrSpanQueryBuilder
SortedIntDocSet	A simple sorted int[] array implementation of DocSet, good for small sets.
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 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
TimeAllowedLimit	Enforces a wall clock based timeout on a given SolrQueryRequest.
TopLevelJoinQuery	JoinQuery implementation using global (top-level) DocValues ordinals to efficiently compare values in the "from" and "to" fields.
TopLevelJoinQuery.BitsetBounds
ValueSourceParser	A factory that parses user queries to generate ValueSource instances.
VectorSimilaritySourceParser	This class provides implementation for two variants for parsing function query vectorSimilarity which is used to calculate the similarity between two vectors.
WrappedQuery	A simple query that wraps another query and implements ExtendedQuery.
XmlQParserPlugin	The XmlQParserPlugin extends the QParserPlugin and supports the creation of queries from XML.

Enum Summary

Enum	Description
CollapsingQParserPlugin.GroupHeadSelectorType
CollapsingQParserPlugin.NullPolicy
Grouping.Format
Grouping.TotalCount
ReRankOperator
SolrCache.State	Enumeration of possible States for cache instances.
SolrReturnFields.FIELD_SOURCES

Exception Summary

Exception	Description
CancellableCollector.QueryCancelledException	Thrown when a query gets cancelled
EarlyTerminatingCollectorException	Thrown by EarlyTerminatingCollector when the maximum to abort the scoring / collection process early, when the specified maximum number of documents were collected.
IncompleteRerankingException
QueryLimitsExceededException
SolrIndexSearcher.LimitExceededFromScorerException	Thrown when CommonParams.TIME_ALLOWED is exceeded.
SyntaxError	Simple checked exception for parsing errors