org.apache.jackrabbit.oak.benchmark.util

Class OakIndexUtils

java.lang.Object

org.apache.jackrabbit.oak.benchmark.util.OakIndexUtils

public class OakIndexUtils
extends Object

A simple utility class for Oak indexes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OakIndexUtils.PropertyIndex A property index

Constructor Summary

Constructors

Constructor and Description
OakIndexUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static Node	luceneIndexDefinition(Session session, String indexDefinitionName, String async, String[] propertyNames, String[] type, Map<String,Map<String,String>> orderedPropsMap, String persistencePath) Helper method to create or update a lucene property index definition.
static Node	orderedIndexDefinition(Session session, String indexDefinitionName, String async, String[] propertyNames, boolean unique, String[] enclosingNodeTypes, String direction) Helper method to create or update an ordered index definition.
static Node	propertyIndexDefinition(Session session, String indexDefinitionName, String[] propertyNames, boolean unique, String[] enclosingNodeTypes) Helper method to create or update a property index definition.

Methods inherited from class java.lang.Object

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

Constructor Detail

OakIndexUtils

public OakIndexUtils()

Method Detail

propertyIndexDefinition

public static Node propertyIndexDefinition(Session session,
                           String indexDefinitionName,
                           String[] propertyNames,
                           boolean unique,
                           String[] enclosingNodeTypes)
                                    throws RepositoryException

Helper method to create or update a property index definition.

Parameters:

session - the session

indexDefinitionName - the name of the node for the index definition

propertyNames - the list of properties to index

unique - if unique or not

enclosingNodeTypes - the enclosing node types

Returns:

the node just created

Throws:

RepositoryException - the repository exception

orderedIndexDefinition

public static Node orderedIndexDefinition(Session session,
                          String indexDefinitionName,
                          String async,
                          String[] propertyNames,
                          boolean unique,
                          String[] enclosingNodeTypes,
                          String direction)
                                   throws RepositoryException

Helper method to create or update an ordered index definition.

Parameters:

session - the session

indexDefinitionName - the name of the node for the index definition

async - whether the indexing is async or not

propertyNames - the list of properties to index

unique - if unique or not

enclosingNodeTypes - the enclosing node types

direction - the direction

Returns:

the node just created

Throws:

RepositoryException - the repository exception

luceneIndexDefinition

public static Node luceneIndexDefinition(Session session,
                         String indexDefinitionName,
                         String async,
                         String[] propertyNames,
                         String[] type,
                         Map<String,Map<String,String>> orderedPropsMap,
                         String persistencePath)
                                  throws RepositoryException

Helper method to create or update a lucene property index definition.

Parameters:

session - the session

indexDefinitionName - the name of the node for the index definition

propertyNames - the list of properties to index

type - the types of the properties in order of the properties

orderedPropsMap - the ordered props and its properties

persistencePath - the path if the persistence=file (default is repository)

Returns:

the node just created

Throws:

RepositoryException - the repository exception