-
Notifications
You must be signed in to change notification settings - Fork 796
/
SolrFacetFieldQuery.cs
85 lines (73 loc) · 3.19 KB
/
SolrFacetFieldQuery.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
#region license
// Copyright (c) 2007-2010 Mauricio Scheffer
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#endregion
using System.Collections.Generic;
namespace SolrNet {
/// <summary>
/// Facet field query
/// </summary>
public class SolrFacetFieldQuery : ISolrFacetQuery {
private readonly string field;
public SolrFacetFieldQuery(string field) {
this.field = field;
}
/// <summary>
/// Facet field
/// </summary>
public string Field {
get { return field; }
}
/// <summary>
/// Limits the terms on which to facet to those starting with the given string prefix.
/// </summary>
public string Prefix { get; set; }
/// <summary>
/// Set to true, this parameter indicates that constraints should be sorted by their count.
/// If false, facets will be in their natural index order (unicode).
/// For terms in the ascii range, this will be alphabetically sorted.
/// The default is true if Limit is greater than 0, false otherwise.
/// </summary>
public bool? Sort { get; set; }
/// <summary>
/// This param indicates the maximum number of constraint counts that should be returned for the facet fields.
/// A negative value means unlimited.
/// The default value is 100.
/// </summary>
public int? Limit { get; set; }
/// <summary>
/// This param indicates an offset into the list of constraints to allow paging.
/// The default value is 0.
/// </summary>
public int? Offset { get; set; }
/// <summary>
/// This param indicates the minimum counts for facet fields should be included in the response.
/// The default value is 0.
/// </summary>
public int? MinCount { get; set; }
/// <summary>
/// Set to true this param indicates that in addition to the Term based constraints of a facet field, a count of all matching results which have no value for the field should be computed
/// Default is false
/// </summary>
public bool? Missing { get; set; }
/// <summary>
/// This param indicates the minimum document frequency (number of documents matching a term) for which the filterCache should be used when determining the constraint count for that term.
/// This is only used during the term enumeration method of faceting (field type faceting on multi-valued or full-text fields).
/// A value greater than zero will decrease memory usage of the filterCache, but increase the query time.
/// When faceting on a field with a very large number of terms, and you wish to decrease memory usage, try a low value of 25 to 50 first.
/// The default value is 0, causing the filterCache to be used for all terms in the field.
/// </summary>
public int? EnumCacheMinDf { get; set; }
}
}