org.apache.solr.search
Class Grouping
java.lang.Object
org.apache.solr.search.Grouping
public class Grouping
- extends Object
Basic Solr Grouping infrastructure.
Warning NOT thread save!
- WARNING: This API is experimental and might change in incompatible ways in the next release.
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
mainResult
public DocList mainResult
Grouping
public Grouping(SolrIndexSearcher searcher,
SolrIndexSearcher.QueryResult qr,
SolrIndexSearcher.QueryCommand cmd,
boolean cacheSecondPassSearch,
int maxDocsPercentageToCache,
boolean main)
- Parameters:
cacheSecondPassSearch
- Whether to cache the documents and scores from the first pass search for the second
pass search.maxDocsPercentageToCache
- The maximum number of documents in a percentage relative from maxdoc
that is allowed in the cache. When this threshold is met,
the cache is not used in the second pass search.
add
public void add(Grouping.Command groupingCommand)
addFieldCommand
public void addFieldCommand(String field,
SolrQueryRequest request)
throws SyntaxError
- Adds a field command based on the specified field.
If the field is not compatible with
Grouping.CommandField
it invokes the
addFunctionCommand(String, org.apache.solr.request.SolrQueryRequest)
method.
- Parameters:
field
- The fieldname to group by.
- Throws:
SyntaxError
addFunctionCommand
public void addFunctionCommand(String groupByStr,
SolrQueryRequest request)
throws SyntaxError
- Throws:
SyntaxError
addQueryCommand
public void addQueryCommand(String groupByStr,
SolrQueryRequest request)
throws SyntaxError
- Throws:
SyntaxError
setSort
public Grouping setSort(Sort sort)
setGroupSort
public Grouping setGroupSort(Sort groupSort)
setLimitDefault
public Grouping setLimitDefault(int limitDefault)
setDocsPerGroupDefault
public Grouping setDocsPerGroupDefault(int docsPerGroupDefault)
setGroupOffsetDefault
public Grouping setGroupOffsetDefault(int groupOffsetDefault)
setDefaultFormat
public Grouping setDefaultFormat(Grouping.Format defaultFormat)
setDefaultTotalCount
public Grouping setDefaultTotalCount(Grouping.TotalCount defaultTotalCount)
setGetGroupedDocSet
public Grouping setGetGroupedDocSet(boolean getGroupedDocSet)
getCommands
public List<Grouping.Command> getCommands()
execute
public void execute()
throws IOException
- Throws:
IOException
isSignalCacheWarning
public boolean isSignalCacheWarning()
- Returns whether a cache warning should be send to the client.
The value
true
is returned when the cache is emptied because the caching limits where met, otherwise
false
is returned.
- Returns:
- whether a cache warning should be send to the client
Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.