Class NumericRangeFacet

A ISearchFacet which counts how many documents fall between two float values.

Inheritance

object

SearchFacet

NumericRangeFacet

Implements

ISearchFacet

Inherited Members

SearchFacet.Name

SearchFacet.Field

SearchFacet.Size

SearchFacet.Term(string, string, int)

SearchFacet.Numeric(string, string, int, params Range<float>[])

SearchFacet.Date(string, string, int, params Range<DateTime>[])

SearchFacet.ToString()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Couchbase.Search

Assembly: Couchbase.NetClient.dll

Syntax

public sealed class NumericRangeFacet : SearchFacet, ISearchFacet

Constructors

NumericRangeFacet()

Declaration

public NumericRangeFacet()

NumericRangeFacet(string, string)

Declaration

public NumericRangeFacet(string name, string field)

Parameters

Type	Name	Description
string	name
string	field

NumericRangeFacet(string, string, int)

Declaration

public NumericRangeFacet(string name, string field, int limit)

Parameters

Type	Name	Description
string	name
string	field
int	limit

Methods

AddRange(Range<float>)

Adds a numeric range to the ISearchFacet.

Declaration

public NumericRangeFacet AddRange(Range<float> range)

Parameters

Type	Name	Description
Range<float>	range	A numeric range.

Returns

Type	Description
NumericRangeFacet

AddRange(float, float)

Declaration

[Obsolete("Use the overload which takes a string and two floats instead.")]
public NumericRangeFacet AddRange(float start, float end)

Parameters

Type	Name	Description
float	start
float	end

Returns

Type	Description
NumericRangeFacet

AddRange(string, float, float)

Adds a numeric range to the ISearchFacet.

Declaration

public NumericRangeFacet AddRange(string name, float start, float end)

Parameters

Type	Name	Description
string	name	The name of the numeric range."/>
float	start	The start of the numeric range."/>
float	end	The end of the numeric range.

Returns

Type	Description
NumericRangeFacet

AddRanges(params Range<float>[])

Adds a range of numeric ranges to the ISearchFacet

Declaration

public NumericRangeFacet AddRanges(params Range<float>[] ranges)

Parameters

Type	Name	Description
Range<float>[]	ranges	A range of ISearchFacets.

Returns

Type	Description
NumericRangeFacet

ToJson()

Gets the JSON representation of this object.

Declaration

public override JProperty ToJson()

Returns

Type	Description
JProperty	A Newtonsoft.Json.Linq.JObject representing the object's state.

Overrides

SearchFacet.ToJson()

Exceptions

Type	Condition
InvalidOperationException	The Name and the Field property must have a value.

Implements

ISearchFacet