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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
/*
* 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.action.termvectors;
import org.elasticsearch.action.ActionListener;
import org.elasticsearch.action.ActionRequestBuilder;
import org.elasticsearch.client.ElasticsearchClient;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.index.VersionType;
import java.util.Map;
/**
* The builder class for a term vector request.
* Returns the term vector (doc frequency, positions, offsets) for a document.
* <p>
* Note, the {@code index}, {@code type} and {@code id} are
* required.
*/
public class TermVectorsRequestBuilder extends ActionRequestBuilder<TermVectorsRequest, TermVectorsResponse, TermVectorsRequestBuilder> {
public TermVectorsRequestBuilder(ElasticsearchClient client, TermVectorsAction action) {
super(client, action, new TermVectorsRequest());
}
/**
* Constructs a new term vector request builder for a document that will be fetch
* from the provided index. Use {@code index}, {@code type} and
* {@code id} to specify the document to load.
*/
public TermVectorsRequestBuilder(ElasticsearchClient client, TermVectorsAction action, String index, String type, String id) {
super(client, action, new TermVectorsRequest(index, type, id));
}
/**
* Sets the index where the document is located.
*/
public TermVectorsRequestBuilder setIndex(String index) {
request.index(index);
return this;
}
/**
* Sets the type of the document.
*/
public TermVectorsRequestBuilder setType(String type) {
request.type(type);
return this;
}
/**
* Sets the id of the document.
*/
public TermVectorsRequestBuilder setId(String id) {
request.id(id);
return this;
}
/**
* Sets the artificial document from which to generate term vectors.
*/
public TermVectorsRequestBuilder setDoc(XContentBuilder xContent) {
request.doc(xContent);
return this;
}
/**
* Sets the routing. Required if routing isn't id based.
*/
public TermVectorsRequestBuilder setRouting(String routing) {
request.routing(routing);
return this;
}
/**
* Sets the parent id of this document. Will simply set the routing to this value, as it is only
* used for routing with delete requests.
*/
public TermVectorsRequestBuilder setParent(String parent) {
request.parent(parent);
return this;
}
/**
* Sets the preference to execute the search. Defaults to randomize across shards. Can be set to
* <tt>_local</tt> to prefer local shards, <tt>_primary</tt> to execute only on primary shards, or
* a custom value, which guarantees that the same order will be used across different requests.
*/
public TermVectorsRequestBuilder setPreference(String preference) {
request.preference(preference);
return this;
}
/**
* Sets whether to return the start and stop offsets for each term if they were stored or
* skip offsets.
*/
public TermVectorsRequestBuilder setOffsets(boolean offsets) {
request.offsets(offsets);
return this;
}
/**
* Sets whether to return the positions for each term if stored or skip.
*/
public TermVectorsRequestBuilder setPositions(boolean positions) {
request.positions(positions);
return this;
}
/**
* Sets whether to return the payloads for each term or skip.
*/
public TermVectorsRequestBuilder setPayloads(boolean payloads) {
request.payloads(payloads);
return this;
}
/**
* Sets whether to return the term statistics for each term in the shard or skip.
*/
public TermVectorsRequestBuilder setTermStatistics(boolean termStatistics) {
request.termStatistics(termStatistics);
return this;
}
/**
* Sets whether to return the field statistics for each term in the shard or skip.
*/
public TermVectorsRequestBuilder setFieldStatistics(boolean fieldStatistics) {
request.fieldStatistics(fieldStatistics);
return this;
}
/**
* Sets whether to use distributed frequencies instead of shard statistics.
*/
public TermVectorsRequestBuilder setDfs(boolean dfs) {
request.dfs(dfs);
return this;
}
/**
* Sets whether to return only term vectors for special selected fields. Returns the term
* vectors for all fields if selectedFields == null
*/
public TermVectorsRequestBuilder setSelectedFields(String... fields) {
request.selectedFields(fields);
return this;
}
/**
* Sets whether term vectors are generated real-time.
*/
public TermVectorsRequestBuilder setRealtime(Boolean realtime) {
request.realtime(realtime);
return this;
}
/*
* Sets the version, which will cause the get operation to only be performed if a matching
* version exists and no changes happened on the doc since then.
*/
public TermVectorsRequestBuilder setVersion(long version) {
request.version(version);
return this;
}
/*
* Sets the versioning type. Defaults to {@link org.elasticsearch.index.VersionType#INTERNAL}.
*/
public TermVectorsRequestBuilder setVersionType(VersionType versionType) {
request.versionType(versionType);
return this;
}
/**
* Sets the analyzer used at each field when generating term vectors.
*/
public TermVectorsRequestBuilder setPerFieldAnalyzer(Map<String, String> perFieldAnalyzer) {
request.perFieldAnalyzer(perFieldAnalyzer);
return this;
}
/**
* Sets the settings for filtering out terms.
*/
public TermVectorsRequestBuilder setFilterSettings(TermVectorsRequest.FilterSettings filterSettings) {
request.filterSettings(filterSettings);
return this;
}
}
|
