Package org.hibernate.search.backend.lucene.document.model.dsl.impl

Class LuceneIndexRootBuilder

java.lang.Object

org.hibernate.search.backend.lucene.document.model.dsl.impl.LuceneIndexRootBuilder

All Implemented Interfaces:

IndexCompositeNodeBuilder, IndexRootBuilder, IndexSchemaBuildContext

public class LuceneIndexRootBuilder
extends Object
implements IndexRootBuilder, IndexSchemaBuildContext

Field Summary

Fields

Modifier and Type	Field	Description
protected LuceneIndexCompositeNodeType.Builder	typeBuilder

Constructor Summary

Constructors

Constructor	Description
LuceneIndexRootBuilder(EventContext indexEventContext, BackendMapperContext backendMapperContext, String mappedTypeName, LuceneAnalysisDefinitionRegistry analysisDefinitionRegistry)

Method Summary

Modifier and Type	Method	Description
<F> IndexSchemaFieldOptionsStep<?,IndexFieldReference<F>>	addField(String relativeFieldName, TreeNodeInclusion inclusion, IndexFieldType<F> indexFieldType)	Create a new field and add it to the current builder.
IndexSchemaFieldTemplateOptionsStep<?>	addFieldTemplate(String templateName, TreeNodeInclusion inclusion, IndexFieldType<?> indexFieldType, String prefix)	Create a new field template and add it to the current builder.
IndexSchemaNamedPredicateOptionsStep	addNamedPredicate(String name, TreeNodeInclusion inclusion, PredicateDefinition definition)	Create a new named predicate and add it to the current builder.
IndexObjectFieldBuilder	addObjectField(String relativeFieldName, TreeNodeInclusion inclusion, ObjectStructure structure)	Create a new object field and add it to the current builder.
IndexSchemaFieldTemplateOptionsStep<?>	addObjectFieldTemplate(String templateName, ObjectStructure structure, String prefix, TreeNodeInclusion inclusion)	Create a new object field template and add it to the current builder.
LuceneIndexModel	build(String indexName)
LuceneIndexFieldTypeFactory	createTypeFactory(IndexFieldTypeDefaultsProvider defaultsProvider)
EventContext	eventContext()
void	explicitRouting()	Inform the model collector that documents will always be provided along with an explicit routing key, to be used to route the document to a specific shard.
LuceneIndexRootBuilder	getRootNodeBuilder()
<I> void	idDslConverter(Class<I> valueType, ToDocumentValueConverter<I,String> converter)	Defines how identifier values passed to the search DSL should be converted to document identifiers.
<I> void	idProjectionConverter(Class<I> valueType, FromDocumentValueConverter<String,I> converter)	Define how values returned when projecting on identifiers should be converted before being returned to the user.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.search.engine.backend.document.model.dsl.spi.IndexCompositeNodeBuilder

addField, addFieldTemplate, addNamedPredicate, addObjectField, addObjectFieldTemplate

Field Detail

typeBuilder

protected final LuceneIndexCompositeNodeType.Builder typeBuilder

Constructor Detail

LuceneIndexRootBuilder

public LuceneIndexRootBuilder(EventContext indexEventContext,
                              BackendMapperContext backendMapperContext,
                              String mappedTypeName,
                              LuceneAnalysisDefinitionRegistry analysisDefinitionRegistry)

Method Detail

eventContext

public EventContext eventContext()

Specified by:

eventContext in interface IndexSchemaBuildContext

Returns:

A list of failure context elements to be passed to the constructor of any SearchException occurring in this context.

createTypeFactory

public LuceneIndexFieldTypeFactory createTypeFactory(IndexFieldTypeDefaultsProvider defaultsProvider)

Specified by:

createTypeFactory in interface IndexRootBuilder

explicitRouting

public void explicitRouting()

Description copied from interface: IndexRootBuilder

Inform the model collector that documents will always be provided along with an explicit routing key, to be used to route the document to a specific shard.

Specified by:

explicitRouting in interface IndexRootBuilder

idDslConverter

public <I> void idDslConverter(Class<I> valueType,
                               ToDocumentValueConverter<I,String> converter)

Description copied from interface: IndexRootBuilder

Defines how identifier values passed to the search DSL should be converted to document identifiers.

When not set, users are expected to pass document identifiers directly.

Specified by:

