forked from elastic/elasticsearch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
HLRC API for _termvectors (elastic#33447)
* HLRC API for _termvectors relates to elastic#27205
- Loading branch information
1 parent
f19565c
commit bf4d90a
Showing
12 changed files
with
1,347 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
228 changes: 228 additions & 0 deletions
228
client/rest-high-level/src/main/java/org/elasticsearch/client/core/TermVectorsRequest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,228 @@ | ||
| /* | ||
| * 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.client.core; | ||
|
|
||
| import org.elasticsearch.client.Validatable; | ||
| import org.elasticsearch.common.bytes.BytesReference; | ||
| import org.elasticsearch.common.xcontent.ToXContentObject; | ||
| import org.elasticsearch.common.xcontent.XContentBuilder; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.util.Map; | ||
|
|
||
| public class TermVectorsRequest implements ToXContentObject, Validatable { | ||
|
|
||
| private final String index; | ||
| private final String type; | ||
| private String id = null; | ||
| private String routing = null; | ||
| private String preference = null; | ||
| private boolean realtime = true; | ||
| private String[] fields = null; | ||
| private boolean requestPositions = true; | ||
| private boolean requestPayloads = true; | ||
| private boolean requestOffsets = true; | ||
| private boolean requestFieldStatistics = true; | ||
| private boolean requestTermStatistics = false; | ||
| private Map<String, String> perFieldAnalyzer = null; | ||
| private Map<String, Integer> filterSettings = null; | ||
| private XContentBuilder docBuilder = null; | ||
|
|
||
|
|
||
| /** | ||
| * Constructs TermVectorRequest for the given document | ||
| * @param index - index of the document | ||
| * @param type - type of the document | ||
| * @param docId - id of the document | ||
| */ | ||
| public TermVectorsRequest(String index, String type, String docId) { | ||
| this(index, type); | ||
| this.id = docId; | ||
| } | ||
|
|
||
| /** | ||
| * Constructs TermVectorRequest for an artificial document | ||
| * @param index - index of the document | ||
| * @param type - type of the document | ||
| */ | ||
| public TermVectorsRequest(String index, String type) { | ||
| this.index = index; | ||
| this.type = type; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the index of the request | ||
| */ | ||
| public String getIndex() { | ||
| return index; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the type of the request | ||
| */ | ||
| public String getType() { | ||
| return type; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the id of the request | ||
| * can be NULL if there is no document ID | ||
| */ | ||
| public String getId() { | ||
| return id; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the fields for which term vectors information should be retrieved | ||
| */ | ||
| public void setFields(String... fields) { | ||
| this.fields = fields; | ||
| } | ||
|
|
||
| public String[] getFields() { | ||
| return fields; | ||
| } | ||
|
|
||
| /** | ||
| * Sets whether to request term positions | ||
| */ | ||
| public void setPositions(boolean requestPositions) { | ||
| this.requestPositions = requestPositions; | ||
| } | ||
|
|
||
| /** | ||
| * Sets whether to request term payloads | ||
| */ | ||
| public void setPayloads(boolean requestPayloads) { | ||
| this.requestPayloads = requestPayloads; | ||
| } | ||
|
|
||
| /** | ||
| * Sets whether to request term offsets | ||
| */ | ||
| public void setOffsets(boolean requestOffsets) { | ||
| this.requestOffsets = requestOffsets; | ||
| } | ||
|
|
||
| /** | ||
| * Sets whether to request field statistics | ||
| */ | ||
| public void setFieldStatistics(boolean requestFieldStatistics) { | ||
| this.requestFieldStatistics = requestFieldStatistics; | ||
| } | ||
|
|
||
| /** | ||
| * Sets whether to request term statistics | ||
| */ | ||
| public void setTermStatistics(boolean requestTermStatistics) { | ||
| this.requestTermStatistics = requestTermStatistics; | ||
| } | ||
|
|
||
| /** | ||
| * Sets different analyzers than the one at the fields | ||
| */ | ||
| public void setPerFieldAnalyzer(Map<String, String> perFieldAnalyzer) { | ||
| this.perFieldAnalyzer = perFieldAnalyzer; | ||
| } | ||
|
|
||
| /** | ||
| * Sets an artifical document on what to request _termvectors | ||
| */ | ||
| public void setDoc(XContentBuilder docBuilder) { | ||
| this.docBuilder = docBuilder; | ||
| } | ||
|
|
||
| /** | ||
| * Sets conditions for terms filtering | ||
| */ | ||
| public void setFilterSettings(Map<String, Integer> filterSettings) { | ||
| this.filterSettings = filterSettings; | ||
| } | ||
|
|
||
| /** | ||
| * Sets a routing to route a request to a particular shard | ||
| */ | ||
| public void setRouting(String routing) { | ||
| this.routing = routing; | ||
| } | ||
|
|
||
| public String getRouting() { | ||
| return routing; | ||
| } | ||
|
|
||
| /** | ||
| * Set a preference of which shard copies to execute the request | ||
| */ | ||
| public void setPreference(String preference) { | ||
| this.preference = preference; | ||
| } | ||
|
|
||
| public String getPreference() { | ||
| return preference; | ||
| } | ||
|
|
||
| /** | ||
| * Sets if the request should be realtime or near-realtime | ||
| */ | ||
| public void setRealtime(boolean realtime) { | ||
| this.realtime = realtime; | ||
| } | ||
|
|
||
| /** | ||
| * Returns if the request is realtime(true) or near-realtime(false) | ||
| */ | ||
| public boolean getRealtime() { | ||
| return realtime; | ||
| } | ||
|
|
||
|
|
||
| @Override | ||
| public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException { | ||
| builder.startObject(); | ||
| // set values only when different from defaults | ||
| if (requestPositions == false) builder.field("positions", false); | ||
| if (requestPayloads == false) builder.field("payloads", false); | ||
| if (requestOffsets == false) builder.field("offsets", false); | ||
| if (requestFieldStatistics == false) builder.field("field_statistics", false); | ||
| if (requestTermStatistics) builder.field("term_statistics", true); | ||
| if (perFieldAnalyzer != null) builder.field("per_field_analyzer", perFieldAnalyzer); | ||
|
|
||
| if (docBuilder != null) { | ||
| BytesReference doc = BytesReference.bytes(docBuilder); | ||
| try (InputStream stream = doc.streamInput()) { | ||
| builder.rawField("doc", stream, docBuilder.contentType()); | ||
| } | ||
| } | ||
|
|
||
| if (filterSettings != null) { | ||
| builder.startObject("filter"); | ||
| String[] filterSettingNames = | ||
| {"max_num_terms", "min_term_freq", "max_term_freq", "min_doc_freq", "max_doc_freq", "min_word_length", "max_word_length"}; | ||
| for (String settingName : filterSettingNames) { | ||
| if (filterSettings.containsKey(settingName)) builder.field(settingName, filterSettings.get(settingName)); | ||
| } | ||
| builder.endObject(); | ||
| } | ||
| builder.endObject(); | ||
| return builder; | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.