Skip to content

Commit bd2b0a6

Browse files
kimchykimchy
committed
Support terms filter, closes #1 
1 parent 78c2205 commit bd2b0a6

File tree

6 files changed

+245
-0
lines changed

6 files changed

+245
-0
lines changed

Diff for: ‎modules/elasticsearch/src/main/java/org/elasticsearch/index/query/json/JsonFilterBuilders.java

+20
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,26 @@ public static TermJsonFilterBuilder termFilter(String name, double value) {
4444
return new TermJsonFilterBuilder(name, value);
4545
}
4646

47+
public static TermsJsonFilterBuilder termsFilter(String name, String... values) {
48+
return new TermsJsonFilterBuilder(name, values);
49+
}
50+
51+
public static TermsJsonFilterBuilder termsFilter(String name, int... values) {
52+
return new TermsJsonFilterBuilder(name, values);
53+
}
54+
55+
public static TermsJsonFilterBuilder termsFilter(String name, long... values) {
56+
return new TermsJsonFilterBuilder(name, values);
57+
}
58+
59+
public static TermsJsonFilterBuilder termsFilter(String name, float... values) {
60+
return new TermsJsonFilterBuilder(name, values);
61+
}
62+
63+
public static TermsJsonFilterBuilder termsFilter(String name, double... values) {
64+
return new TermsJsonFilterBuilder(name, values);
65+
}
66+
4767
public static PrefixJsonFilterBuilder prefixFilter(String name, String value) {
4868
return new PrefixJsonFilterBuilder(name, value);
4969
}

Diff for: ‎modules/elasticsearch/src/main/java/org/elasticsearch/index/query/json/JsonQueryParserRegistry.java

