org.apache.lucene.index

Class RandomIndexWriter

java.lang.Object

org.apache.lucene.index.RandomIndexWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class RandomIndexWriter
extends java.lang.Object
implements java.io.Closeable

Silly class that randomizes the indexing experience. EG it may swap in a different merge policy/scheduler; may commit periodically; may or may not forceMerge in the end, may flush by doc count instead of RAM, etc.

Field Summary

Fields

Modifier and Type	Field and Description
org.apache.lucene.index.IndexWriter	w

Constructor Summary

Constructors

Constructor and Description
RandomIndexWriter(java.util.Random r, org.apache.lucene.store.Directory dir) create a RandomIndexWriter with a random config: Uses TEST_VERSION_CURRENT and Whitespace+LowercasingAnalyzer
RandomIndexWriter(java.util.Random r, org.apache.lucene.store.Directory dir, org.apache.lucene.analysis.Analyzer a) create a RandomIndexWriter with a random config: Uses TEST_VERSION_CURRENT
RandomIndexWriter(java.util.Random r, org.apache.lucene.store.Directory dir, org.apache.lucene.index.IndexWriterConfig c) create a RandomIndexWriter with the provided config
RandomIndexWriter(java.util.Random r, org.apache.lucene.store.Directory dir, org.apache.lucene.util.Version v, org.apache.lucene.analysis.Analyzer a) create a RandomIndexWriter with a random config

Method Summary

Modifier and Type	Method and Description
void	addDocument(org.apache.lucene.document.Document doc) Adds a Document.
void	addDocuments(java.util.Collection<org.apache.lucene.document.Document> docs)
void	addIndexes(org.apache.lucene.store.Directory... dirs)
void	addIndexes(org.apache.lucene.index.IndexReader... readers)
void	close() Close this writer.
void	commit()
void	deleteAll()
void	deleteDocuments(org.apache.lucene.search.Query q)
void	deleteDocuments(org.apache.lucene.index.Term term)
void	forceMerge(int maxSegmentCount) Forces a forceMerge.
void	forceMergeDeletes()
void	forceMergeDeletes(boolean doWait)
org.apache.lucene.index.IndexReader	getReader()
org.apache.lucene.index.IndexReader	getReader(boolean applyDeletions)
int	maxDoc()
int	numDocs()
void	setDoRandomForceMerge(boolean v)
void	setDoRandomForceMergeAssert(boolean v)
void	updateDocument(org.apache.lucene.index.Term t, org.apache.lucene.document.Document doc) Updates a document.
void	updateDocuments(org.apache.lucene.index.Term delTerm, java.util.Collection<org.apache.lucene.document.Document> docs)

Methods inherited from class java.lang.Object

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

Field Detail

w

public org.apache.lucene.index.IndexWriter w

Constructor Detail

RandomIndexWriter

public RandomIndexWriter(java.util.Random r,
                         org.apache.lucene.store.Directory dir)
                  throws java.io.IOException

create a RandomIndexWriter with a random config: Uses TEST_VERSION_CURRENT and Whitespace+LowercasingAnalyzer

Throws:

java.io.IOException

RandomIndexWriter

public RandomIndexWriter(java.util.Random r,
                         org.apache.lucene.store.Directory dir,
                         org.apache.lucene.analysis.Analyzer a)
                  throws java.io.IOException

create a RandomIndexWriter with a random config: Uses TEST_VERSION_CURRENT

Throws:

java.io.IOException

RandomIndexWriter

public RandomIndexWriter(java.util.Random r,
                         org.apache.lucene.store.Directory dir,
                         org.apache.lucene.util.Version v,
                         org.apache.lucene.analysis.Analyzer a)
                  throws java.io.IOException

create a RandomIndexWriter with a random config

Throws:

java.io.IOException

RandomIndexWriter

public RandomIndexWriter(java.util.Random r,
                         org.apache.lucene.store.Directory dir,
                         org.apache.lucene.index.IndexWriterConfig c)
                  throws java.io.IOException

create a RandomIndexWriter with the provided config

Throws:

java.io.IOException

Method Detail

addDocument

public void addDocument(org.apache.lucene.document.Document doc)
                 throws java.io.IOException

Adds a Document.

Throws:

java.io.IOException

See Also:

IndexWriter.addDocument(Document)

addDocuments

public void addDocuments(java.util.Collection<org.apache.lucene.document.Document> docs)
                  throws java.io.IOException

Throws:

java.io.IOException

updateDocuments

public void updateDocuments(org.apache.lucene.index.Term delTerm,
                            java.util.Collection<org.apache.lucene.document.Document> docs)
                     throws java.io.IOException

Throws:

java.io.IOException

updateDocument

public void updateDocument(org.apache.lucene.index.Term t,
                           org.apache.lucene.document.Document doc)
                    throws java.io.IOException

Updates a document.

Throws:

java.io.IOException

See Also:

IndexWriter.updateDocument(Term, Document)

addIndexes

public void addIndexes(org.apache.lucene.store.Directory... dirs)
                throws org.apache.lucene.index.CorruptIndexException,
                       java.io.IOException

Throws:

org.apache.lucene.index.CorruptIndexException

java.io.IOException

addIndexes

public void addIndexes(org.apache.lucene.index.IndexReader... readers)
                throws org.apache.lucene.index.CorruptIndexException,
                       java.io.IOException

Throws:

org.apache.lucene.index.CorruptIndexException

java.io.IOException

deleteDocuments

public void deleteDocuments(org.apache.lucene.index.Term term)
                     throws org.apache.lucene.index.CorruptIndexException,
                            java.io.IOException

Throws:

org.apache.lucene.index.CorruptIndexException

java.io.IOException

deleteDocuments

public void deleteDocuments(org.apache.lucene.search.Query q)
                     throws org.apache.lucene.index.CorruptIndexException,
                            java.io.IOException

Throws:

org.apache.lucene.index.CorruptIndexException

java.io.IOException

commit

public void commit()
            throws org.apache.lucene.index.CorruptIndexException,
                   java.io.IOException

Throws:

org.apache.lucene.index.CorruptIndexException

java.io.IOException

numDocs

public int numDocs()
            throws java.io.IOException

Throws:

java.io.IOException

maxDoc

public int maxDoc()

deleteAll

public void deleteAll()
               throws java.io.IOException

Throws:

java.io.IOException

forceMergeDeletes

public void forceMergeDeletes(boolean doWait)
                       throws java.io.IOException

Throws:

java.io.IOException

forceMergeDeletes

public void forceMergeDeletes()
                       throws java.io.IOException

Throws:

java.io.IOException

setDoRandomForceMerge

public void setDoRandomForceMerge(boolean v)

setDoRandomForceMergeAssert

public void setDoRandomForceMergeAssert(boolean v)

getReader

public org.apache.lucene.index.IndexReader getReader()
                                              throws java.io.IOException

Throws:

java.io.IOException

getReader

public org.apache.lucene.index.IndexReader getReader(boolean applyDeletions)
                                              throws java.io.IOException

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Close this writer.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

See Also:

IndexWriter.close()

forceMerge

public void forceMerge(int maxSegmentCount)
                throws java.io.IOException

Forces a forceMerge.

NOTE: this should be avoided in tests unless absolutely necessary, as it will result in less test coverage.

Throws:

java.io.IOException

See Also:

IndexWriter.forceMerge(int)