Package org.apache.jackrabbit.oak.plugins.index

Class IndexUtils

java.lang.Object

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

public final class IndexUtils
extends Object

TODO document

Method Summary

Modifier and Type	Method	Description
static Tree	createIndexDefinition(@NotNull Tree indexNode, @NotNull String indexDefName, boolean unique, @NotNull String[] propertyNames, @NotNull String... declaringNodeTypeNames)	Create a new property2 index definition below the given indexNode.
static Tree	createIndexDefinition(@NotNull Tree indexNode, @NotNull String indexDefName, boolean unique, @NotNull Collection<String> propertyNames, @Nullable Collection<String> declaringNodeTypeNames, @NotNull String propertyIndexType, @Nullable Map<String,String> properties)	Create a new property index definition below the given indexNode of the provided propertyIndexType.
static NodeBuilder	createIndexDefinition(@NotNull NodeBuilder index, @NotNull String indexDefName, boolean reindex, boolean unique, @NotNull Collection<String> propertyNames, @Nullable Collection<String> declaringNodeTypeNames)	Create a new property index definition below the given indexNode.
static NodeBuilder	createIndexDefinition(@NotNull NodeBuilder indexNode, @NotNull String indexDefName, boolean unique, @NotNull Iterable<String> propertyNames, @Nullable String[] declaringNodeTypeNames, @NotNull String propertyIndexType, Map<String,String> properties)	Create a new property index definition below the given indexNode of the provided propertyIndexType.
static void	createReferenceIndex(@NotNull NodeBuilder index)
static @Nullable String	getAsyncLaneName(NodeState idxState, String indexPath)
static @Nullable String	getAsyncLaneName(NodeState idxState, String indexPath, PropertyState async)
static @NotNull String	getCaller(@Nullable String[] ignoredJavaPackages)	Retrieves the calling class and method from the call stack; this is determined by unwinding the stack until it finds a combination of full qualified classname + method (separated by ".") which do not start with any of the values provided by the ignoredJavaPackages parameters.
static NodeBuilder	getOrCreateOakIndex(NodeBuilder root)
static boolean	isIndexNodeType(NodeState state)
static boolean	isIndexNodeType(NodeState state, String typeIn)

Methods inherited from class java.lang.Object

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

Method Detail

getOrCreateOakIndex

public static NodeBuilder getOrCreateOakIndex(NodeBuilder root)

createIndexDefinition

public static NodeBuilder createIndexDefinition(@NotNull
                                                @NotNull NodeBuilder index,
                                                @NotNull
                                                @NotNull String indexDefName,
                                                boolean reindex,
                                                boolean unique,
                                                @NotNull
                                                @NotNull Collection<String> propertyNames,
                                                @Nullable
                                                @Nullable Collection<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 Tree createIndexDefinition(@NotNull
                                         @NotNull Tree indexNode,
                                         @NotNull
                                         @NotNull String indexDefName,
                                         boolean unique,
                                         @NotNull
                                         @NotNull String[] propertyNames,
                                         @NotNull
                                         @NotNull 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 Tree createIndexDefinition(@NotNull
                                         @NotNull Tree indexNode,
                                         @NotNull
                                         @NotNull String indexDefName,
                                         boolean unique,
                                         @NotNull
                                         @NotNull Collection<String> propertyNames,
                                         @Nullable
                                         @Nullable Collection<String> declaringNodeTypeNames,
                                         @NotNull
                                         @NotNull String propertyIndexType,
                                         @Nullable
                                         @Nullable Map<String,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

createReferenceIndex

public static void createReferenceIndex(@NotNull
                                        @NotNull NodeBuilder index)

isIndexNodeType

public static boolean isIndexNodeType(NodeState state)

isIndexNodeType

public static boolean isIndexNodeType(NodeState state,
                                      String typeIn)

createIndexDefinition

public static NodeBuilder createIndexDefinition(@NotNull
                                                @NotNull NodeBuilder indexNode,
                                                @NotNull
                                                @NotNull String indexDefName,
                                                boolean unique,
                                                @NotNull
                                                @NotNull Iterable<String> propertyNames,
                                                @Nullable
                                                @Nullable String[] declaringNodeTypeNames,
                                                @NotNull
                                                @NotNull String propertyIndexType,
                                                Map<String,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

getAsyncLaneName

@Nullable
public static @Nullable String getAsyncLaneName(NodeState idxState,
                                                String indexPath)

getAsyncLaneName

@Nullable
public static @Nullable String getAsyncLaneName(NodeState idxState,
                                                String indexPath,
                                                PropertyState async)

getCaller

@NotNull
public static @NotNull String getCaller(@Nullable
                                        @Nullable String[] ignoredJavaPackages)

Retrieves the calling class and method from the call stack; this is determined by unwinding the stack until it finds a combination of full qualified classname + method (separated by ".") which do not start with any of the values provided by the ignoredJavaPackages parameters. If the provided parameters cover all stack frames, the whole query is considered to be internal, where the actual caller doesn't matter (or cannot be determined clearly). In this case a short message indicating this is returned. If the ignoredJavaPackages parameter is null or empty, the caller is not looked up, but instead it is assumed, that the feature is not configured; in that case a short messages is returned indicating that the feature is not configured.

Parameters:

ignoredJavaPackages - the java packages or class names

Returns:

the calling class or another non-null value