+1
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ public JsonQueryParserRegistry(Index index,
7474
Map<String, JsonFilterParser> filterParsersMap = newHashMap();
7575
// add defaults
7676
add(filterParsersMap, new TermJsonFilterParser(index, indexSettings));
77+
add(filterParsersMap, new TermsJsonFilterParser(index, indexSettings));
7778
add(filterParsersMap, new RangeJsonFilterParser(index, indexSettings));
7879
add(filterParsersMap, new PrefixJsonFilterParser(index, indexSettings));
7980
add(filterParsersMap, new QueryJsonFilterParser(index, indexSettings));

Diff for: ‎modules/elasticsearch/src/main/java/org/elasticsearch/index/query/json/TermsJsonFilterBuilder.java

+85
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
/*
2+
* Licensed to Elastic Search and Shay Banon under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. Elastic Search licenses this
6+
* file to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
20+
package org.elasticsearch.index.query.json;
21+
22+
import org.elasticsearch.util.json.JsonBuilder;
23+
24+
import java.io.IOException;
25+
26+
/**
27+
* @author kimchy (Shay Banon)
28+
*/
29+
public class TermsJsonFilterBuilder extends BaseJsonFilterBuilder {
30+
31+
private final String name;
32+
33+
private final Object[] values;
34+
35+
public TermsJsonFilterBuilder(String name, String... values) {
36+
this(name, (Object[]) values);
37+
}
38+
39+
public TermsJsonFilterBuilder(String name, int... values) {
40+
this.name = name;
41+
this.values = new Integer[values.length];
42+
for (int i = 0; i < values.length; i++) {
43+
this.values[i] = values[i];
44+
}
45+
}
46+
47+
public TermsJsonFilterBuilder(String name, long... values) {
48+
this.name = name;
49+
this.values = new Long[values.length];
50+
for (int i = 0; i < values.length; i++) {
51+
this.values[i] = values[i];
52+
}
53+
}
54+
55+
public TermsJsonFilterBuilder(String name, float... values) {
56+
this.name = name;
57+
this.values = new Float[values.length];
58+
for (int i = 0; i < values.length; i++) {
59+
this.values[i] = values[i];
60+
}
61+
}
62+
63+
public TermsJsonFilterBuilder(String name, double... values) {
64+
this.name = name;
65+
this.values = new Double[values.length];
66+
for (int i = 0; i < values.length; i++) {
67+
this.values[i] = values[i];
68+
}
69+
}
70+
71+
private TermsJsonFilterBuilder(String name, Object... values) {
72+
this.name = name;
73+
this.values = values;
74+
}
75+
76+
@Override public void doJson(JsonBuilder builder) throws IOException {
77+
builder.startObject(TermsJsonFilterParser.NAME);
78+
builder.startArray(name);
79+
for (Object value : values) {
80+
builder.value(value);
81+
}
82+
builder.endArray();
83+
builder.endObject();
84+
}
85+
}

Diff for: ‎modules/elasticsearch/src/main/java/org/elasticsearch/index/query/json/TermsJsonFilterParser.java

+96
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
/*
2+
* Licensed to Elastic Search and Shay Banon under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. Elastic Search licenses this
6+
* file to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
20+
package org.elasticsearch.index.query.json;
21+
22+
import com.google.inject.Inject;
23+
import org.apache.lucene.index.Term;
24+
import org.apache.lucene.search.Filter;
25+
import org.apache.lucene.search.TermsFilter;
26+
import org.codehaus.jackson.JsonParser;
27+
import org.codehaus.jackson.JsonToken;
28+
import org.elasticsearch.index.AbstractIndexComponent;
29+
import org.elasticsearch.index.Index;
30+
import org.elasticsearch.index.mapper.FieldMapper;
31+
import org.elasticsearch.index.mapper.MapperService;
32+
import org.elasticsearch.index.query.QueryParsingException;
33+
import org.elasticsearch.index.settings.IndexSettings;
34+
import org.elasticsearch.util.settings.Settings;
35+
36+
import java.io.IOException;
37+
38+
import static org.elasticsearch.index.query.support.QueryParsers.*;
39+
40+
/**
41+
* @author kimchy (Shay Banon)
42+
*/
43+
public class TermsJsonFilterParser extends AbstractIndexComponent implements JsonFilterParser {
44+
45+
public static final String NAME = "terms";
46+
47+
@Inject public TermsJsonFilterParser(Index index, @IndexSettings Settings settings) {
48+
super(index, settings);
49+
}
50+
51+
@Override public String name() {
52+
return NAME;
53+
}
54+
55+
@Override public Filter parse(JsonQueryParseContext parseContext) throws IOException, QueryParsingException {
56+
JsonParser jp = parseContext.jp();
57+
58+
JsonToken token = jp.getCurrentToken();
59+
if (token == JsonToken.START_OBJECT) {
60+
token = jp.nextToken();
61+
}
62+
assert token == JsonToken.FIELD_NAME;
63+
String fieldName = jp.getCurrentName();
64+
65+
FieldMapper fieldMapper = null;
66+
MapperService.SmartNameFieldMappers smartNameFieldMappers = parseContext.smartFieldMappers(fieldName);
67+
if (smartNameFieldMappers != null) {
68+
fieldMapper = smartNameFieldMappers.fieldMappers().mapper();
69+
if (fieldMapper != null) {
70+
fieldName = fieldMapper.indexName();
71+
}
72+
}
73+
74+
token = jp.nextToken();
75+
if (token != JsonToken.START_ARRAY) {
76+
throw new QueryParsingException(index, "Terms filter must define the terms to filter on as an array");
77+
}
78+
79+
TermsFilter termsFilter = new TermsFilter();
80+
while ((token = jp.nextToken()) != JsonToken.END_ARRAY) {
81+
String value = jp.getText();
82+
if (value == null) {
83+
throw new QueryParsingException(index, "No value specified for term filter");
84+
}
85+
if (fieldMapper != null) {
86+
value = fieldMapper.indexedValue(value);
87+
}
88+
termsFilter.addTerm(new Term(fieldName, value));
89+
}
90+
jp.nextToken();
91+
92+
93+
Filter filter = parseContext.cacheFilterIfPossible(termsFilter);
94+
return wrapSmartNameFilter(filter, smartNameFieldMappers, parseContext.filterCache());
95+
}
96+
}

Diff for: ‎modules/elasticsearch/src/test/java/org/elasticsearch/index/query/json/SimpleJsonIndexQueryParserTests.java

+31
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
import java.io.IOException;
3636
import java.lang.reflect.Field;
3737
import java.util.List;
38+
import java.util.Set;
3839

3940
import static org.elasticsearch.index.query.json.JsonFilterBuilders.*;
4041
import static org.elasticsearch.index.query.json.JsonQueryBuilders.*;
@@ -376,6 +377,36 @@ public class SimpleJsonIndexQueryParserTests {
376377
assertThat(((TermFilter) filteredQuery.getFilter()).getTerm(), equalTo(new Term("name.last", "banon")));
377378
}
378379

380+
@Test public void testTermsFilterQueryBuilder() throws Exception {
381+
IndexQueryParser queryParser = newQueryParser();
382+
Query parsedQuery = queryParser.parse(filteredQuery(termQuery("name.first", "shay"), termsFilter("name.last", "banon", "kimchy")).build());
383+
assertThat(parsedQuery, instanceOf(FilteredQuery.class));
384+
FilteredQuery filteredQuery = (FilteredQuery) parsedQuery;
385+
assertThat(filteredQuery.getFilter(), instanceOf(TermsFilter.class));
386+
TermsFilter termsFilter = (TermsFilter) filteredQuery.getFilter();
387+
Field field = TermsFilter.class.getDeclaredField("terms");
388+
field.setAccessible(true);
389+
Set<Term> terms = (Set<Term>) field.get(termsFilter);
390+
assertThat(terms.size(), equalTo(2));
391+
assertThat(terms.iterator().next().text(), equalTo("banon"));
392+
}
393+
394+
395+
@Test public void testTermsFilterQuery() throws Exception {
396+
IndexQueryParser queryParser = newQueryParser();
397+
String query = copyToStringFromClasspath("/org/elasticsearch/index/query/json/terms-filter.json");
398+
Query parsedQuery = queryParser.parse(query);
399+
assertThat(parsedQuery, instanceOf(FilteredQuery.class));
400+
FilteredQuery filteredQuery = (FilteredQuery) parsedQuery;
401+
assertThat(filteredQuery.getFilter(), instanceOf(TermsFilter.class));
402+
TermsFilter termsFilter = (TermsFilter) filteredQuery.getFilter();
403+
Field field = TermsFilter.class.getDeclaredField("terms");
404+
field.setAccessible(true);
405+
Set<Term> terms = (Set<Term>) field.get(termsFilter);
406+
assertThat(terms.size(), equalTo(2));
407+
assertThat(terms.iterator().next().text(), equalTo("banon"));
408+
}
409+
379410
@Test public void testConstantScoreQueryBuilder() throws IOException {
380411
IndexQueryParser queryParser = newQueryParser();
381412
Query parsedQuery = queryParser.parse(constantScoreQuery(termFilter("name.last", "banon")));

Diff for: ‎modules/elasticsearch/src/test/java/org/elasticsearch/index/query/json/terms-filter.json

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
filteredQuery : {
3+
query : {
4+
term : { "name.first" : "shay" }
5+
},
6+
filter : {
7+
terms : {
8+
"name.last" : ["banon", "kimchy"]
9+
}
10+
}
11+
}
12+
}

0 commit comments

Comments
 (0)