com.atlassian.confluence.search.v2.elasticsearch

Class ESFieldNameTranslator

java.lang.Object

com.atlassian.confluence.search.v2.elasticsearch.ESFieldNameTranslator

@Internal
public final class ESFieldNameTranslator
extends Object

When searching against ES, a field name in a search query is not the same as one from indexed document because ES document builder appends type and language symbol at the end of a field name to support hungarian notation in dynamic mapping rules. This class contains helper methods that translate a field name between to its internal form.

Since:

5.10

Constructor Summary

Constructors

Constructor and Description
ESFieldNameTranslator()

Method Summary

Modifier and Type	Method and Description
static String	translate(String fieldName) Replace '.' with '_' as ES 2.x does not allow field names with dots.
static String	wildcardAllFieldsInQuery(String query) This method appends escape + asterisk to each field name in query string and replaces the original field name by the new field name e.g title: "hello world" will become title\*: "hello world" so ES will search for any field names starting with title.
static String	wildcardField(String fieldName) This method appends asterisk into field name e.g title will become title* so ES will search for any field names starting with title.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ESFieldNameTranslator

public ESFieldNameTranslator()

Method Detail

translate

public static String translate(String fieldName)

Replace '.' with '_' as ES 2.x does not allow field names with dots.

Parameters:

fieldName -

Returns:

translated fieldName

wildcardField

public static String wildcardField(String fieldName)

This method appends asterisk into field name e.g title will become title* so ES will search for any field names starting with title.

Parameters:

fieldName -

Returns:

translated fieldName with asterisk at the end

wildcardAllFieldsInQuery

public static String wildcardAllFieldsInQuery(String query)

This method appends escape + asterisk to each field name in query string and replaces the original field name by the new field name e.g title: "hello world" will become title\*: "hello world" so ES will search for any field names starting with title.

Parameters:

query -

Returns:

translated query with escape + asterisk being added at the end of specified field names.