org.apache.jackrabbit.oak.plugins.index

Class IndexUtils

java.lang.Object

org.apache.jackrabbit.oak.plugins.index.IndexUtils

public class IndexUtils
extends java.lang.Object

TODO document

Constructor Summary

Constructors

Constructor and Description
IndexUtils()

Method Summary

Modifier and Type	Method and Description
static NodeBuilder	createIndexDefinition(NodeBuilder index, java.lang.String indexDefName, boolean reindex, boolean unique, java.util.Collection<java.lang.String> propertyNames, java.util.Collection<java.lang.String> declaringNodeTypeNames) Create a new property index definition below the given indexNode.
static NodeBuilder	createIndexDefinition(NodeBuilder indexNode, java.lang.String indexDefName, boolean unique, java.lang.Iterable<java.lang.String> propertyNames, java.lang.String[] declaringNodeTypeNames, java.lang.String propertyIndexType, java.util.Map<java.lang.String,java.lang.String> properties) Create a new property index definition below the given indexNode of the provided propertyIndexType.
static NodeUtil	createIndexDefinition(NodeUtil indexNode, java.lang.String indexDefName, boolean unique, java.lang.String[] propertyNames, java.lang.String[] declaringNodeTypeNames) Create a new property2 index definition below the given indexNode.
static NodeUtil	createIndexDefinition(NodeUtil indexNode, java.lang.String indexDefName, boolean unique, java.lang.String[] propertyNames, java.lang.String[] declaringNodeTypeNames, java.lang.String propertyIndexType) Create a new property index definition below the given indexNode of the provided propertyIndexType.
static NodeUtil	createIndexDefinition(NodeUtil indexNode, java.lang.String indexDefName, boolean unique, java.lang.String[] propertyNames, java.lang.String[] declaringNodeTypeNames, java.lang.String propertyIndexType, java.util.Map<java.lang.String,java.lang.String> properties) Create a new property index definition below the given indexNode of the provided propertyIndexType.
static void	createReferenceIndex(NodeBuilder index)
static NodeBuilder	getOrCreateOakIndex(NodeBuilder root)
static boolean	isIndexNodeType(NodeState state)
static boolean	isIndexNodeType(NodeState state, java.lang.String typeIn)

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexUtils

public IndexUtils()

Method Detail

getOrCreateOakIndex

public static NodeBuilder getOrCreateOakIndex(NodeBuilder root)

createIndexDefinition

public static NodeBuilder createIndexDefinition(NodeBuilder index,
                                                java.lang.String indexDefName,
                                                boolean reindex,
                                                boolean unique,
                                                java.util.Collection<java.lang.String> propertyNames,
                                                java.util.Collection<java.lang.String> declaringNodeTypeNames)

Create a new property index definition below the given indexNode.

Parameters:

index - The oak:index node builder

indexDefName - The name of the new property index.

reindex - true if the the reindex flag should be turned on.

unique - true if the index is expected the assert property uniqueness.

propertyNames - The property names that should be indexed.

declaringNodeTypeNames - The declaring node type names or null.

Returns:

the NodeBuilder of the new index definition.

createIndexDefinition

public static NodeUtil createIndexDefinition(NodeUtil indexNode,
                                             java.lang.String indexDefName,
                                             boolean unique,
                                             java.lang.String[] propertyNames,
                                             java.lang.String[] declaringNodeTypeNames)
                                      throws RepositoryException

Create a new property2 index definition below the given indexNode.

Parameters:

indexNode -

indexDefName -

unique -

propertyNames -

declaringNodeTypeNames -

Throws:

RepositoryException

createIndexDefinition

public static NodeUtil createIndexDefinition(NodeUtil indexNode,
                                             java.lang.String indexDefName,
                                             boolean unique,
                                             java.lang.String[] propertyNames,
                                             java.lang.String[] declaringNodeTypeNames,
                                             java.lang.String propertyIndexType)
                                      throws RepositoryException

Create a new property index definition below the given indexNode of the provided propertyIndexType.

Parameters:

indexNode -

indexDefName -

unique -

propertyNames -

declaringNodeTypeNames -

propertyIndexType -

Throws:

RepositoryException

createReferenceIndex

public static void createReferenceIndex(NodeBuilder index)

isIndexNodeType

public static boolean isIndexNodeType(NodeState state)

isIndexNodeType

public static boolean isIndexNodeType(NodeState state,
                                      java.lang.String typeIn)

createIndexDefinition

public static NodeUtil createIndexDefinition(NodeUtil indexNode,
                                             java.lang.String indexDefName,
                                             boolean unique,
                                             java.lang.String[] propertyNames,
                                             java.lang.String[] declaringNodeTypeNames,
                                             java.lang.String propertyIndexType,
                                             java.util.Map<java.lang.String,java.lang.String> properties)
                                      throws RepositoryException

Create a new property index definition below the given indexNode of the provided propertyIndexType.

Parameters:

indexNode -

indexDefName -

unique -

propertyNames -

declaringNodeTypeNames -

propertyIndexType -

properties - any additional property to be added to the index definition.

Throws:

RepositoryException

createIndexDefinition

public static NodeBuilder createIndexDefinition(NodeBuilder indexNode,
                                                java.lang.String indexDefName,
                                                boolean unique,
                                                java.lang.Iterable<java.lang.String> propertyNames,
                                                java.lang.String[] declaringNodeTypeNames,
                                                java.lang.String propertyIndexType,
                                                java.util.Map<java.lang.String,java.lang.String> properties)
                                         throws RepositoryException

Create a new property index definition below the given indexNode of the provided propertyIndexType.

Parameters:

indexNode - the oak:index

indexDefName - the node for the index definition

unique - true if uniqueness

propertyNames - the list of properties to be indexed

declaringNodeTypeNames -

propertyIndexType - the type of the PropertyIndex

properties - any additional property to be added to the index definition.

Throws:

RepositoryException