org.apache.lucene.benchmark.byTask.feeds
Class BasicDocMaker

java.lang.Object
  org.apache.lucene.benchmark.byTask.feeds.BasicDocMaker

All Implemented Interfaces:

DocMaker

Direct Known Subclasses:

ReutersDocMaker, SimpleDocMaker, TrecDocMaker

public abstract class BasicDocMaker
extends Object
implements DocMaker

Create documents for the test. Maintains counters of chars etc. so that sub-classes just need to provide textual content, and the create-by-size is handled here.

Field Summary

protected Config	config
protected Field.Index	indexVal
protected Field.Store	storeVal
protected Field.TermVector	termVecVal

Constructor Summary

BasicDocMaker()

Method Summary

protected void	addBytes(long n)
protected void	addUniqueBytes(long n)
protected void	collectFiles(File f, ArrayList inputFiles)
long	getByteCount() Return total byte size of docs made since last reset.
int	getCount() Return number of docs made since last reset.
protected abstract org.apache.lucene.benchmark.byTask.feeds.BasicDocMaker.DocData	getNextDocData() Return the data of the next document.
Document	makeDocument() Create the next document.
Document	makeDocument(int size) Create the next document, of the given size by input bytes.
long	numUniqueBytes() Return total bytes of all available unique texts, 0 if not applicable
void	printDocStatistics() Print some statistics on docs available/added/etc.
void	resetInputs() Reset inputs so that the test run would behave, input wise, as if it just started.
void	setConfig(Config config) Set the properties

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.benchmark.byTask.feeds.DocMaker

numUniqueTexts

Field Detail

config

protected Config config

storeVal

protected Field.Store storeVal

indexVal

protected Field.Index indexVal

termVecVal

protected Field.TermVector termVecVal

Constructor Detail

BasicDocMaker

public BasicDocMaker()

Method Detail

getNextDocData

protected abstract org.apache.lucene.benchmark.byTask.feeds.BasicDocMaker.DocData getNextDocData()
                                                                                          throws Exception

Return the data of the next document.

Returns:

data of the next document.

Throws:

if - cannot create the next doc data

Exception

makeDocument

public Document makeDocument()
                      throws Exception

Description copied from interface: DocMaker

Create the next document.

Specified by:

makeDocument in interface DocMaker

Throws:

Exception

makeDocument

public Document makeDocument(int size)
                      throws Exception

Description copied from interface: DocMaker

Create the next document, of the given size by input bytes. If the implementation does not support control over size, an exception is thrown.

Specified by:

makeDocument in interface DocMaker

Parameters:

size - size of document, or 0 if there is no size requirement.

Throws:

Exception

setConfig

public void setConfig(Config config)

Description copied from interface: DocMaker

Set the properties

Specified by:

setConfig in interface DocMaker

resetInputs

public void resetInputs()

Description copied from interface: DocMaker

Reset inputs so that the test run would behave, input wise, as if it just started.

Specified by:

resetInputs in interface DocMaker

numUniqueBytes

public long numUniqueBytes()

Description copied from interface: DocMaker

Return total bytes of all available unique texts, 0 if not applicable

Specified by:

numUniqueBytes in interface DocMaker

getCount

public int getCount()

Description copied from interface: DocMaker

Return number of docs made since last reset.

Specified by:

getCount in interface DocMaker

getByteCount

public long getByteCount()

Description copied from interface: DocMaker

Return total byte size of docs made since last reset.

Specified by:

getByteCount in interface DocMaker

addUniqueBytes

protected void addUniqueBytes(long n)

addBytes

protected void addBytes(long n)

printDocStatistics

public void printDocStatistics()

Description copied from interface: DocMaker

Print some statistics on docs available/added/etc.

Specified by:

printDocStatistics in interface DocMaker

collectFiles

protected void collectFiles(File f,
                            ArrayList inputFiles)