Package lumis.portal.bigdata

Interface IDocumentTypeFieldBuilder<T extends DocumentTypeField>

Type Parameters:

T - the DocumentTypeField type.

All Known Subinterfaces:

IDocumentTypeCompositeFieldBuilder

@StableMinor(version="14.0",
             sinceVersion="9.0")
public interface IDocumentTypeFieldBuilder<T extends DocumentTypeField>

Builder to create DocumentTypeField.

Since:

8.1.0

Version:

$Revision: 24477 $ $Date: 2021-04-28 11:30:36 -0300 (Wed, 28 Apr 2021) $

Method Summary

Modifier and Type	Method	Description
T	build()	Returns the immutable field.
IDocumentTypeFieldBuilder<T>	setAggregatable(boolean isAggregatable)	Sets whether the field's value is aggregatable.
IDocumentTypeFieldBuilder<T>	setAnalyzer(String analyzer)	Sets the field analyzer. The analyzer is an identifier that must be recognized by the current IBigDataRepository implementation.
IDocumentTypeFieldBuilder<T>	setId(String fieldId)	Sets the identifier of the field.
IDocumentTypeFieldBuilder<T>	setIncludeInGlobalSearch(boolean includeInGlobalSearch)	Sets whether the field should be included in global search field.
IDocumentTypeFieldBuilder<T>	setIndexMode(DocumentTypeField.IndexMode index)	Sets the index mode.
IDocumentTypeFieldBuilder<T>	setList(boolean isList)	Sets whether the field's value is a list.

Method Detail

build

T build()

Returns the immutable field.

Returns:

the immutable field.

Since:

8.1.0

setId

IDocumentTypeFieldBuilder<T> setId(String fieldId)

Sets the identifier of the field.

Parameters:

fieldId - the identifier.

Returns:

this builder.

Since:

8.1.0

setIndexMode

IDocumentTypeFieldBuilder<T> setIndexMode(DocumentTypeField.IndexMode index)

Sets the index mode.

Parameters:

index - the index mode.

Returns:

this builder.

Since:

8.1.0

setIncludeInGlobalSearch

IDocumentTypeFieldBuilder<T> setIncludeInGlobalSearch(boolean includeInGlobalSearch)

Sets whether the field should be included in global search field.

Parameters:

includeInGlobalSearch - whether the field should be included in global search field.

Returns:

this builder.

Since:

8.1.0

setList

IDocumentTypeFieldBuilder<T> setList(boolean isList)

Sets whether the field's value is a list.

Parameters:

isList - whether the field's value is a list.

Returns:

this builder.

Since:

8.1.0

setAggregatable

IDocumentTypeFieldBuilder<T> setAggregatable(boolean isAggregatable)

Sets whether the field's value is aggregatable.

Parameters:

isAggregatable - whether the field's value is aggregatable.

Returns:

this builder.

Since:

9.0.0

setAnalyzer

IDocumentTypeFieldBuilder<T> setAnalyzer(String analyzer)

Sets the field analyzer.
The analyzer is an identifier that must be recognized by the current IBigDataRepository implementation.

Parameters:

analyzer - the field analyzer.

Returns:

this builder.

Since:

8.1.0