com.atlassian.jira.index

Class IndexDocumentConfiguration

java.lang.Object

com.atlassian.jira.index.IndexDocumentConfiguration

@ExperimentalApi
public class IndexDocumentConfiguration
extends Object

Document that configures indexing of entityProperties it reads to description in format of: <key entity-key="com.atlassian.jira.thing"> <extract path="foo.bar" type="string"> <!-- "path" tells you what part of the json to extract. "type" could be "number", "string", "text", "date" and tells you how to analyse it --> </<extract> </key> <key prefix="com.atlassian.jira.rank"> <extract...><extract/> </key>

Since:

v6.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexDocumentConfiguration.ConfigurationElement
static class	IndexDocumentConfiguration.ExtractConfiguration
static class	IndexDocumentConfiguration.KeyConfiguration
static class	IndexDocumentConfiguration.Type

Constructor Summary

Constructors

Constructor and Description
IndexDocumentConfiguration(String entityKey, List<IndexDocumentConfiguration.KeyConfiguration> keyConfigurations)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Iterable<IndexDocumentConfiguration.ConfigurationElement>	getConfigurationElements()
String	getEntityKey()
List<IndexDocumentConfiguration.KeyConfiguration>	getKeyConfigurations() List of key that are defined to be scanned in this configuration
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IndexDocumentConfiguration

public IndexDocumentConfiguration(String entityKey,
                                  List<IndexDocumentConfiguration.KeyConfiguration> keyConfigurations)

Method Detail

getKeyConfigurations

public List<IndexDocumentConfiguration.KeyConfiguration> getKeyConfigurations()

List of key that are defined to be scanned in this configuration

Returns:

list of key configurations

getEntityKey

public String getEntityKey()

Returns:

name of entity associated with this configuration

getConfigurationElements

public Iterable<IndexDocumentConfiguration.ConfigurationElement> getConfigurationElements()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object