idDslConverter in interface IndexRootBuilder

Type Parameters:

I - The type of identifier values that can be passed to the DSL.

Parameters:

valueType - The type of values that can be passed to the DSL.

converter - A converter from the given value type to the document identifier (a string).

idProjectionConverter

public <I> void idProjectionConverter(Class<I> valueType,
                                      FromDocumentValueConverter<String,I> converter)

Description copied from interface: IndexRootBuilder

Define how values returned when projecting on identifiers should be converted before being returned to the user.

When not set, users will be returned the document identifier directly.

Specified by:

idProjectionConverter in interface IndexRootBuilder

Type Parameters:

I - The type of values that will be returned when projecting on identifiers.

Parameters:

valueType - The type of values that will be returned when projecting on fields of this type.

converter - A converter from the document identifier (a string) to the given value type.

getRootNodeBuilder

public LuceneIndexRootBuilder getRootNodeBuilder()

build

public LuceneIndexModel build(String indexName)

toString

public String toString()

Overrides:

toString in class Object

addField

public <F> IndexSchemaFieldOptionsStep<?,IndexFieldReference<F>> addField(String relativeFieldName,
                                                                                TreeNodeInclusion inclusion,
                                                                                IndexFieldType<F> indexFieldType)

Description copied from interface: IndexCompositeNodeBuilder

Create a new field and add it to the current builder.

Specified by:

addField in interface IndexCompositeNodeBuilder

Type Parameters:

F - The type of values for the new field

Parameters:

relativeFieldName - The relative name of the new field

inclusion - Whether fields matching this template should be included, provided their parent is included.

indexFieldType - The type of the new field

Returns:

A DSL step where the field can be defined in more details.

addObjectField

public IndexObjectFieldBuilder addObjectField(String relativeFieldName,
                                              TreeNodeInclusion inclusion,
                                              ObjectStructure structure)

Description copied from interface: IndexCompositeNodeBuilder

Create a new object field and add it to the current builder.

Specified by:

addObjectField in interface IndexCompositeNodeBuilder

Parameters:

relativeFieldName - The relative name of the new object field

inclusion - Whether fields matching this template should be included, provided their parent is included.

structure - The structure of the new object field

Returns:

A builder for the new object field

addNamedPredicate

public IndexSchemaNamedPredicateOptionsStep addNamedPredicate(String name,
                                                              TreeNodeInclusion inclusion,
                                                              PredicateDefinition definition)

Description copied from interface: IndexCompositeNodeBuilder

Create a new named predicate and add it to the current builder.

Specified by:

addNamedPredicate in interface IndexCompositeNodeBuilder

Parameters:

name - The relative name of the new named predicate.

inclusion - Whether fields matching this template should be included, provided their parent is included.

definition - The definition of the named predicate.

Returns:

A DSL step where the named predicate can be defined in more details.

addFieldTemplate

public IndexSchemaFieldTemplateOptionsStep<?> addFieldTemplate(String templateName,
                                                               TreeNodeInclusion inclusion,
                                                               IndexFieldType<?> indexFieldType,
                                                               String prefix)

Description copied from interface: IndexCompositeNodeBuilder

Create a new field template and add it to the current builder.

Specified by:

addFieldTemplate in interface IndexCompositeNodeBuilder

Parameters:

templateName - The name of the new template

inclusion - Whether fields matching this template should be included, provided their parent is included.

indexFieldType - The type of the new field template

prefix - A prefix to prepend to the glob pattern and to field paths passed to DocumentElement.addValue(String, Object).

Returns:

A DSL step where the field template can be defined in more details.

addObjectFieldTemplate

public IndexSchemaFieldTemplateOptionsStep<?> addObjectFieldTemplate(String templateName,
                                                                     ObjectStructure structure,
                                                                     String prefix,
                                                                     TreeNodeInclusion inclusion)

Description copied from interface: IndexCompositeNodeBuilder

Create a new object field template and add it to the current builder.

Specified by:

addObjectFieldTemplate in interface IndexCompositeNodeBuilder

Parameters:

templateName - The name of the new template

structure - The structure of the new object field template

prefix - A prefix to prepend to the glob pattern and to field paths passed to DocumentElement.addObject(String).

inclusion - Whether fields matching this template should be included, provided their parent is included.

Returns:

A DSL step where the field template can be defined in more details.