org.modeshape.jcr.query.engine

Class NoOpQueryIndexWriter

java.lang.Object

org.modeshape.jcr.query.engine.NoOpQueryIndexWriter

All Implemented Interfaces:

IndexWriter

@Immutable
public final class NoOpQueryIndexWriter
extends Object
implements IndexWriter

Field Summary

Fields

Modifier and Type	Field and Description
static NoOpQueryIndexWriter	INSTANCE

Method Summary

Methods

Modifier and Type	Method and Description
void	add(String workspace, NodeKey key, Path path, Name primaryType, Set<Name> mixinTypes, CachedNode.Properties properties) Add to the index the information about a node.
boolean	canBeSkipped() Flag that defines whether this index may be skipped.
void	clearAllIndexes() Clear all indexes of content.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final NoOpQueryIndexWriter INSTANCE

Method Detail

canBeSkipped

public boolean canBeSkipped()

Description copied from interface: IndexWriter

Flag that defines whether this index may be skipped. This is usually the case when the writer has no indexes behind it.

Specified by:

canBeSkipped in interface IndexWriter

Returns:

true if this index writer does not need to be called, or false otherwise

clearAllIndexes

public void clearAllIndexes()

Description copied from interface: IndexWriter

Clear all indexes of content. This method is typically called prior to a re-indexing operation.

Specified by:

clearAllIndexes in interface IndexWriter

add

public void add(String workspace,
       NodeKey key,
       Path path,
       Name primaryType,
       Set<Name> mixinTypes,
       CachedNode.Properties properties)

Description copied from interface: IndexWriter

Add to the index the information about a node.

Specified by:

add in interface IndexWriter

Parameters:

workspace - the workspace in which the node information should be available; may not be null

key - the unique key for the node; may not be null

path - the path of the node; may not be null

primaryType - the primary type of the node; may not be null

mixinTypes - the mixin types for the node; may not be null but may be empty

properties - the properties of the node; may not be null but may be empty