org.modeshape.jcr.spi.index.provider

Class IndexChangeAdapters

java.lang.Object

org.modeshape.jcr.spi.index.provider.IndexChangeAdapters

@Immutable
public class IndexChangeAdapters
extends Object

Utility for creating generic IndexChangeAdapter instances, which support both single and multi-valued properties.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	IndexChangeAdapters.AbstractPropertyChangeAdapter<T>
protected static class	IndexChangeAdapters.EnumeratedPropertyChangeAdapter
protected static class	IndexChangeAdapters.MixinTypesChangeAdapter
protected static class	IndexChangeAdapters.MultiColumnChangeAdapter
protected static class	IndexChangeAdapters.NodeDepthChangeAdapter
protected static class	IndexChangeAdapters.NodeLocalNameChangeAdapter
protected static class	IndexChangeAdapters.NodeNameChangeAdapter
protected static class	IndexChangeAdapters.NodePathChangeAdapter
protected static class	IndexChangeAdapters.NodeTypesChangeAdapter
protected static class	IndexChangeAdapters.PathBasedChangeAdapter<T>
protected static class	IndexChangeAdapters.PrimaryTypeChangeAdapter
protected static class	IndexChangeAdapters.PropertyChangeAdapter<T>
protected static class	IndexChangeAdapters.TextPropertyChangeAdapter
protected static class	IndexChangeAdapters.UniquePropertyChangeAdapter<T>

Method Summary

Modifier and Type	Method and Description
static IndexChangeAdapter	forEnumeratedProperty(ExecutionContext context, ChangeSetAdapter.NodeTypePredicate matcher, String workspaceName, Name propertyName, ProvidedIndex<?> index) Create an IndexChangeAdapter implementation that handles a enumerated properties, either single or multi-valued.
static IndexChangeAdapter	forMixinTypes(ExecutionContext context, ChangeSetAdapter.NodeTypePredicate matcher, String workspaceName, ProvidedIndex<?> index) Create an IndexChangeAdapter implementation that handles the "jcr:mixinTypes" property.
static IndexChangeAdapter	forMultipleColumns(ExecutionContext context, ChangeSetAdapter.NodeTypePredicate matcher, String workspaceName, ProvidedIndex<?> index, Iterable<IndexChangeAdapter> adapters) Creates a composite change adapter which handles the case when an index has multiple columns.
static IndexChangeAdapter	forNodeDepth(ExecutionContext context, ChangeSetAdapter.NodeTypePredicate matcher, String workspaceName, ProvidedIndex<?> index) Create an IndexChangeAdapter implementation that handles the "mode:nodeDepth" property.
static IndexChangeAdapter	forNodeLocalName(ExecutionContext context, ChangeSetAdapter.NodeTypePredicate matcher, String workspaceName, ProvidedIndex<?> index) Create an IndexChangeAdapter implementation that handles the "mode:localName" property.
static IndexChangeAdapter	forNodeName(ExecutionContext context, ChangeSetAdapter.NodeTypePredicate matcher, String workspaceName, ProvidedIndex<?> index) Create an IndexChangeAdapter implementation that handles the "jcr:name" property.
static IndexChangeAdapter	forNodePath(ExecutionContext context, ChangeSetAdapter.NodeTypePredicate matcher, String workspaceName, ProvidedIndex<?> index) Create an IndexChangeAdapter implementation that handles the "jcr:path" property.
static IndexChangeAdapter	forNodeTypes(String propertyName, ExecutionContext context, ChangeSetAdapter.NodeTypePredicate matcher, String workspaceName, ProvidedIndex<?> index) Create an IndexChangeAdapter implementation that handles node type information.
static IndexChangeAdapter	forPrimaryType(ExecutionContext context, ChangeSetAdapter.NodeTypePredicate matcher, String workspaceName, ProvidedIndex<?> index) Create an IndexChangeAdapter implementation that handles the "jcr:primaryType" property.
static <T> IndexChangeAdapter	forProperty(ExecutionContext context, ChangeSetAdapter.NodeTypePredicate matcher, String workspaceName, Name propertyName, ValueFactory<T> factory, ProvidedIndex<?> index) Create an IndexChangeAdapter implementation that handles a node property, either single or multi-valued.
static IndexChangeAdapter	forTextProperty(ExecutionContext context, ChangeSetAdapter.NodeTypePredicate matcher, String workspaceName, Name propertyName, ValueFactory<String> factory, ProvidedIndex<?> index) Create an IndexChangeAdapter implementation that handles full text information.
static <T> IndexChangeAdapter	forUniqueValuedProperty(ExecutionContext context, ChangeSetAdapter.NodeTypePredicate matcher, String workspaceName, Name propertyName, ValueFactory<T> factory, ProvidedIndex<?> index) Create an IndexChangeAdapter implementation that handles a unique-valued property, where every property value is unique across all nodes.

