Package com.atlassian.confluence.plugins.index.api.mapping

Class TextFieldMapping

java.lang.Object

com.atlassian.confluence.plugins.index.api.mapping.AbstractFieldMapping

com.atlassian.confluence.plugins.index.api.mapping.TextFieldMapping

All Implemented Interfaces:

FieldMapping

public class TextFieldMapping
extends AbstractFieldMapping

Field mapping for analyzed text.

Since:

8.6

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextFieldMapping.Builder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TextFieldMapping(TextFieldMapping.Builder builder)

Method Summary

Modifier and Type	Method	Description
<T> T	accept(FieldMappingVisitor<T> visitor)	Applies the supplied visitor to this field mapping with its respective callback.
static TextFieldMapping.Builder	builder(String name)
FieldDescriptor	createField(String value)	Create a field for the current mapping with the given value
boolean	equals(Object o)
AnalyzerDescriptorProvider	getAnalyzer()	Analyzer to be used when indexing the field
AnalyzerDescriptorProvider	getSearchAnalyzer()	Analyzer to be used when searching the field
int	hashCode()
String	toString()

Methods inherited from class com.atlassian.confluence.plugins.index.api.mapping.AbstractFieldMapping

getName, isIndexed, isStored

Methods inherited from class java.lang.Object

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

Constructor Detail

TextFieldMapping

protected TextFieldMapping(TextFieldMapping.Builder builder)

Method Detail

getAnalyzer

public AnalyzerDescriptorProvider getAnalyzer()

Analyzer to be used when indexing the field

Returns:

The analyzer to be used when indexing the field

getSearchAnalyzer

public AnalyzerDescriptorProvider getSearchAnalyzer()

Analyzer to be used when searching the field

Returns:

The analyzer to be used when searching the field

createField

public FieldDescriptor createField(String value)

Create a field for the current mapping with the given value

Parameters:

value -

Returns:

the newly created field

accept

public <T> T accept(FieldMappingVisitor<T> visitor)

Description copied from interface: FieldMapping

Applies the supplied visitor to this field mapping with its respective callback.

Parameters:

visitor - The visitor to dispatch

Returns:

The value that is returned by the supplied visitor

toString

public String toString()

Overrides:

toString in class AbstractFieldMapping

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractFieldMapping

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractFieldMapping

builder

public static TextFieldMapping.Builder builder(String name)