C# Class Rubber.DSL.Query.TopChildrenQueryBuilder

Inheritance: IQueryBuilder
Show file Open project: stephenpope/Rubber

Public Methods

Method Description
Boost ( float boost ) : TopChildrenQueryBuilder

Sets the boost for this query. Documents matching this query will (in addition to the normal weightings) have their score multiplied by the boost provided.

Factor ( int factor ) : TopChildrenQueryBuilder

Controls the multiplication factor of the initial hits required from the child query over the main query request. Defaults to 5.

IncrementalFactor ( int incrementalFactor ) : TopChildrenQueryBuilder

Sets the incremental factor when the query needs to be re-run in order to fetch more results. Defaults to 2.

Scope ( string scope ) : TopChildrenQueryBuilder

The scope of the query, which can later be used, for example, to run facets against the child docs that matches the query.

Score ( string score ) : TopChildrenQueryBuilder

How to compute the score. Possible values are: max, sum, or avg. Defaults to max.

ToJsonObject ( ) : object
ToString ( ) : string
TopChildrenQueryBuilder ( string type, IQueryBuilder queryBuilder ) : System

Method Details

Boost() public method

Sets the boost for this query. Documents matching this query will (in addition to the normal weightings) have their score multiplied by the boost provided.
public Boost ( float boost ) : TopChildrenQueryBuilder
boost float
return TopChildrenQueryBuilder

Factor() public method

Controls the multiplication factor of the initial hits required from the child query over the main query request. Defaults to 5.
public Factor ( int factor ) : TopChildrenQueryBuilder
factor int
return TopChildrenQueryBuilder

IncrementalFactor() public method

Sets the incremental factor when the query needs to be re-run in order to fetch more results. Defaults to 2.
public IncrementalFactor ( int incrementalFactor ) : TopChildrenQueryBuilder
incrementalFactor int
return TopChildrenQueryBuilder

Scope() public method

The scope of the query, which can later be used, for example, to run facets against the child docs that matches the query.
public Scope ( string scope ) : TopChildrenQueryBuilder
scope string
return TopChildrenQueryBuilder

Score() public method

How to compute the score. Possible values are: max, sum, or avg. Defaults to max.
public Score ( string score ) : TopChildrenQueryBuilder
score string
return TopChildrenQueryBuilder

ToJsonObject() public method

public ToJsonObject ( ) : object
return object

ToString() public method

public ToString ( ) : string
return string

TopChildrenQueryBuilder() public method

public TopChildrenQueryBuilder ( string type, IQueryBuilder queryBuilder ) : System
type string
queryBuilder IQueryBuilder
return System