org.apache.lucene.benchmark.byTask.feeds
Interface DocMaker

All Known Implementing Classes:
BasicDocMaker

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, does provifing a source for unlimited number of documents, though not all of them are unique.


Method Summary
 long getByteCount()
          Return total byte size of docs made since last reset.
 int getCount()
          Return number of docs made since last reset.
 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
 int numUniqueTexts()
          Return how many real unique texts are available, 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
 

Method Detail

makeDocument

public Document makeDocument(int size)
                      throws Exception
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.
Exception

makeDocument

public Document makeDocument()
                      throws Exception
Create the next document.

Throws:
Exception

setConfig

public void setConfig(Config config)
Set the properties


resetInputs

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


numUniqueTexts

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


numUniqueBytes

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


getCount

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


getByteCount

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


printDocStatistics

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



Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.