# Package org.apache.solr.search

APIs and classes for parsing and processing search requests

See: Description

- 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.
  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.
  ScoreFilter |
  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 | `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 |
  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.
  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.
  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.
  DocSetBuilder | Adapted from DocIdSetBuilder to build DocSets
  DocSetCollector |
  DocSetCollector.ExpandingIntArray |
  DocSetUtil |
  DocSlice | `DocSlice` implements DocList as an array of docids and optional scores.
  EarlyTerminatingCollector | A wrapper `Collector` that throws `EarlyTerminatingCollectorException`) once a specified maximum number of documents are collected.
  ExportQParserPlugin |
  ExtendedDismaxQParser | Query parser that generates DisjunctionMaxQueries based on user configuration.
  ExtendedDismaxQParser.Clause |
  ExtendedDismaxQParser.ExtendedSolrQueryParser | A subclass of SolrQueryParser that supports aliasing fields for constructing DisjunctionMaxQueries.
  ExtendedDismaxQParserPlugin | An advanced multi-field query parser based on the DisMax parser.
  ExtendedQueryBase |
  FastLRUCache<K,V> | SolrCache based on ConcurrentLRUCache implementation.
  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.
  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.
  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 | `HashDocSet` represents an unordered set of Lucene Document Ids using a primitive int hash table.
  HashQParserPlugin | syntax fq={!hash workers=11 worker=4 keys=field1,field2}
  IGainTermsQParserPlugin |
  Insanity | Deprecated
  JoinQParserPlugin |
  LFUCache<K,V> | SolrCache based on ConcurrentLFUCache implementation.
  LRUCache<K,V> |
  LuceneQParser |
  LuceneQParserPlugin | Parse Solr's variant on the Lucene QueryParser syntax.
  MaxScoreQParser |
  MaxScoreQParserPlugin | Parses a query like Lucene query parser, but scoring with max score, not sum Accepts the "tie" request parameter as with dismax.
  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.
  OldLuceneQParserPlugin | Parse Solr's variant of Lucene QueryParser syntax, including the deprecated sort specification after the query.
  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 |
  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 |
  QueryWrapperFilter | Constrains search results to only match those which also match a provided query.
  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 |
  ReRankQParserPlugin |
  ReRankWeight | A `Weight` used by reranking queries.
  ReturnFields | A class representing the return fields
  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
  SolrConstantScoreQuery | 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's `search` module in addition to Query objects supported by the Lucene `CoreParser`.
  SolrFieldCacheMBean | A SolrInfoMBean that provides introspection of the Solr FieldCache
  SolrFilter | 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 over `IndexSearcher`.
  SolrIndexSearcher.DocsEnumState |
  SolrIndexSearcher.ProcessedFilter |
  SolrQueryBuilder |
  SolrQueryParser | Solr's default query parser, a schema-driven superset of the classic lucene query parser.
  SolrQueryTimeoutImpl | Implementation of `QueryTimeout` that is used by Solr.
  SolrReturnFields | The default implementation of return fields parsing for Solr.
  SortedIntDocSet | `SortedIntDocSet` represents a sorted set of Lucene Document Ids.
  Sorting | Extra lucene sorting utilities & convenience methods
  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.
  ValueSourceParser | A factory that parses user queries to generate ValueSource instances.
  WrappedQuery | A simple query that wraps another query and implements ExtendedQuery.
  XmlQParserPlugin |

- Enum Summary
  Enum | Description
  --- | ---
  CollapsingQParserPlugin.GroupHeadSelectorType |
  Grouping.Format |
  Grouping.TotalCount |
  SolrCache.State | Enumeration of possible States for cache instances.

- Exception Summary
  Exception | Description
  --- | ---
  EarlyTerminatingCollectorException | Thrown by `EarlyTerminatingCollector` 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

## Package org.apache.solr.search Description

APIs and classes for parsing and processing search requests

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