C# Class Rubber.DSL.Facet.HistogramFacetBuilder

A facet builder of histogram facets.

Inheritance: AbstractFacetBuilder

Datei anzeigen Open project: stephenpope/Rubber

Public Methods

Method	Description
Bounds ( object from, object to ) : HistogramFacetBuilder	Sets the bounds from and to for the facet. Both performs bounds check and includes only values within the bounds, and improves performance.
Comparator ( HistogramComparatorType comparatorType ) : HistogramFacetBuilder
FacetFilter ( IFilterBuilder filter ) : HistogramFacetBuilder	An additional filter used to further filter down the set of documents the facet will run on.
Field ( string field ) : HistogramFacetBuilder	The field name to perform the histogram facet. Translates to perform the histogram facet using the provided field as both the {@link #keyField(string)} and {@link #valueField(string)}.
Global ( bool global ) : HistogramFacetBuilder	Should the facet run in global mode (not bounded by the search query) or not (bounded by the search query). Defaults to `false`.
HistogramFacetBuilder ( string name ) : System	Constructs a new histogram facet with the provided facet logical name.
Interval ( System.TimeSpan span ) : HistogramFacetBuilder	The interval used to control the bucket "size" where each key value of a hit will fall into.
Interval ( long interval ) : HistogramFacetBuilder	The interval used to control the bucket "size" where each key value of a hit will fall into.
KeyField ( string keyField ) : HistogramFacetBuilder	The field name to use in order to control where the hit will "fall into" within the histogram entries. Essentially, using the key field numeric value, the hit will be "rounded" into the relevant bucket controlled by the interval.
Nested ( string nested ) : HistogramFacetBuilder	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.
Scope ( string scope ) : HistogramFacetBuilder	Marks the facet to run in a specific scope.
ToJsonObject ( ) : object
ValueField ( string valueField ) : HistogramFacetBuilder	The field name to use as the value of the hit to compute data based on values within the interval (for example, total).

Method Details

Bounds() public method

Sets the bounds from and to for the facet. Both performs bounds check and includes only values within the bounds, and improves performance.

public Bounds ( object from, object to ) : HistogramFacetBuilder
from	object
to	object
return	HistogramFacetBuilder

Comparator() public method

public Comparator ( HistogramComparatorType comparatorType ) : HistogramFacetBuilder
comparatorType	HistogramComparatorType
return	HistogramFacetBuilder

FacetFilter() public method

An additional filter used to further filter down the set of documents the facet will run on.

public FacetFilter ( IFilterBuilder filter ) : HistogramFacetBuilder
filter	IFilterBuilder
return	HistogramFacetBuilder

Field() public method

The field name to perform the histogram facet. Translates to perform the histogram facet using the provided field as both the {@link #keyField(string)} and {@link #valueField(string)}.

public Field ( string field ) : HistogramFacetBuilder
field	string
return	HistogramFacetBuilder

Global() public method

Should the facet run in global mode (not bounded by the search query) or not (bounded by the search query). Defaults to false.

public Global ( bool global ) : HistogramFacetBuilder
global	bool
return	HistogramFacetBuilder

HistogramFacetBuilder() public method

Constructs a new histogram facet with the provided facet logical name.

public HistogramFacetBuilder ( string name ) : System
name	string
return	System

Interval() public method

The interval used to control the bucket "size" where each key value of a hit will fall into.

public Interval ( System.TimeSpan span ) : HistogramFacetBuilder
span	System.TimeSpan
return	HistogramFacetBuilder

Interval() public method

The interval used to control the bucket "size" where each key value of a hit will fall into.

public Interval ( long interval ) : HistogramFacetBuilder
interval	long
return	HistogramFacetBuilder

KeyField() public method

The field name to use in order to control where the hit will "fall into" within the histogram entries. Essentially, using the key field numeric value, the hit will be "rounded" into the relevant bucket controlled by the interval.

public KeyField ( string keyField ) : HistogramFacetBuilder
keyField	string
return	HistogramFacetBuilder

Nested() public method

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.

public Nested ( string nested ) : HistogramFacetBuilder
nested	string
return	HistogramFacetBuilder

Scope() public method

Marks the facet to run in a specific scope.

public Scope ( string scope ) : HistogramFacetBuilder
scope	string
return	HistogramFacetBuilder

ToJsonObject() public method

public ToJsonObject ( ) : object
return	object

ValueField() public method

The field name to use as the value of the hit to compute data based on values within the interval (for example, total).

public ValueField ( string valueField ) : HistogramFacetBuilder
valueField	string
return	HistogramFacetBuilder