org.neo4j.kernel.api.impl.schema

Class LuceneSchemaIndexBuilder

java.lang.Object

org.neo4j.kernel.api.impl.index.builder.AbstractLuceneIndexBuilder<LuceneSchemaIndexBuilder>

org.neo4j.kernel.api.impl.schema.LuceneSchemaIndexBuilder

public class LuceneSchemaIndexBuilder
extends AbstractLuceneIndexBuilder<LuceneSchemaIndexBuilder>

Helper builder class to simplify construction and instantiation of lucene schema indexes. Most of the values already have most useful default value, that still can be overridden by corresponding builder methods.

See Also:

LuceneSchemaIndex, AbstractLuceneIndexBuilder

Method Summary

Modifier and Type	Method and Description
SchemaIndex	build() Build lucene schema index with specified configuration
static LuceneSchemaIndexBuilder	create() Create new lucene schema index builder.
LuceneSchemaIndexBuilder	uniqueIndex() Transform builder to build unique index
LuceneSchemaIndexBuilder	withIndexConfig(org.neo4j.kernel.api.index.IndexConfiguration indexConfig) Specify lucene schema index config
LuceneSchemaIndexBuilder	withSamplingConfig(org.neo4j.kernel.impl.api.index.sampling.IndexSamplingConfig samplingConfig) Specify lucene schema index sampling config
LuceneSchemaIndexBuilder	withWriterConfig(org.neo4j.function.Factory<org.apache.lucene.index.IndexWriterConfig> writerConfigFactory) Specify Factory of lucene IndexWriterConfig to create IndexWriters.

Methods inherited from class org.neo4j.kernel.api.impl.index.builder.AbstractLuceneIndexBuilder

withConfig, withDirectoryFactory, withFileSystem, withIndexIdentifier, withIndexRootFolder, withIndexStorage, withOperationalMode

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static LuceneSchemaIndexBuilder create()

Create new lucene schema index builder.

Returns:

new LuceneSchemaIndexBuilder

withSamplingConfig

public LuceneSchemaIndexBuilder withSamplingConfig(org.neo4j.kernel.impl.api.index.sampling.IndexSamplingConfig samplingConfig)

Specify lucene schema index sampling config

Parameters:

samplingConfig - sampling config

Returns:

index builder

withIndexConfig

public LuceneSchemaIndexBuilder withIndexConfig(org.neo4j.kernel.api.index.IndexConfiguration indexConfig)

Specify lucene schema index config

Parameters:

indexConfig - index config

Returns:

index builder

withWriterConfig

public LuceneSchemaIndexBuilder withWriterConfig(org.neo4j.function.Factory<org.apache.lucene.index.IndexWriterConfig> writerConfigFactory)

Specify Factory of lucene IndexWriterConfig to create IndexWriters.

Parameters:

writerConfigFactory - the supplier of writer configs

Returns:

index builder

uniqueIndex

public LuceneSchemaIndexBuilder uniqueIndex()

Transform builder to build unique index

Returns:

index builder

build

public SchemaIndex build()

Build lucene schema index with specified configuration

Returns:

lucene schema index