org.apache.camel.builder.endpoint.dsl

Interface LuceneEndpointBuilderFactory.LuceneEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

LuceneEndpointBuilderFactory

public static interface LuceneEndpointBuilderFactory.LuceneEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint for the Lucene component.

Method Summary

Modifier and Type	Method and Description
default LuceneEndpointBuilderFactory.LuceneEndpointBuilder	analyzer(Object analyzer) An Analyzer builds TokenStreams, which analyze text.
default LuceneEndpointBuilderFactory.LuceneEndpointBuilder	analyzer(String analyzer) An Analyzer builds TokenStreams, which analyze text.
default LuceneEndpointBuilderFactory.LuceneEndpointBuilder	indexDir(File indexDir) A file system directory in which index files are created upon analysis of the document by the specified analyzer.
default LuceneEndpointBuilderFactory.LuceneEndpointBuilder	indexDir(String indexDir) A file system directory in which index files are created upon analysis of the document by the specified analyzer.
default LuceneEndpointBuilderFactory.LuceneEndpointBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default LuceneEndpointBuilderFactory.LuceneEndpointBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default LuceneEndpointBuilderFactory.LuceneEndpointBuilder	maxHits(int maxHits) An integer value that limits the result set of the search operation.
default LuceneEndpointBuilderFactory.LuceneEndpointBuilder	maxHits(String maxHits) An integer value that limits the result set of the search operation.
default LuceneEndpointBuilderFactory.LuceneEndpointBuilder	srcDir(File srcDir) An optional directory containing files to be used to be analyzed and added to the index at producer startup.
default LuceneEndpointBuilderFactory.LuceneEndpointBuilder	srcDir(String 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.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

analyzer

default LuceneEndpointBuilderFactory.LuceneEndpointBuilder analyzer(Object 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

analyzer

default LuceneEndpointBuilderFactory.LuceneEndpointBuilder analyzer(String 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 will be converted to a <code>org.apache.lucene.analysis.Analyzer</code> type. Group: producer

Parameters:

analyzer - the value to set

Returns:

the dsl builder

indexDir

default LuceneEndpointBuilderFactory.LuceneEndpointBuilder 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

indexDir

default LuceneEndpointBuilderFactory.LuceneEndpointBuilder indexDir(String indexDir)

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

Parameters:

indexDir - the value to set

Returns:

the dsl builder

lazyStartProducer

default LuceneEndpointBuilderFactory.LuceneEndpointBuilder 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

lazyStartProducer

default LuceneEndpointBuilderFactory.LuceneEndpointBuilder lazyStartProducer(String 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 will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

maxHits

default LuceneEndpointBuilderFactory.LuceneEndpointBuilder 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

maxHits

default LuceneEndpointBuilderFactory.LuceneEndpointBuilder maxHits(String maxHits)

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

Parameters:

maxHits - the value to set

Returns:

the dsl builder

srcDir

default LuceneEndpointBuilderFactory.LuceneEndpointBuilder 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

srcDir

default LuceneEndpointBuilderFactory.LuceneEndpointBuilder srcDir(String srcDir)

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

Parameters:

srcDir - the value to set

Returns:

the dsl builder