org.hibernate.search.backend.impl.lucene
Class SharedIndexWorkspaceImpl

java.lang.Object
  org.hibernate.search.backend.impl.lucene.AbstractWorkspaceImpl
      org.hibernate.search.backend.impl.lucene.SharedIndexWorkspaceImpl

All Implemented Interfaces:

Workspace

public class SharedIndexWorkspaceImpl
extends AbstractWorkspaceImpl

Author:

Sanne Grinovero (C) 2011 Red Hat Inc.

Field Summary

Fields inherited from class org.hibernate.search.backend.impl.lucene.AbstractWorkspaceImpl

writerHolder

Constructor Summary

SharedIndexWorkspaceImpl(DirectoryBasedIndexManager indexManager, WorkerBuildContext context, Properties cfg)

Method Summary

void	afterTransactionApplied(boolean someFailureHappened, boolean streaming) Invoked after all changes of a transaction are applied.
void	flush() Makes sure eventually pending changes are made visible to IndexReaders.
org.apache.lucene.index.IndexWriter	getIndexWriter() Gets the IndexWriter, opening one if needed.
org.apache.lucene.index.IndexWriter	getIndexWriter(ErrorContextBuilder errorContextBuilder)
void	notifyWorkApplied(LuceneWork work) Some workspaces need this to determine for example the kind of flush operations which are safe to apply.

Methods inherited from class org.hibernate.search.backend.impl.lucene.AbstractWorkspaceImpl

areSingleTermDeletesSafe, getAnalyzer, getDocumentBuilder, getEntitiesInIndexManager, incrementModificationCounter, optimizerPhase, performOptimization, shutDownNow

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedIndexWorkspaceImpl

public SharedIndexWorkspaceImpl(DirectoryBasedIndexManager indexManager,
                                WorkerBuildContext context,
                                Properties cfg)

Method Detail

afterTransactionApplied

public void afterTransactionApplied(boolean someFailureHappened,
                                    boolean streaming)

Description copied from interface: Workspace

Invoked after all changes of a transaction are applied. Must be invoked strictly once after every Workspace.getIndexWriter() in a finally block as implementations might rely on counters to release the IndexWriter.

Specified by:

afterTransactionApplied in interface Workspace

Specified by:

afterTransactionApplied in class AbstractWorkspaceImpl

Parameters:

someFailureHappened - usually false, set to true if errors where caught while using the IndexWriter

streaming - if no immediate visibility of the change is required (hint for performance)

getIndexWriter

public org.apache.lucene.index.IndexWriter getIndexWriter()

Description copied from interface: Workspace

Gets the IndexWriter, opening one if needed.

Specified by:

getIndexWriter in interface Workspace

Overrides:

getIndexWriter in class AbstractWorkspaceImpl

Returns:

a new IndexWriter or an already open one, or null if an error happened.

getIndexWriter

public org.apache.lucene.index.IndexWriter getIndexWriter(ErrorContextBuilder errorContextBuilder)

Overrides:

getIndexWriter in class AbstractWorkspaceImpl

flush

public void flush()

Description copied from interface: Workspace

Makes sure eventually pending changes are made visible to IndexReaders.

notifyWorkApplied

public void notifyWorkApplied(LuceneWork work)

Description copied from interface: Workspace

Some workspaces need this to determine for example the kind of flush operations which are safe to apply. Generally used for statistics.

Parameters:

work - the LuceneWork which was just processed