@ExperimentalApi public class

PhraseQuerySupportField

extends Object
java.lang.Object
   ↳ com.atlassian.jira.issue.index.indexers.phrase.PhraseQuerySupportField

@ExperimentalApi

This class is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Class Overview

Encapsulates the information to create a special purpose Field lucene field to be used for quoted phrase query searches for a given JIRA text field.

Summary

Public Constructors
PhraseQuerySupportField()
Public Methods
static String forIndexField(String indexFieldName)
Returns the name of the phrase query support field to build for a given field.
static boolean isPhraseQuerySupportField(String indexFieldName)
Determines whether a given document field is a phrase query support field.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public PhraseQuerySupportField ()

Public Methods

public static String forIndexField (String indexFieldName)

Returns the name of the phrase query support field to build for a given field.

Parameters
indexFieldName The name of the original field.
Returns
  • A String containing the name of the phrase query support field.

public static boolean isPhraseQuerySupportField (String indexFieldName)

Determines whether a given document field is a phrase query support field.

Parameters
indexFieldName the name of the field to inspect.
Returns
  • true if the passed in field is a phrase query support field; otherwise, false.