org.apache.jackrabbit.oak.benchmark.util

Class OakIndexUtils.PropertyIndex

java.lang.Object

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

Enclosing class:

OakIndexUtils

public static class OakIndexUtils.PropertyIndex
extends Object

A property index

Constructor Summary

Constructors

Constructor and Description
OakIndexUtils.PropertyIndex()

Method Summary

Methods

Modifier and Type	Method and Description
javax.jcr.Node	create(javax.jcr.Session session) Create the index.
javax.jcr.Node	create(javax.jcr.Session session, String indexType)
OakIndexUtils.PropertyIndex	name(String indexName) Set the index name.
OakIndexUtils.PropertyIndex	nodeTypes(String... nodeTypeNames) Restrict the node types.
OakIndexUtils.PropertyIndex	property(String propertyName) Set the property name.

Methods inherited from class java.lang.Object

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

Constructor Detail

OakIndexUtils.PropertyIndex

public OakIndexUtils.PropertyIndex()

Method Detail

name

public OakIndexUtils.PropertyIndex name(String indexName)

Set the index name. If not set, the index name is the property name.

Parameters:

indexName - the index name

Returns:

this

property

public OakIndexUtils.PropertyIndex property(String propertyName)

Set the property name. This field is mandatory.

Parameters:

propertyName - the property name

Returns:

this

nodeTypes

public OakIndexUtils.PropertyIndex nodeTypes(String... nodeTypeNames)

Restrict the node types.

Parameters:

nodeTypeNames - the list of declaring node types

Returns:

this

create

@Nullable
public javax.jcr.Node create(javax.jcr.Session session)
                      throws javax.jcr.RepositoryException

Create the index.

If this is not a Oak repository, this method does nothing.

If a matching index already exists, this method verifies that the definition matches. If no such index exists, a new one is created.

Parameters:

session - the session to use for creating the index

Returns:

the index node

Throws:

javax.jcr.RepositoryException - if writing to the repository failed, the index definition is incorrect, or if such an index exists but is not compatible with this definition (for example, a different property is indexed)

create

@Nullable
public javax.jcr.Node create(javax.jcr.Session session,
                             String indexType)
                      throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException