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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch licenses this file to you 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.
*/
package org.elasticsearch.search.aggregations;
import com.google.common.collect.Maps;
import org.elasticsearch.common.xcontent.XContentBuilder;
import java.io.IOException;
import java.util.Map;
/**
* A base class for all bucket aggregation builders that are based on values (either script generated or field data values)
*/
public abstract class ValuesSourceAggregationBuilder<B extends ValuesSourceAggregationBuilder<B>> extends AggregationBuilder<B> {
private String field;
private String script;
private String lang;
private Map<String, Object> params;
/**
* Constructs a new builder.
*
* @param name The name of the aggregation.
* @param type The type of the aggregation.
*/
protected ValuesSourceAggregationBuilder(String name, String type) {
super(name, type);
}
/**
* Sets the field from which the values will be extracted.
*
* @param field The name of the field
* @return This builder (fluent interface support)
*/
@SuppressWarnings("unchecked")
public B field(String field) {
this.field = field;
return (B) this;
}
/**
* Sets the script which generates the values. If the script is configured along with the field (as in {@link #field(String)}), then
* this script will be treated as a {@code value script}. A <i>value script</i> will be applied on the values that are extracted from
* the field data (you can refer to that value in the script using the {@code _value} reserved variable). If only the script is configured
* (and the no field is configured next to it), then the script will be responsible to generate the values that will be aggregated.
*
* @param script The configured script.
* @return This builder (fluent interface support)
*/
@SuppressWarnings("unchecked")
public B script(String script) {
this.script = script;
return (B) this;
}
/**
* Sets the language of the script (if one is defined).
* <p/>
* Also see {@link #script(String)}.
*
* @param lang The language of the script.
* @return This builder (fluent interface support)
*/
@SuppressWarnings("unchecked")
public B lang(String lang) {
this.lang = lang;
return (B) this;
}
/**
* Sets the value of a parameter that is used in the script (if one is configured).
*
* @param name The name of the parameter.
* @param value The value of the parameter.
* @return This builder (fluent interface support)
*/
@SuppressWarnings("unchecked")
public B param(String name, Object value) {
if (params == null) {
params = Maps.newHashMap();
}
params.put(name, value);
return (B) this;
}
/**
* Sets the values of a parameters that are used in the script (if one is configured).
*
* @param params The the parameters.
* @return This builder (fluent interface support)
*/
@SuppressWarnings("unchecked")
public B params(Map<String, Object> params) {
if (this.params == null) {
this.params = Maps.newHashMap();
}
this.params.putAll(params);
return (B) this;
}
@Override
protected final XContentBuilder internalXContent(XContentBuilder builder, Params params) throws IOException {
builder.startObject();
if (field != null) {
builder.field("field", field);
}
if (script != null) {
builder.field("script", script);
}
if (lang != null) {
builder.field("lang", lang);
}
if (this.params != null) {
builder.field("params").map(this.params);
}
doInternalXContent(builder, params);
return builder.endObject();
}
protected abstract XContentBuilder doInternalXContent(XContentBuilder builder, Params params) throws IOException;
}
|
