org.modeshape.jcr.query.engine

Class NoOpQueryIndexWriter

java.lang.Object

org.modeshape.jcr.query.engine.NoOpQueryIndexWriter

All Implemented Interfaces:

QueryIndexWriter

@Immutable
public final class NoOpQueryIndexWriter
extends Object
implements QueryIndexWriter

Nested Class Summary

Nested classes/interfaces inherited from interface org.modeshape.jcr.spi.query.QueryIndexWriter

QueryIndexWriter.IndexingContext

Field Summary

Fields

Modifier and Type	Field and Description
static NoOpQueryIndexWriter	INSTANCE

Method Summary

Methods

Modifier and Type	Method and Description
void	addBinaryToIndex(Binary binary, QueryIndexWriter.IndexingContext txnCtx)
void	addToIndex(String workspace, NodeKey key, Path path, Name primaryType, Set<Name> mixinTypes, Iterator<Property> propertiesIterator, NodeTypeSchemata schemata, QueryIndexWriter.IndexingContext txnCtx) Add to the index the information about a node.
boolean	canBeSkipped() Flag that defines whether this index may be skipped.
QueryIndexWriter.IndexingContext	createIndexingContext(Transaction txn) Create a new indexing context in which a set of indexing operations will be performed.
boolean	initializedIndexes() Retrieve whether the indexes were initialized and empty upon startup.
void	removeBinariesFromIndex(Iterable<String> sha1s, QueryIndexWriter.IndexingContext txnCtx)
void	removeFromIndex(String workspace, Iterable<NodeKey> keys, QueryIndexWriter.IndexingContext txnCtx)
void	updateIndex(String workspace, NodeKey key, Path path, Name primaryType, Set<Name> mixinTypes, Iterator<Property> properties, NodeTypeSchemata schemata, QueryIndexWriter.IndexingContext txnCtx) Update the index to reflect the new state of the node.

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: QueryIndexWriter

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 QueryIndexWriter

Returns:

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

createIndexingContext

public QueryIndexWriter.IndexingContext createIndexingContext(Transaction txn)

Description copied from interface: QueryIndexWriter

Create a new indexing context in which a set of indexing operations will be performed. Each indexing context is presumed to be all-or-nothing, and is often based upon or part of the underlying transaction.

Specified by:

createIndexingContext in interface QueryIndexWriter

Parameters:

txn - the transaction that this context is to participate in

Returns:

the indexing context, or null if there is no such transactional context

addToIndex

public void addToIndex(String workspace,
              NodeKey key,
              Path path,
              Name primaryType,
              Set<Name> mixinTypes,
              Iterator<Property> propertiesIterator,
              NodeTypeSchemata schemata,
              QueryIndexWriter.IndexingContext txnCtx)

Description copied from interface: QueryIndexWriter

Add to the index the information about a node.

Specified by:

addToIndex in interface QueryIndexWriter

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

propertiesIterator - the iterator over the properties of a node; may not be null but may be empty

schemata - the node type schemata that should be used to determine how the node is to be indexed; may not be null

txnCtx - the transaction context in which the index updates should be made; may not be null

updateIndex

public void updateIndex(String workspace,
               NodeKey key,
               Path path,
               Name primaryType,
               Set<Name> mixinTypes,
               Iterator<Property> properties,
               NodeTypeSchemata schemata,
               QueryIndexWriter.IndexingContext txnCtx)

Description copied from interface: QueryIndexWriter

Update the index to reflect the new state of the node.

Specified by:

updateIndex in interface QueryIndexWriter

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

schemata - the node type schemata that should be used to determine how the node is to be indexed; may not be null

txnCtx - the transaction context in which the index updates should be made; may not be null

initializedIndexes

public boolean initializedIndexes()

Description copied from interface: QueryIndexWriter

Retrieve whether the indexes were initialized and empty upon startup.

Specified by:

initializedIndexes in interface QueryIndexWriter

Returns:

true if the index(es) initially had no content, or false if there was already at least some content in the indexes upon startup

removeFromIndex

public void removeFromIndex(String workspace,
                   Iterable<NodeKey> keys,
                   QueryIndexWriter.IndexingContext txnCtx)

Specified by:

removeFromIndex in interface QueryIndexWriter

addBinaryToIndex

public void addBinaryToIndex(Binary binary,
                    QueryIndexWriter.IndexingContext txnCtx)

Specified by:

addBinaryToIndex in interface QueryIndexWriter

removeBinariesFromIndex

public void removeBinariesFromIndex(Iterable<String> sha1s,
                           QueryIndexWriter.IndexingContext txnCtx)

Specified by:

removeBinariesFromIndex in interface QueryIndexWriter