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

Class TextFieldMapping.Builder

java.lang.Object

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

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

Enclosing class:

TextFieldMapping

public static class TextFieldMapping.Builder
extends AbstractFieldMapping.Builder

Constructor Summary

Constructors

Constructor	Description
Builder(String name)

Method Summary

Modifier and Type	Method	Description
TextFieldMapping.Builder	analyzer(AnalyzerDescriptorProvider analyzer)	Specifies the analyzer to be used when indexing the field
TextFieldMapping	build()
TextFieldMapping.Builder	index(boolean indexed)
TextFieldMapping.Builder	searchAnalyzer(AnalyzerDescriptorProvider searchAnalyzer)	Specifies the analyzer to be used when searching the field
TextFieldMapping.Builder	store(boolean stored)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(String name)

Method Details

store

public TextFieldMapping.Builder store(boolean stored)

Overrides:

store in class AbstractFieldMapping.Builder

Parameters:

stored - If true, the field will store the original value so that it can be retrieved. Default = false, i.e. the field can only be searched.

Returns:

this builder

index

public TextFieldMapping.Builder index(boolean indexed)

Overrides:

index in class AbstractFieldMapping.Builder

Parameters:

indexed - If true (default), the field will be indexed so that it can be searched

Returns:

this builder

analyzer

public TextFieldMapping.Builder analyzer(AnalyzerDescriptorProvider analyzer)

Specifies the analyzer to be used when indexing the field

Returns:

this builder

searchAnalyzer

public TextFieldMapping.Builder searchAnalyzer(AnalyzerDescriptorProvider searchAnalyzer)

Specifies the analyzer to be used when searching the field

Returns:

this builder

build

public TextFieldMapping build()

Specified by:

build in class AbstractFieldMapping.Builder

Returns:

a newly created mapping