org.elasticsearch.search.facet.query

Class QueryFacetBuilder

java.lang.Object

org.elasticsearch.search.facet.FacetBuilder

org.elasticsearch.search.facet.query.QueryFacetBuilder

All Implemented Interfaces:

ToXContent

public class QueryFacetBuilder
extends FacetBuilder

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.facet.FacetBuilder

FacetBuilder.Mode

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.search.facet.FacetBuilder

facetFilter, global, mode, name, nested

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
QueryFacetBuilder(String name)

Method Summary

Modifier and Type	Method and Description
QueryFacetBuilder	facetFilter(FilterBuilder filter)
QueryFacetBuilder	global(boolean global) Marks the facet to run in a global scope, not bounded by any query.
QueryFacetBuilder	nested(String nested) Sets the nested path the facet will execute on.
QueryFacetBuilder	query(QueryBuilder query)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class org.elasticsearch.search.facet.FacetBuilder

addFilterFacetAndGlobal, mode

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryFacetBuilder

public QueryFacetBuilder(String name)

Method Detail

global

public QueryFacetBuilder global(boolean global)

Marks the facet to run in a global scope, not bounded by any query.

Overrides:

global in class FacetBuilder

facetFilter

public QueryFacetBuilder facetFilter(FilterBuilder filter)

Overrides:

facetFilter in class FacetBuilder

nested

public QueryFacetBuilder nested(String nested)

Sets the nested path the facet will execute on. A match (root object) will then cause all the nested objects matching the path to be computed into the facet.

Overrides:

nested in class FacetBuilder

query

public QueryFacetBuilder query(QueryBuilder query)

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Throws:

IOException