C# Class Rubber.DSL.Facet.TermsStatsFacetBuilder

Inheritance: AbstractFacetBuilder
Datei anzeigen Open project: stephenpope/Rubber

Public Methods

Method Description
AllTerms ( ) : TermsStatsFacetBuilder

Marks all terms to be returned, even ones with 0 counts.

KeyField ( string keyField ) : TermsStatsFacetBuilder
Order ( TermsStatsComparatorType comparatorType ) : TermsStatsFacetBuilder

The order by which to return the facets by. Defaults to COUNT.

Param ( string name, object value ) : TermsStatsFacetBuilder

A parameter that will be passed to the script.

Script ( string script ) : TermsStatsFacetBuilder

The language of the script.

Size ( int size ) : TermsStatsFacetBuilder

Sets the size of the result.

TermsStatsFacetBuilder ( string name ) : System.Collections.Generic

Constructs a new terms stats facet builder under the provided facet name.

ToJsonObject ( ) : object
ValueField ( string valueField ) : TermsStatsFacetBuilder
ValueScript ( string script ) : TermsStatsFacetBuilder

A value script to be executed (instead of value field) which results (numeric) will be used to compute the totals.

Method Details

AllTerms() public method

Marks all terms to be returned, even ones with 0 counts.
public AllTerms ( ) : TermsStatsFacetBuilder
return TermsStatsFacetBuilder

KeyField() public method

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

Order() public method

The order by which to return the facets by. Defaults to COUNT.
public Order ( TermsStatsComparatorType comparatorType ) : TermsStatsFacetBuilder
comparatorType TermsStatsComparatorType
return TermsStatsFacetBuilder

Param() public method

A parameter that will be passed to the script.
public Param ( string name, object value ) : TermsStatsFacetBuilder
name string The name of the script parameter.
value object The value of the script parameter.
return TermsStatsFacetBuilder

Script() public method

The language of the script.
public Script ( string script ) : TermsStatsFacetBuilder
script string
return TermsStatsFacetBuilder

Size() public method

Sets the size of the result.
public Size ( int size ) : TermsStatsFacetBuilder
size int
return TermsStatsFacetBuilder

TermsStatsFacetBuilder() public method

Constructs a new terms stats facet builder under the provided facet name.
public TermsStatsFacetBuilder ( string name ) : System.Collections.Generic
name string
return System.Collections.Generic

ToJsonObject() public method

public ToJsonObject ( ) : object
return object

ValueField() public method

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

ValueScript() public method

A value script to be executed (instead of value field) which results (numeric) will be used to compute the totals.
public ValueScript ( string script ) : TermsStatsFacetBuilder
script string
return TermsStatsFacetBuilder