blob: 19bc250179b648386885b0fc6ca0766cadfd3404 (
plain)
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
|
/**
* ============LICENSE_START=======================================================
* org.onap.aai
* ================================================================================
* Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
* Copyright © 2017-2018 Amdocs
* ================================================================================
* 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.
* ============LICENSE_END=========================================================
*/
package org.onap.aai.sa.searchdbabstraction.searchapi;
import com.fasterxml.jackson.annotation.JsonProperty;
/**
* This class represents a simple parsed query statement.
*
* <p>
* A 'parsed query' specifies a document field to inspect and a query string which will be parsed by the document store
* to generate the exact query to be performed.
*
* <p>
* The query string will be tokenized into 'terms' and 'operators' where:
*
* <p>
* Terms may be any of the following:
* <ul>
* <li>single words</li>
* <li>exact phrases (denoted by surrounding the phrase with '"' characters)</li>
* <li>regular expressions (denoted by surrounding the phrase with '/' characters)</li>
* </ul>
*
* <p>
* Operators may be any of the following:
* <ul>
* <li>+ -- The term to the right of the operator MUST be present to produce a match.</li>
* <li>- -- The term to the right of the operator MUST NOT be present to produce a match.</li>
* <li>AND -- Both the terms to the left and right of the operator MUST be present to produce a match.</li>
* <li>OR -- Either the term to the left or right of the operator MUST be present to produce a match.</li>
* <li>NOT -- The term to the right of the operator MUST NOT be present to produce a match.</li>
* </ul>
*
* <p>
* The expected JSON structure for a parsed query is as follows:
*
* <pre>
* {
* "parsed-query": {
* "field": "fieldname",
* "query-string": "string"
* }
* }
* </pre>
*/
public class ParsedQuery {
/**
* The name of the field which the query is to be applied to.
*/
private String field;
/**
* The string to be parsed to generate the full query.
*/
@JsonProperty("query-string")
private String queryString;
public String getField() {
return field;
}
public void setField(String field) {
this.field = field;
}
public String getQueryString() {
return queryString;
}
public void setQueryString(String queryString) {
this.queryString = queryString;
}
/**
* This method returns a string which represents this query in syntax that is understandable by ElasticSearch and is
* suitable for inclusion in an ElasticSearch query string.
*
* @return - ElasticSearch syntax string.
*/
public String toElasticSearch() {
StringBuilder sb = new StringBuilder();
sb.append("{");
sb.append("\"query_string\": {");
sb.append("\"default_field\": \"").append(field).append("\", ");
sb.append("\"query\": \"").append(queryString).append("\"");
sb.append("}");
sb.append("}");
return sb.toString();
}
@Override
public String toString() {
return "{field:" + field + ", query-string: '" + queryString + "'}";
}
}
|
