Package lumis.portal.bigdata

Interface IDocumentTypeCompositeFieldBuilder

All Superinterfaces:

IDocumentTypeFieldBuilder<CompositeDocumentTypeField>

@StableMinor(version="14.0",
             sinceVersion="8.1")
public interface IDocumentTypeCompositeFieldBuilder
extends IDocumentTypeFieldBuilder<CompositeDocumentTypeField>

Builder for CompositeDocumentTypeField.

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
IDocumentTypeCompositeFieldBuilder	addField(IDocumentTypeFieldBuilder<?> fieldBuilder)	Adds the given field.
IDocumentTypeCompositeFieldBuilder	setAnalyzer(String analyzer)	Sets the field analyzer. The analyzer is an identifier that must be recognized by the current IBigDataRepository implementation.
IDocumentTypeCompositeFieldBuilder	setId(String fieldId)	Sets the identifier of the field.
IDocumentTypeCompositeFieldBuilder	setIncludeInGlobalSearch(boolean includeInGlobalSearch)	Sets whether the field should be included in global search field.
IDocumentTypeCompositeFieldBuilder	setIndexMode(DocumentTypeField.IndexMode index)	Sets the index mode.
IDocumentTypeCompositeFieldBuilder	setList(boolean isList)	Sets whether the field's value is a list.

Methods inherited from interface lumis.portal.bigdata.IDocumentTypeFieldBuilder

build, setAggregatable

Method Detail

addField

IDocumentTypeCompositeFieldBuilder addField(IDocumentTypeFieldBuilder<?> fieldBuilder)

Adds the given field.

Parameters:

fieldBuilder - the field to be added.

Returns:

this builder.

Since:

8.1.0

See Also:

DocumentTypeFields

setId

IDocumentTypeCompositeFieldBuilder setId(String fieldId)

Description copied from interface: IDocumentTypeFieldBuilder

Sets the identifier of the field.

Specified by:

setId in interface IDocumentTypeFieldBuilder<CompositeDocumentTypeField>

Parameters:

fieldId - the identifier.

Returns:

this builder.

setIndexMode

IDocumentTypeCompositeFieldBuilder setIndexMode(DocumentTypeField.IndexMode index)

Description copied from interface: IDocumentTypeFieldBuilder

Sets the index mode.

Specified by:

setIndexMode in interface IDocumentTypeFieldBuilder<CompositeDocumentTypeField>

Parameters:

index - the index mode.

Returns:

this builder.

setIncludeInGlobalSearch

IDocumentTypeCompositeFieldBuilder setIncludeInGlobalSearch(boolean includeInGlobalSearch)

Description copied from interface: IDocumentTypeFieldBuilder

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

Specified by:

setIncludeInGlobalSearch in interface IDocumentTypeFieldBuilder<CompositeDocumentTypeField>

Parameters:

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

Returns:

this builder.

setList

IDocumentTypeCompositeFieldBuilder setList(boolean isList)

Description copied from interface: IDocumentTypeFieldBuilder

Sets whether the field's value is a list.

Specified by:

setList in interface IDocumentTypeFieldBuilder<CompositeDocumentTypeField>

Parameters:

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

Returns:

this builder.

setAnalyzer

IDocumentTypeCompositeFieldBuilder setAnalyzer(String analyzer)

Description copied from interface: IDocumentTypeFieldBuilder

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

Specified by:

setAnalyzer in interface IDocumentTypeFieldBuilder<CompositeDocumentTypeField>

Parameters:

analyzer - the field analyzer.

Returns:

this builder.