org.elasticsearch.search.suggest.completion.context.CategoryContextMapping Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Show all versions of elasticsearch Show documentation
Elasticsearch subproject :server
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
package org.elasticsearch.search.suggest.completion.context;
import org.apache.lucene.document.SortedDocValuesField;
import org.apache.lucene.document.SortedSetDocValuesField;
import org.apache.lucene.document.StoredField;
import org.apache.lucene.index.IndexableField;
import org.elasticsearch.ElasticsearchParseException;
import org.elasticsearch.common.util.set.Sets;
import org.elasticsearch.index.mapper.DocumentParserContext;
import org.elasticsearch.index.mapper.KeywordFieldMapper;
import org.elasticsearch.index.mapper.LuceneDocument;
import org.elasticsearch.xcontent.XContentBuilder;
import org.elasticsearch.xcontent.XContentParser;
import org.elasticsearch.xcontent.XContentParser.Token;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
/**
* A {@link ContextMapping} that uses a simple string as a criteria
* The suggestions are boosted and/or filtered by their associated
* category (string) value.
* {@link CategoryQueryContext} defines options for constructing
* a unit of query context for this context type
*/
public class CategoryContextMapping extends ContextMapping {
private static final String FIELD_FIELDNAME = "path";
static final String CONTEXT_VALUE = "context";
static final String CONTEXT_BOOST = "boost";
static final String CONTEXT_PREFIX = "prefix";
private final String fieldName;
/**
* Create a new {@link CategoryContextMapping} with field
* fieldName
*/
private CategoryContextMapping(String name, String fieldName) {
super(Type.CATEGORY, name);
this.fieldName = fieldName;
}
/**
* Name of the field to get contexts from at index-time
*/
public String getFieldName() {
return fieldName;
}
/**
* Loads a name
d {@link CategoryContextMapping} instance
* from a map.
* see {@link ContextMappings#load(Object)}
*
* Acceptable map param: path
*/
protected static CategoryContextMapping load(String name, Map config) throws ElasticsearchParseException {
CategoryContextMapping.Builder mapping = new CategoryContextMapping.Builder(name);
Object fieldName = config.get(FIELD_FIELDNAME);
if (fieldName != null) {
mapping.field(fieldName.toString());
config.remove(FIELD_FIELDNAME);
}
return mapping.build();
}
@Override
protected XContentBuilder toInnerXContent(XContentBuilder builder, Params params) throws IOException {
if (fieldName != null) {
builder.field(FIELD_FIELDNAME, fieldName);
}
return builder;
}
/**
* Parse a set of {@link CharSequence} contexts at index-time.
* Acceptable formats:
*
*
* - Array:
[<string>, ..]
* - String:
"string"
*
*/
@Override
public Set parseContext(DocumentParserContext documentParserContext, XContentParser parser) throws IOException,
ElasticsearchParseException {
final Set contexts = new HashSet<>();
Token token = parser.currentToken();
if (token == Token.VALUE_STRING || token == Token.VALUE_NUMBER || token == Token.VALUE_BOOLEAN) {
contexts.add(parser.text());
} else if (token == Token.START_ARRAY) {
while ((token = parser.nextToken()) != Token.END_ARRAY) {
if (token == Token.VALUE_STRING || token == Token.VALUE_NUMBER || token == Token.VALUE_BOOLEAN) {
contexts.add(parser.text());
} else {
throw new ElasticsearchParseException(
"context array must have string, number or boolean values, but was [" + token + "]"
);
}
}
} else {
throw new ElasticsearchParseException(
"contexts must be a string, number or boolean or a list of string, number or boolean, but was [" + token + "]"
);
}
return contexts;
}
@Override
public Set parseContext(LuceneDocument document) {
Set values = null;
if (fieldName != null) {
IndexableField[] fields = document.getFields(fieldName);
values = Sets.newHashSetWithExpectedSize(fields.length);
// TODO we should be checking mapped field types, not lucene field types
for (IndexableField field : fields) {
if (field instanceof SortedDocValuesField || field instanceof SortedSetDocValuesField || field instanceof StoredField) {
// Ignore doc values and stored fields
} else if (field instanceof KeywordFieldMapper.KeywordField) {
values.add(field.binaryValue().utf8ToString());
} else if (field.stringValue() != null) {
values.add(field.stringValue());
} else {
throw new IllegalArgumentException(
"Failed to parse context field [" + fieldName + "], only keyword and text fields are accepted"
);
}
}
}
return (values == null) ? Collections.emptySet() : values;
}
@Override
protected CategoryQueryContext fromXContent(XContentParser parser) throws IOException {
return CategoryQueryContext.fromXContent(parser);
}
/**
* Parse a list of {@link CategoryQueryContext}
* using parser
. A QueryContexts accepts one of the following forms:
*
*
* - Object: CategoryQueryContext
* - String: CategoryQueryContext value with prefix=false and boost=1
* - Array:
[CategoryQueryContext, ..]
*
*
* A CategoryQueryContext has one of the following forms:
*
* - Object:
{"context": <string>, "boost": <int>, "prefix":
* <boolean>}
* - String:
"string"
*
*/
@Override
public List toInternalQueryContexts(List queryContexts) {
List internalInternalQueryContexts = new ArrayList<>(queryContexts.size());
internalInternalQueryContexts.addAll(
queryContexts.stream()
.map(queryContext -> new InternalQueryContext(queryContext.getCategory(), queryContext.getBoost(), queryContext.isPrefix()))
.toList()
);
return internalInternalQueryContexts;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
if (super.equals(o) == false) return false;
CategoryContextMapping mapping = (CategoryContextMapping) o;
return Objects.equals(fieldName, mapping.fieldName);
}
@Override
public int hashCode() {
return Objects.hash(super.hashCode(), fieldName);
}
/**
* Builder for {@link CategoryContextMapping}
*/
public static class Builder extends ContextBuilder {
private String fieldName;
/**
* Create a builder for
* a named {@link CategoryContextMapping}
* @param name name of the mapping
*/
public Builder(String name) {
super(name);
}
/**
* Set the name of the field to use
*/
public Builder field(String fieldName) {
this.fieldName = fieldName;
return this;
}
@Override
public CategoryContextMapping build() {
return new CategoryContextMapping(name, fieldName);
}
}
}