org.elasticsearch.search.facet.filter
Class FilterFacetBuilder

java.lang.Object
  org.elasticsearch.search.facet.AbstractFacetBuilder
      org.elasticsearch.search.facet.filter.FilterFacetBuilder

All Implemented Interfaces:

ToXContent

public class FilterFacetBuilder
extends AbstractFacetBuilder

Nested Class Summary

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

ToXContent.MapParams, ToXContent.Params

Field Summary

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

facetFilter, name, nested, scope

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

EMPTY_PARAMS

Constructor Summary

FilterFacetBuilder(String name)

Method Summary

FilterFacetBuilder	facetFilter(FilterBuilder filter)
FilterFacetBuilder	filter(FilterBuilder filter)
FilterFacetBuilder	global(boolean global) Marks the facet to run in a global scope, not bounded by any query.
FilterFacetBuilder	nested(String nested) Sets the nested path the facet will execute on.
FilterFacetBuilder	scope(String scope) Marks the facet to run in a specific scope.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

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

addFilterFacetAndGlobal

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterFacetBuilder

public FilterFacetBuilder(String name)

Method Detail

global

public FilterFacetBuilder global(boolean global)

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

Overrides:

global in class AbstractFacetBuilder

scope

public FilterFacetBuilder scope(String scope)

Marks the facet to run in a specific scope.

Overrides:

scope in class AbstractFacetBuilder

facetFilter

public FilterFacetBuilder facetFilter(FilterBuilder filter)

Overrides:

facetFilter in class AbstractFacetBuilder

nested

public FilterFacetBuilder 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 AbstractFacetBuilder

filter

public FilterFacetBuilder filter(FilterBuilder filter)

toXContent

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

Throws:

IOException