org.modeshape.jcr.index.local

Class LocalIndexBuilder<T>

java.lang.Object

org.modeshape.jcr.spi.index.provider.ManagedIndexBuilder

org.modeshape.jcr.index.local.LocalIndexBuilder<T>

Type Parameters:

T - the type of value that is indexed

Direct Known Subclasses:

LocalIndexBuilder.SingleColumnIndexBuilder

public abstract class LocalIndexBuilder<T>
extends ManagedIndexBuilder

A builder for local indexes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	LocalIndexBuilder.SingleColumnIndexBuilder<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected MapDB.Serializers	serializers

Fields inherited from class org.modeshape.jcr.spi.index.provider.ManagedIndexBuilder

context, defn, matcher, nodeTypesSupplier, workspaceName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LocalIndexBuilder(ExecutionContext context, IndexDefinition defn, NodeTypes.Supplier nodeTypesSupplier, String workspaceName, ChangeSetAdapter.NodeTypePredicate matcher)

Method Summary

Modifier and Type	Method and Description
static <T> LocalIndexBuilder<T>	create(ExecutionContext context, IndexDefinition defn, NodeTypes.Supplier nodeTypesSupplier, String workspaceName, ChangeSetAdapter.NodeTypePredicate matcher, org.mapdb.DB db) Create a builder for the supplied index definition.
protected abstract Comparator<T>	getComparator()
protected abstract org.mapdb.Serializer<T>	getSerializer()
protected String	indexName()
protected static void	validate(IndexDefinition defn, Problems problems) Validate whether the index definition is acceptable for this provider.

Methods inherited from class org.modeshape.jcr.spi.index.provider.ManagedIndexBuilder

build, buildEnumeratedIndex, buildMultiValueIndex, buildNodeTypeIndex, buildTextIndex, buildUniqueValueIndex, determineActualPropertyType, isMixinTypesIndex, isNodeDepthIndex, isNodeLocalNameIndex, isNodeNameIndex, isNodePathIndex, isPrimaryTypeIndex, isType, matches, matches, name

Methods inherited from class java.lang.Object

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

Field Detail

serializers

protected final MapDB.Serializers serializers

Constructor Detail

LocalIndexBuilder

protected LocalIndexBuilder(ExecutionContext context,
                            IndexDefinition defn,
                            NodeTypes.Supplier nodeTypesSupplier,
                            String workspaceName,
                            ChangeSetAdapter.NodeTypePredicate matcher)

Method Detail

create

public static <T> LocalIndexBuilder<T> create(ExecutionContext context,
                                              IndexDefinition defn,
                                              NodeTypes.Supplier nodeTypesSupplier,
                                              String workspaceName,
                                              ChangeSetAdapter.NodeTypePredicate matcher,
                                              org.mapdb.DB db)

Create a builder for the supplied index definition.

Parameters:

context - the execution context in which the index should operate; may not be null

defn - the index definition; may not be null

nodeTypesSupplier - the supplier of the NodeTypes instance; may not be null

workspaceName - the name of the workspace for which to build the index; may not be null

matcher - the node type matcher used to determine which nodes should be included in the index; may not be null

db - the MapDB DB instance; may not be null

Returns:

the index builder; never null

validate

protected static void validate(IndexDefinition defn,
                               Problems problems)

Validate whether the index definition is acceptable for this provider.

Parameters:

defn - the definition to validate; may not be null

problems - the component to record any problems, errors, or warnings; may not be null

indexName

protected final String indexName()

getSerializer

protected abstract org.mapdb.Serializer<T> getSerializer()

getComparator

protected abstract Comparator<T> getComparator()