C# Class Rubber.DSL.Facet.DateHistogramFacetBuilder

A facet builder of date histogram facets.

Inheritance: AbstractFacetBuilder

Mostrar archivo Open project: stephenpope/Rubber

Public Methods

Method	Description
Comparator ( DateHistogramComparatorType comparatorType ) : DateHistogramFacetBuilder
DateHistogramFacetBuilder ( string name ) : System	Constructs a new date histogram facet with the provided facet logical name.
FacetFilter ( IFilterBuilder filter ) : DateHistogramFacetBuilder	An additional filter used to further filter down the set of documents the facet will run on.
Field ( string field ) : DateHistogramFacetBuilder	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 ) : DateHistogramFacetBuilder	Should the facet run in global mode (not bounded by the search query) or not (bounded by the search query). Defaults to `false`.
Interval ( string interval ) : DateHistogramFacetBuilder	The interval used to control the bucket "size" where each key value of a hit will fall into. Check the docs for all available values.
KeyField ( string keyField ) : DateHistogramFacetBuilder	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.
Lang ( string lang ) : DateHistogramFacetBuilder	The language of the value script.
Nested ( string nested ) : DateHistogramFacetBuilder	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.
Param ( string name, object value ) : DateHistogramFacetBuilder
Scope ( string scope ) : DateHistogramFacetBuilder	Marks the facet to run in a specific scope.
ToJsonObject ( ) : object
ValueField ( string valueField ) : DateHistogramFacetBuilder	The field name to use as the value of the hit to compute data based on values within the interval (for example, total).
ValueScript ( string valueScript ) : DateHistogramFacetBuilder
Zone ( string zone ) : DateHistogramFacetBuilder	Sets the time zone to use when bucketing the values. Can either be in the form of "-10:00" or one of the values listed here: http://joda-time.sourceforge.net/timezones.html.

Method Details

Comparator() public method

public Comparator ( DateHistogramComparatorType comparatorType ) : DateHistogramFacetBuilder
comparatorType	DateHistogramComparatorType
return	DateHistogramFacetBuilder

DateHistogramFacetBuilder() public method

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

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

FacetFilter() public method

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

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

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 ) : DateHistogramFacetBuilder
field	string
return	DateHistogramFacetBuilder

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 ) : DateHistogramFacetBuilder
global	bool
return	DateHistogramFacetBuilder

Interval() public method

The interval used to control the bucket "size" where each key value of a hit will fall into. Check the docs for all available values.

public Interval ( string interval ) : DateHistogramFacetBuilder
interval	string
return	DateHistogramFacetBuilder

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 ) : DateHistogramFacetBuilder
keyField	string
return	DateHistogramFacetBuilder

Lang() public method

The language of the value script.

public Lang ( string lang ) : DateHistogramFacetBuilder
lang	string
return	DateHistogramFacetBuilder

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 ) : DateHistogramFacetBuilder
nested	string
return	DateHistogramFacetBuilder

Param() public method

public Param ( string name, object value ) : DateHistogramFacetBuilder
name	string
value	object
return	DateHistogramFacetBuilder

Scope() public method

Marks the facet to run in a specific scope.

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

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 ) : DateHistogramFacetBuilder
valueField	string
return	DateHistogramFacetBuilder

ValueScript() public method

public ValueScript ( string valueScript ) : DateHistogramFacetBuilder
valueScript	string
return	DateHistogramFacetBuilder

Zone() public method

Sets the time zone to use when bucketing the values. Can either be in the form of "-10:00" or one of the values listed here: http://joda-time.sourceforge.net/timezones.html.

public Zone ( string zone ) : DateHistogramFacetBuilder
zone	string
return	DateHistogramFacetBuilder