org.apache.solr.search.facet

Class FacetRequest

java.lang.Object

org.apache.solr.search.facet.FacetRequest

Direct Known Subclasses:

FacetField, FacetHeatmap, FacetQuery, FacetRange

public abstract class FacetRequest
extends Object

A request to do facets/stats that might itself be composed of sub-FacetRequests. This is a cornerstone of the facet module.

See Also:

parse(SolrQueryRequest, Map)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FacetRequest.Domain
static class	FacetRequest.FacetSort Simple structure for encapsulating a sort variable and a direction
static class	FacetRequest.RefineMethod
static class	FacetRequest.SortDirection

Field Summary

Fields

Modifier and Type	Field and Description
protected FacetRequest.Domain	domain
protected Map<String,AggValueSource>	facetStats
protected boolean	processEmpty
protected Map<String,FacetRequest>	subFacets

Constructor Summary

Constructors

Constructor and Description
FacetRequest()

Method Summary

Modifier and Type	Method and Description
void	addStat(String key, AggValueSource stat)
void	addSubFacet(String key, FacetRequest facetRequest)
boolean	canProduceFromEmpty() Returns true if this facet, or any sub-facets can produce results from an empty domain.
abstract FacetMerger	createFacetMerger(Object prototype)
abstract FacetProcessor	createFacetProcessor(org.apache.solr.search.facet.FacetContext fcontext)
boolean	doRefine()
abstract Map<String,Object>	getFacetDescription()
Map<String,AggValueSource>	getFacetStats()
FacetRequest.RefineMethod	getRefineMethod() Returns null if unset
Map<String,FacetRequest>	getSubFacets()
static FacetRequest	parse(SolrQueryRequest req, Map<String,Object> params) Factory method to parse a facet request tree.
static FacetRequest	parseOneFacetReq(SolrQueryRequest req, Map<String,Object> params) Factory method to parse out a rooted facet request tree that would normally go one level below a label.
Object	process(SolrQueryRequest req, DocSet domain) Process this facet request against the given domain of docs.
boolean	returnsPartial() Returns true if this facet can return just some of the facet buckets that match all the criteria.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

facetStats

protected Map<String,AggValueSource> facetStats

subFacets

protected Map<String,FacetRequest> subFacets

processEmpty

protected boolean processEmpty

domain

protected FacetRequest.Domain domain

Constructor Detail

FacetRequest

public FacetRequest()

Method Detail

parse

public static FacetRequest parse(SolrQueryRequest req,
                                 Map<String,Object> params)

Factory method to parse a facet request tree. The outer keys are arbitrary labels and their values are facet request specifications. Will throw a SolrException if it fails to parse.

Parameters:

req - the overall request

params - a typed parameter structure (unlike SolrParams which are all string values).

parseOneFacetReq

public static FacetRequest parseOneFacetReq(SolrQueryRequest req,
                                            Map<String,Object> params)

Factory method to parse out a rooted facet request tree that would normally go one level below a label. The params must contain a "type". This is intended to be useful externally, such as by SimpleFacets.

Parameters:

req - the overall request

params - a typed parameter structure (unlike SolrParams which are all string values).

getFacetStats

public Map<String,AggValueSource> getFacetStats()

getSubFacets

public Map<String,FacetRequest> getSubFacets()

getRefineMethod

public FacetRequest.RefineMethod getRefineMethod()

Returns null if unset

doRefine

public boolean doRefine()

returnsPartial

public boolean returnsPartial()

Returns true if this facet can return just some of the facet buckets that match all the criteria. This is normally true only for facets with a limit.

canProduceFromEmpty

public boolean canProduceFromEmpty()

Returns true if this facet, or any sub-facets can produce results from an empty domain.

addStat

public void addStat(String key,
                    AggValueSource stat)

addSubFacet

public void addSubFacet(String key,
                        FacetRequest facetRequest)

toString

public String toString()

Overrides:

toString in class Object

process

public final Object process(SolrQueryRequest req,
                            DocSet domain)
                     throws IOException

Process this facet request against the given domain of docs. Note: this is currently used externally by SimpleFacets.

Throws:

IOException

createFacetProcessor

public abstract FacetProcessor createFacetProcessor(org.apache.solr.search.facet.FacetContext fcontext)

createFacetMerger

public abstract FacetMerger createFacetMerger(Object prototype)

getFacetDescription

public abstract Map<String,Object> getFacetDescription()