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

static class	IndexDocumentConfiguration.ExtractConfiguration
static class	IndexDocumentConfiguration.IndexDocumentConfigurationParseException
static class	IndexDocumentConfiguration.KeyConfiguration
static class	IndexDocumentConfiguration.Type

Field Summary

static String	INDEX_DOCUMENT_CONFIGURATION_ROOT
static String	INDEX_DOCUMENT_ENTITY_KEY_ATTRIBUTE
static String	INDEX_DOCUMENT_EXTRACT_ELEMENT
static String	INDEX_DOCUMENT_EXTRACT_PATH_ATTRIBUTE
static String	INDEX_DOCUMENT_EXTRACT_TYPE_ATTRIBUTE
static String	INDEX_DOCUMENT_KEY_ELEMENT
static String	INDEX_DOCUMENT_KEY_PROPERTY_KEY_ATTRIBUTE

Constructor Summary

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

Method Summary

static IndexDocumentConfiguration	fromXML(org.dom4j.Element element)
static IndexDocumentConfiguration	fromXML(String element)
String	getEntityKey()
List<IndexDocumentConfiguration.KeyConfiguration>	getKeyConfigurations() List of key that are defined to be scanned in this configuration
String	toXML()

Methods inherited from class java.lang.Object

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

Field Detail

INDEX_DOCUMENT_CONFIGURATION_ROOT

public static final String INDEX_DOCUMENT_CONFIGURATION_ROOT

See Also:

Constant Field Values

INDEX_DOCUMENT_KEY_ELEMENT

public static final String INDEX_DOCUMENT_KEY_ELEMENT

See Also:

Constant Field Values

INDEX_DOCUMENT_ENTITY_KEY_ATTRIBUTE

public static final String INDEX_DOCUMENT_ENTITY_KEY_ATTRIBUTE

See Also:

Constant Field Values

INDEX_DOCUMENT_KEY_PROPERTY_KEY_ATTRIBUTE

public static final String INDEX_DOCUMENT_KEY_PROPERTY_KEY_ATTRIBUTE

See Also:

Constant Field Values

INDEX_DOCUMENT_EXTRACT_ELEMENT

public static final String INDEX_DOCUMENT_EXTRACT_ELEMENT

See Also:

Constant Field Values

INDEX_DOCUMENT_EXTRACT_PATH_ATTRIBUTE

public static final String INDEX_DOCUMENT_EXTRACT_PATH_ATTRIBUTE

See Also:

Constant Field Values

INDEX_DOCUMENT_EXTRACT_TYPE_ATTRIBUTE

public static final String INDEX_DOCUMENT_EXTRACT_TYPE_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

IndexDocumentConfiguration

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

Method Detail

fromXML

public static IndexDocumentConfiguration fromXML(String element)
                                          throws IndexDocumentConfiguration.IndexDocumentConfigurationParseException

Throws:

IndexDocumentConfiguration.IndexDocumentConfigurationParseException

fromXML

public static IndexDocumentConfiguration fromXML(org.dom4j.Element element)
                                          throws IndexDocumentConfiguration.IndexDocumentConfigurationParseException

Throws:

IndexDocumentConfiguration.IndexDocumentConfigurationParseException

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

toXML

public String toXML()