Methods inherited from class java.lang.Object

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

Method Detail

forMultipleColumns

public static IndexChangeAdapter forMultipleColumns(ExecutionContext context,
                                                    ChangeSetAdapter.NodeTypePredicate matcher,
                                                    String workspaceName,
                                                    ProvidedIndex<?> index,
                                                    Iterable<IndexChangeAdapter> adapters)

Creates a composite change adapter which handles the case when an index has multiple columns.

Parameters:

context - the execution context; may not be null

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

workspaceName - the name of the workspace; may not be null

index - the index that should be used; may not be null

adapters - an Iterable of existing "discrete" adapters.

Returns:

the new IndexChangeAdapter; never null

forNodeDepth

public static IndexChangeAdapter forNodeDepth(ExecutionContext context,
                                              ChangeSetAdapter.NodeTypePredicate matcher,
                                              String workspaceName,
                                              ProvidedIndex<?> index)

Create an IndexChangeAdapter implementation that handles the "mode:nodeDepth" property.

Parameters:

context - the execution context; may not be null

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

workspaceName - the name of the workspace; may not be null

index - the index that should be used; may not be null

Returns:

the new IndexChangeAdapter; never null

forNodeName

public static IndexChangeAdapter forNodeName(ExecutionContext context,
                                             ChangeSetAdapter.NodeTypePredicate matcher,
                                             String workspaceName,
                                             ProvidedIndex<?> index)

Create an IndexChangeAdapter implementation that handles the "jcr:name" property.

Parameters:

context - the execution context; may not be null

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

workspaceName - the name of the workspace; may not be null

index - the local index that should be used; may not be null

Returns:

the new IndexChangeAdapter; never null

forNodeLocalName

public static IndexChangeAdapter forNodeLocalName(ExecutionContext context,
                                                  ChangeSetAdapter.NodeTypePredicate matcher,
                                                  String workspaceName,
                                                  ProvidedIndex<?> index)

Create an IndexChangeAdapter implementation that handles the "mode:localName" property.

Parameters:

context - the execution context; may not be null

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

workspaceName - the name of the workspace; may not be null

index - the local index that should be used; may not be null

Returns:

the new IndexChangeAdapter; never null

forNodePath

public static IndexChangeAdapter forNodePath(ExecutionContext context,
                                             ChangeSetAdapter.NodeTypePredicate matcher,
                                             String workspaceName,
                                             ProvidedIndex<?> index)

Create an IndexChangeAdapter implementation that handles the "jcr:path" property.

Parameters:

context - the execution context; may not be null

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

workspaceName - the name of the workspace; may not be null

index - the local index that should be used; may not be null

Returns:

the new IndexChangeAdapter; never null

forPrimaryType

public static IndexChangeAdapter forPrimaryType(ExecutionContext context,
                                                ChangeSetAdapter.NodeTypePredicate matcher,
                                                String workspaceName,
                                                ProvidedIndex<?> index)

Create an IndexChangeAdapter implementation that handles the "jcr:primaryType" property.

Parameters:

context - the execution context; may not be null

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

