C# Class Rubber.DSL.Facet.RangeScriptFacetBuilder

Inheritance: AbstractFacetBuilder
Mostrar archivo Open project: stephenpope/Rubber

Public Methods

Method Description
AddRange ( double from, double to ) : RangeScriptFacetBuilder

Adds a range entry with explicit from and to.

AddUnboundedFrom ( double to ) : RangeScriptFacetBuilder

Adds a range entry with explicit to and unbounded from.

AddUnboundedTo ( double from ) : RangeScriptFacetBuilder

Adds a range entry with explicit from and unbounded to.

FacetFilter ( IFilterBuilder filter ) : RangeScriptFacetBuilder

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

Global ( bool global ) : RangeScriptFacetBuilder

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

KeyScript ( string keyScript ) : RangeScriptFacetBuilder
Lang ( string lang ) : RangeScriptFacetBuilder

The language of the script.

Nested ( string nested ) : RangeScriptFacetBuilder

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 ) : RangeScriptFacetBuilder

A parameter that will be passed to the script.

RangeScriptFacetBuilder ( string name ) : System.Collections.Generic
Scope ( string scope ) : RangeScriptFacetBuilder

Marks the facet to run in a specific scope.

ToJsonObject ( ) : object
ValueScript ( string valueScript ) : RangeScriptFacetBuilder

Method Details

AddRange() public method

Adds a range entry with explicit from and to.
public AddRange ( double from, double to ) : RangeScriptFacetBuilder
from double The from range limit
to double The to range limit
return RangeScriptFacetBuilder

AddUnboundedFrom() public method

Adds a range entry with explicit to and unbounded from.
public AddUnboundedFrom ( double to ) : RangeScriptFacetBuilder
to double The to range limit, from is unbounded.
return RangeScriptFacetBuilder

AddUnboundedTo() public method

Adds a range entry with explicit from and unbounded to.
public AddUnboundedTo ( double from ) : RangeScriptFacetBuilder
from double The from range limit, to is unbounded.
return RangeScriptFacetBuilder

FacetFilter() public method

An additional filter used to further filter down the set of documents the facet will run on.
public FacetFilter ( IFilterBuilder filter ) : RangeScriptFacetBuilder
filter IFilterBuilder
return RangeScriptFacetBuilder

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

KeyScript() public method

public KeyScript ( string keyScript ) : RangeScriptFacetBuilder
keyScript string
return RangeScriptFacetBuilder

Lang() public method

The language of the script.
public Lang ( string lang ) : RangeScriptFacetBuilder
lang string
return RangeScriptFacetBuilder

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

Param() public method

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

RangeScriptFacetBuilder() public method

public RangeScriptFacetBuilder ( string name ) : System.Collections.Generic
name string
return System.Collections.Generic

Scope() public method

Marks the facet to run in a specific scope.
public Scope ( string scope ) : RangeScriptFacetBuilder
scope string
return RangeScriptFacetBuilder

ToJsonObject() public method

public ToJsonObject ( ) : object
return object

ValueScript() public method

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