org.apache.camel.builder.component.dsl

Interface LuceneComponentBuilderFactory.LuceneComponentBuilder

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.lucene.LuceneComponent>

All Known Implementing Classes:

LuceneComponentBuilderFactory.LuceneComponentBuilderImpl

Enclosing interface:

LuceneComponentBuilderFactory

public static interface LuceneComponentBuilderFactory.LuceneComponentBuilder
extends ComponentBuilder<org.apache.camel.component.lucene.LuceneComponent>

Builder for the Lucene component.

Method Summary

Modifier and Type	Method and Description
default LuceneComponentBuilderFactory.LuceneComponentBuilder	analyzer(org.apache.lucene.analysis.Analyzer analyzer) An Analyzer builds TokenStreams, which analyze text.
default LuceneComponentBuilderFactory.LuceneComponentBuilder	autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled.
default LuceneComponentBuilderFactory.LuceneComponentBuilder	config(org.apache.camel.component.lucene.LuceneConfiguration config) To use a shared lucene configuration.
default LuceneComponentBuilderFactory.LuceneComponentBuilder	indexDir(File indexDir) A file system directory in which index files are created upon analysis of the document by the specified analyzer.
default LuceneComponentBuilderFactory.LuceneComponentBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default LuceneComponentBuilderFactory.LuceneComponentBuilder	maxHits(int maxHits) An integer value that limits the result set of the search operation.
default LuceneComponentBuilderFactory.LuceneComponentBuilder	srcDir(File srcDir) An optional directory containing files to be used to be analyzed and added to the index at producer startup.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

build, build, doSetProperty, register

Method Detail

analyzer

default LuceneComponentBuilderFactory.LuceneComponentBuilder analyzer(org.apache.lucene.analysis.Analyzer analyzer)

An Analyzer builds TokenStreams, which analyze text. It thus represents a policy for extracting index terms from text. The value for analyzer can be any class that extends the abstract class org.apache.lucene.analysis.Analyzer. Lucene also offers a rich set of analyzers out of the box. The option is a: <code>org.apache.lucene.analysis.Analyzer</code> type. Group: producer

Parameters:

analyzer - the value to set

Returns:

the dsl builder

indexDir

default LuceneComponentBuilderFactory.LuceneComponentBuilder indexDir(File indexDir)

A file system directory in which index files are created upon analysis of the document by the specified analyzer. The option is a: <code>java.io.File</code> type. Group: producer

Parameters:

indexDir - the value to set

Returns:

the dsl builder

lazyStartProducer

default LuceneComponentBuilderFactory.LuceneComponentBuilder lazyStartProducer(boolean lazyStartProducer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

maxHits

default LuceneComponentBuilderFactory.LuceneComponentBuilder maxHits(int maxHits)

An integer value that limits the result set of the search operation. The option is a: <code>int</code> type. Group: producer

Parameters:

maxHits - the value to set

Returns:

the dsl builder

srcDir

default LuceneComponentBuilderFactory.LuceneComponentBuilder srcDir(File srcDir)

An optional directory containing files to be used to be analyzed and added to the index at producer startup. The option is a: <code>java.io.File</code> type. Group: producer

Parameters:

srcDir - the value to set

Returns:

the dsl builder

autowiredEnabled

default LuceneComponentBuilderFactory.LuceneComponentBuilder autowiredEnabled(boolean autowiredEnabled)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced

Parameters:

autowiredEnabled - the value to set

Returns:

the dsl builder

config

default LuceneComponentBuilderFactory.LuceneComponentBuilder config(org.apache.camel.component.lucene.LuceneConfiguration config)

To use a shared lucene configuration. The option is a: <code>org.apache.camel.component.lucene.LuceneConfiguration</code> type. Group: advanced

Parameters:

config - the value to set

Returns:

the dsl builder