workspaceName - the name of the workspace; may not be null

index - the local index that should be used; may not be null

Returns:

the new IndexChangeAdapter; never null

forMixinTypes

public static IndexChangeAdapter forMixinTypes(ExecutionContext context,
                                               ChangeSetAdapter.NodeTypePredicate matcher,
                                               String workspaceName,
                                               ProvidedIndex<?> index)

Create an IndexChangeAdapter implementation that handles the "jcr:mixinTypes" property.

Parameters:

context - the execution context; may not be null

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

workspaceName - the name of the workspace; may not be null

index - the local index that should be used; may not be null

Returns:

the new IndexChangeAdapter; never null

forProperty

public static <T> IndexChangeAdapter forProperty(ExecutionContext context,
                                                 ChangeSetAdapter.NodeTypePredicate matcher,
                                                 String workspaceName,
                                                 Name propertyName,
                                                 ValueFactory<T> factory,
                                                 ProvidedIndex<?> index)

Create an IndexChangeAdapter implementation that handles a node property, either single or multi-valued.

Parameters:

context - the execution context; may not be null

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

workspaceName - the name of the workspace; may not be null

propertyName - the name of the property; may not be null

factory - the value factory for the property's value type; may not be null

index - the local index that should be used; may not be null

Returns:

the new IndexChangeAdapter; never null

forUniqueValuedProperty

public static <T> IndexChangeAdapter forUniqueValuedProperty(ExecutionContext context,
                                                             ChangeSetAdapter.NodeTypePredicate matcher,
                                                             String workspaceName,
                                                             Name propertyName,
                                                             ValueFactory<T> factory,
                                                             ProvidedIndex<?> index)

Create an IndexChangeAdapter implementation that handles a unique-valued property, where every property value is unique across all nodes.

Parameters:

context - the execution context; may not be null

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

workspaceName - the name of the workspace; may not be null

propertyName - the name of the property; may not be null

factory - the value factory for the property's value type; may not be null

index - the local index that should be used; may not be null

Returns:

the new IndexChangeAdapter; never null

forEnumeratedProperty

public static IndexChangeAdapter forEnumeratedProperty(ExecutionContext context,
                                                       ChangeSetAdapter.NodeTypePredicate matcher,
                                                       String workspaceName,
                                                       Name propertyName,
                                                       ProvidedIndex<?> index)

Create an IndexChangeAdapter implementation that handles a enumerated properties, either single or multi-valued.

Parameters:

context - the execution context; may not be null

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

workspaceName - the name of the workspace; may not be null

propertyName - the name of the property; may not be null

index - the local index that should be used; may not be null

Returns:

the new IndexChangeAdapter; never null

forNodeTypes

public static IndexChangeAdapter forNodeTypes(String propertyName,
                                              ExecutionContext context,
                                              ChangeSetAdapter.NodeTypePredicate matcher,
                                              String workspaceName,
                                              ProvidedIndex<?> index)

Create an IndexChangeAdapter implementation that handles node type information.

Parameters:

propertyName - a symbolic name of the property that will be sent to the ProvidedIndex when the adapter notices that there are either primary type of mixin type changes.

context - the execution context; may not be null

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

workspaceName - the name of the workspace; may not be null

index - the local index that should be used; may not be null

Returns:

the new IndexChangeAdapter; never null

forTextProperty

public static IndexChangeAdapter forTextProperty(ExecutionContext context,
                                                 ChangeSetAdapter.NodeTypePredicate matcher,
                                                 String workspaceName,
                                                 Name propertyName,
                                                 ValueFactory<String> factory,
                                                 ProvidedIndex<?> index)

Create an IndexChangeAdapter implementation that handles full text information.

Parameters:

context - the execution context; may not be null

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

workspaceName - the name of the workspace; may not be null

propertyName - the name of the property; may not be null

factory - the value factory for the property's value type; may not be null

index - the local index that should be used; may not be null

Returns:

the new IndexChangeAdapter; never null