com.atlassian.jira.index

Class WriterWithStats

java.lang.Object

com.atlassian.jira.index.WriterWithStats

public class WriterWithStats
extends Object

Field Summary

Fields inherited from interface com.atlassian.jira.util.Closeable

CLOSE

Method Summary

Modifier and Type	Method and Description
void	addDocuments(Collection<org.apache.lucene.document.Document> document)
void	close() Closes this stream and releases any system resources associated with it.
void	commit()
void	deleteDocuments(org.apache.lucene.index.Term identifyingTerm)
long	getCommitFrequency()
DefaultIndexEngine.FlushPolicy	getFlushPolicy()
org.apache.lucene.index.IndexWriter	getLuceneWriter()
static com.atlassian.jira.index.Writer	maybeWrap(com.atlassian.jira.index.WriterWrapper delegate, boolean isRamDirectory)
void	optimize() No longer supported, no-op since Jira 8.0
boolean	replaceDocumentsWithVersion(Collection<org.apache.lucene.document.Document> newDocuments) Replace a collection of documents identified by parent entity id IndexDirectoryFactory.Name#getParentEntityIdFieldName() with the new collection newDocuments if the version (= max entity version in newDocuments of the new collection newDocuments as defined by IndexDirectoryFactory.Name#getEntityVersionFromDocument(Document) is greater than or equal to the version of the existing collection (at least a single element exists with version lower then the new collection version.
void	updateDocumentConditionally(org.apache.lucene.index.Term identifyingTerm, org.apache.lucene.document.Document document, String optimisticLockField) Updates the document with the given identifyingTerm if and only if the value optimisticLockField in the index is equal to the value of document.get(optimisticLockField).
void	updateDocuments(org.apache.lucene.index.Term identifyingTerm, Collection<org.apache.lucene.document.Document> document)
int	updateDocumentsWithVersion(Collection<org.apache.lucene.document.Document> newDocuments) For each document in newDocuments updates the index if the version of the newDocuments element is greater than or equal to the version of the document with the same id (as defined by IndexDirectoryFactory.Name.getEntityIdFromDocument(Document)) in this index.

Methods inherited from class java.lang.Object

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

Method Detail

maybeWrap

public static com.atlassian.jira.index.Writer maybeWrap(com.atlassian.jira.index.WriterWrapper delegate,
                                                        boolean isRamDirectory)

getLuceneWriter

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

addDocuments

public void addDocuments(@Nonnull
                         Collection<org.apache.lucene.document.Document> document)
                  throws IOException

Throws:

IOException

deleteDocuments

public void deleteDocuments(@Nonnull
                            org.apache.lucene.index.Term identifyingTerm)
                     throws IOException

Throws:

IOException

updateDocuments

public void updateDocuments(@Nonnull
                            org.apache.lucene.index.Term identifyingTerm,
                            @Nonnull
                            Collection<org.apache.lucene.document.Document> document)
                     throws IOException

Throws:

IOException

updateDocumentConditionally

public void updateDocumentConditionally(@Nonnull
                                        org.apache.lucene.index.Term identifyingTerm,
                                        @Nonnull
                                        org.apache.lucene.document.Document document,
                                        @Nonnull
                                        String optimisticLockField)
                                 throws IOException

Updates the document with the given identifyingTerm if and only if the value optimisticLockField in the index is equal to the value of document.get(optimisticLockField). This is useful for achieving optimistic locking when updating the index (used in conjunction with a "version" or "updated date" field).

Parameters:

identifyingTerm - a Term that uniquely identifies the document to be updated

document - a new Document

optimisticLockField - a String containing a field name

Throws:

IOException

updateDocumentsWithVersion

public int updateDocumentsWithVersion(@Nonnull
                                      Collection<org.apache.lucene.document.Document> newDocuments)
                               throws IOException,
                                      IllegalStateException,
                                      IllegalArgumentException

For each document in newDocuments updates the index if the version of the newDocuments element is greater than or equal to the version of the document with the same id (as defined by IndexDirectoryFactory.Name.getEntityIdFromDocument(Document)) in this index.

Note that this method is only supported if this Writer is for one of the indexes defined in: IndexDirectoryFactory.Name

Note that this method does not replace the existing collection so it cannot be used for applying deletes.

Note that this method fails fast, i.e. it will throw when processing a single document throws and will skip the rest.

Parameters:

newDocuments - collection of documents with ids and versions

Returns:

number of documents updated (not processed, if there were no exceptions all documents in newDocuments were processed)

Throws:

IOException

IllegalStateException

IllegalArgumentException

replaceDocumentsWithVersion

public boolean replaceDocumentsWithVersion(@Nonnull
                                           Collection<org.apache.lucene.document.Document> newDocuments)
                                    throws IOException,
                                           IllegalStateException,
                                           IllegalArgumentException

Replace a collection of documents identified by parent entity id IndexDirectoryFactory.Name#getParentEntityIdFieldName() with the new collection newDocuments if the version (= max entity version in newDocuments of the new collection newDocuments as defined by IndexDirectoryFactory.Name#getEntityVersionFromDocument(Document) is greater than or equal to the version of the existing collection (at least a single element exists with version lower then the new collection version.

Parameters:

newDocuments - collection of documents with parent id and version

Returns:

true if the new collection was added to index

Throws:

IOException

IllegalStateException

IllegalArgumentException

optimize

public void optimize()
              throws IOException

No longer supported, no-op since Jira 8.0

Throws:

IOException

close

public void close()

Description copied from interface: Closeable

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

commit

public void commit()

getFlushPolicy

public DefaultIndexEngine.FlushPolicy getFlushPolicy()

getCommitFrequency

public long getCommitFrequency()