org.apache.lucene.benchmark.byTask.feeds

Interface DocMaker

public interface DocMaker

Create documents for the test.
Each call to makeDocument would create the next document. When input is exhausted, the DocMaker iterates over the input again, providing a source for unlimited number of documents, though not all of them are unique.
Method Summary
longgetByteCount()
Return total byte size of docs made since last reset.
intgetCount()
Return number of docs made since last reset.
HTMLParsergetHtmlParser()
Returns the htmlParser.
DocumentmakeDocument(int size)
Create the next document, of the given size by input bytes.
DocumentmakeDocument()
Create the next document.
longnumUniqueBytes()
Return total bytes of all available unique texts, 0 if not applicable
intnumUniqueTexts()
Return how many real unique texts are available, 0 if not applicable.
voidprintDocStatistics()
Print some statistics on docs available/added/etc.
voidresetInputs()
Reset inputs so that the test run would behave, input wise, as if it just started.
voidsetConfig(Config config)
Set the properties
voidsetHTMLParser(HTMLParser htmlParser)
Set the html parser to use, when appropriate

Method Detail

getByteCount

public long getByteCount()
Return total byte size of docs made since last reset.

getCount

public int getCount()
Return number of docs made since last reset.

getHtmlParser

public HTMLParser getHtmlParser()
Returns the htmlParser.

makeDocument

public Document makeDocument(int size)
Create the next document, of the given size by input bytes. If the implementation does not support control over size, an exception is thrown.

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

Throws: if cannot make the document, or if size>0 was specified but this feature is not supported.

makeDocument

public Document makeDocument()
Create the next document.

numUniqueBytes

public long numUniqueBytes()
Return total bytes of all available unique texts, 0 if not applicable

numUniqueTexts

public int numUniqueTexts()
Return how many real unique texts are available, 0 if not applicable.

printDocStatistics

public void printDocStatistics()
Print some statistics on docs available/added/etc.

resetInputs

public void resetInputs()
Reset inputs so that the test run would behave, input wise, as if it just started.

setConfig

public void setConfig(Config config)
Set the properties

setHTMLParser

public void setHTMLParser(HTMLParser htmlParser)
Set the html parser to use, when appropriate
Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.