C# Class Rubber.DSL.Facet.RangeFacetBuilder

A facet builder of range facets.

Inheritance: AbstractFacetBuilder

Mostra file Open project: stephenpope/Rubber

Public Methods

Method	Description
AddRange ( double from, double to ) : RangeFacetBuilder	Adds a range entry with explicit from and to.
AddRange ( string from, string to ) : RangeFacetBuilder
AddUnboundedFrom ( double to ) : RangeFacetBuilder	Adds a range entry with explicit to and unbounded from.
AddUnboundedFrom ( string to ) : RangeFacetBuilder
AddUnboundedTo ( double from ) : RangeFacetBuilder	Adds a range entry with explicit from and unbounded to.
AddUnboundedTo ( string from ) : RangeFacetBuilder
FacetFilter ( IFilterBuilder filter ) : RangeFacetBuilder	An additional filter used to further filter down the set of documents the facet will run on.
Field ( string field ) : RangeFacetBuilder	The field name to perform the range facet. Translates to perform the range facet using the provided field as both the {@link #keyField(String)} and {@link #valueField(String)}.
Global ( bool global ) : RangeFacetBuilder	Should the facet run in global mode (not bounded by the search query) or not (bounded by the search query). Defaults to `false`.
KeyField ( string keyField ) : RangeFacetBuilder	The field name to use in order to control where the hit will "fall into" within the range entries. Essentially, using the key field numeric value, the hit will be "rounded" into the relevant bucket controlled by the interval.
Nested ( string nested ) : RangeFacetBuilder	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.
RangeFacetBuilder ( string name ) : System.Collections.Generic	Constructs a new range facet with the provided facet logical name.
Scope ( string scope ) : RangeFacetBuilder	Marks the facet to run in a specific scope.
ToJsonObject ( ) : object
ValueField ( string valueField ) : RangeFacetBuilder	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

AddRange() public method

Adds a range entry with explicit from and to.

public AddRange ( double from, double to ) : RangeFacetBuilder
from	double	The from range limit
to	double	The to range limit
return	RangeFacetBuilder

AddRange() public method

public AddRange ( string from, string to ) : RangeFacetBuilder
from	string
to	string
return	RangeFacetBuilder

AddUnboundedFrom() public method

Adds a range entry with explicit to and unbounded from.

public AddUnboundedFrom ( double to ) : RangeFacetBuilder
to	double	The to range limit, from is unbounded.
return	RangeFacetBuilder

AddUnboundedFrom() public method

public AddUnboundedFrom ( string to ) : RangeFacetBuilder
to	string
return	RangeFacetBuilder

AddUnboundedTo() public method

Adds a range entry with explicit from and unbounded to.

public AddUnboundedTo ( double from ) : RangeFacetBuilder
from	double	the from range limit, to is unbounded.
return	RangeFacetBuilder

AddUnboundedTo() public method

public AddUnboundedTo ( string from ) : RangeFacetBuilder
from	string
return	RangeFacetBuilder

FacetFilter() public method

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

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

Field() public method

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

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

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

KeyField() public method

The field name to use in order to control where the hit will "fall into" within the range 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 ) : RangeFacetBuilder
keyField	string
return	RangeFacetBuilder

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

RangeFacetBuilder() public method

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

public RangeFacetBuilder ( string name ) : System.Collections.Generic
name	string	The logical name of the facet
return	System.Collections.Generic

Scope() public method

Marks the facet to run in a specific scope.

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

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