summaryrefslogtreecommitdiff
path: root/src/main/java/org/elasticsearch/index/query/WildcardQueryBuilder.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/org/elasticsearch/index/query/WildcardQueryBuilder.java')
-rw-r--r--src/main/java/org/elasticsearch/index/query/WildcardQueryBuilder.java107
1 files changed, 107 insertions, 0 deletions
diff --git a/src/main/java/org/elasticsearch/index/query/WildcardQueryBuilder.java b/src/main/java/org/elasticsearch/index/query/WildcardQueryBuilder.java
new file mode 100644
index 0000000..a2a2d1a
--- /dev/null
+++ b/src/main/java/org/elasticsearch/index/query/WildcardQueryBuilder.java
@@ -0,0 +1,107 @@
+/*
+ * 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.index.query;
+
+import org.elasticsearch.common.xcontent.XContentBuilder;
+
+import java.io.IOException;
+
+/**
+ * Implements the wildcard search query. Supported wildcards are <tt>*</tt>, which
+ * matches any character sequence (including the empty one), and <tt>?</tt>,
+ * which matches any single character. Note this query can be slow, as it
+ * needs to iterate over many terms. In order to prevent extremely slow WildcardQueries,
+ * a Wildcard term should not start with one of the wildcards <tt>*</tt> or
+ * <tt>?</tt>.
+ *
+ *
+ */
+public class WildcardQueryBuilder extends BaseQueryBuilder implements MultiTermQueryBuilder, BoostableQueryBuilder<WildcardQueryBuilder> {
+
+ private final String name;
+
+ private final String wildcard;
+
+ private float boost = -1;
+
+ private String rewrite;
+
+ private String queryName;
+
+ /**
+ * Implements the wildcard search query. Supported wildcards are <tt>*</tt>, which
+ * matches any character sequence (including the empty one), and <tt>?</tt>,
+ * which matches any single character. Note this query can be slow, as it
+ * needs to iterate over many terms. In order to prevent extremely slow WildcardQueries,
+ * a Wildcard term should not start with one of the wildcards <tt>*</tt> or
+ * <tt>?</tt>.
+ *
+ * @param name The field name
+ * @param wildcard The wildcard query string
+ */
+ public WildcardQueryBuilder(String name, String wildcard) {
+ this.name = name;
+ this.wildcard = wildcard;
+ }
+
+ public WildcardQueryBuilder rewrite(String rewrite) {
+ this.rewrite = rewrite;
+ return this;
+ }
+
+ /**
+ * Sets the boost for this query. Documents matching this query will (in addition to the normal
+ * weightings) have their score multiplied by the boost provided.
+ */
+ public WildcardQueryBuilder boost(float boost) {
+ this.boost = boost;
+ return this;
+ }
+
+ /**
+ * Sets the query name for the filter that can be used when searching for matched_filters per hit.
+ */
+ public WildcardQueryBuilder queryName(String queryName) {
+ this.queryName = queryName;
+ return this;
+ }
+
+ @Override
+ public void doXContent(XContentBuilder builder, Params params) throws IOException {
+ builder.startObject(WildcardQueryParser.NAME);
+ if (boost == -1 && rewrite == null && queryName != null) {
+ builder.field(name, wildcard);
+ } else {
+ builder.startObject(name);
+ builder.field("wildcard", wildcard);
+ if (boost != -1) {
+ builder.field("boost", boost);
+ }
+ if (rewrite != null) {
+ builder.field("rewrite", rewrite);
+ }
+ if (queryName != null) {
+ builder.field("_name", queryName);
+ }
+ builder.endObject();
+ }
+ builder.endObject();
+ }
+} \ No newline at end of file