Package com.atlassian.confluence.search.v2

Class FieldMappings

java.lang.Object

com.atlassian.confluence.search.v2.FieldMappings

public class FieldMappings
extends Object

Contains the field-mappings associated with a particular index.

Since:

8.6

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FieldMappings.FieldMappingWriter	Writer for creating field mappings physically on the underlying index.

Constructor Summary

Constructors

Constructor	Description
FieldMappings(FieldMappings.FieldMappingWriter writer, MappingDeconflictDarkFeature deconflictDarkFeature)

Method Summary

Modifier and Type	Method	Description
void	addDocumentFields(AtlassianDocument document)	Add the mappings from the fields of the specified document prior to being indexed.
boolean	addMapping(FieldMapping mapping)	Add the specified field mapping if it's not already present.
Collection<FieldMapping>	getFields()

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldMappings

public FieldMappings(FieldMappings.FieldMappingWriter writer,
                     MappingDeconflictDarkFeature deconflictDarkFeature)

Method Detail

getFields

public Collection<FieldMapping> getFields()

addMapping

public boolean addMapping(FieldMapping mapping)
                   throws IndexFieldMappingConflictException

Add the specified field mapping if it's not already present.

Parameters:

mapping -

Returns:

true if the specified mapping was added, or false if it was already present.

Throws:

IndexFieldMappingConflictException - if the name was already registered by a different mapping (if "index.mapping.deconflict" dark-feature is enabled)

addDocumentFields

public void addDocumentFields(AtlassianDocument document)
                       throws IndexFieldMappingConflictException

Add the mappings from the fields of the specified document prior to being indexed.

Parameters:

document -

Throws:

IndexFieldMappingConflictException - if the name was already registered by a different mapping (if "index.mapping.deconflict" dark-feature is enabled)