Package org.apache.lucene.benchmark.byTask.feeds

Class DirContentSource

java.lang.Object

org.apache.lucene.benchmark.byTask.feeds.ContentItemsSource

org.apache.lucene.benchmark.byTask.feeds.ContentSource

org.apache.lucene.benchmark.byTask.feeds.DirContentSource

All Implemented Interfaces:

Closeable, AutoCloseable

public class DirContentSource
extends ContentSource

A ContentSource using the Dir collection for its input. Supports the following configuration parameters (on top of ContentSource):

• work.dir - specifies the working directory. Required if "docs.dir" denotes a relative path (default=work).
• docs.dir - specifies the directory the Dir collection. Can be set to a relative path if "work.dir" is also specified (default=dir-out).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DirContentSource.Iterator	Iterator over the files in the directory

Field Summary

Fields inherited from class org.apache.lucene.benchmark.byTask.feeds.ContentItemsSource

encoding, forever, logStep, verbose

Constructor Summary

Constructors

Constructor	Description
DirContentSource()

Method Summary

Modifier and Type	Method	Description
void	close()	Called when reading from this content source is no longer required.
DocData	getNextDocData(DocData docData)	Returns the next DocData from the content source.
void	resetInputs()	Resets the input for this content source, so that the test would behave as if it was just started, input-wise.
void	setConfig(Config config)	Sets the Config for this content source.

Methods inherited from class org.apache.lucene.benchmark.byTask.feeds.ContentItemsSource

addBytes, addItem, collectFiles, getBytesCount, getConfig, getItemsCount, getTotalBytesCount, getTotalItemsCount, printStatistics, shouldLog

Methods inherited from class java.lang.Object

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

Constructor Detail

DirContentSource

public DirContentSource()

Method Detail

close

public void close()
           throws IOException

Description copied from class: ContentItemsSource

Called when reading from this content source is no longer required.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class ContentItemsSource

Throws:

IOException

getNextDocData

public DocData getNextDocData(DocData docData)
                       throws NoMoreDataException,
                              IOException

Description copied from class: ContentSource

Returns the next DocData from the content source. Implementations must account for multi-threading, as multiple threads can call this method simultaneously.

Specified by:

getNextDocData in class ContentSource

Throws:

NoMoreDataException

IOException

resetInputs

public void resetInputs()
                 throws IOException

Description copied from class: ContentItemsSource

Resets the input for this content source, so that the test would behave as if it was just started, input-wise.

NOTE: the default implementation resets the number of bytes and items generated since the last reset, so it's important to call super.resetInputs in case you override this method.

Overrides:

resetInputs in class ContentItemsSource

Throws:

IOException

setConfig

public void setConfig(Config config)

Description copied from class: ContentItemsSource

Sets the Config for this content source. If you override this method, you must call super.setConfig.

Overrides:

setConfig in class ContentItemsSource