Class DocMaker

  • All Implemented Interfaces:
    Closeable, AutoCloseable

    public class DocMaker
    extends Object
    implements Closeable
    Creates Document objects. Uses a ContentSource to generate DocData objects. Supports the following parameters:
    • content.source - specifies the ContentSource class to use (default SingleDocSource).
    • doc.stored - specifies whether fields should be stored (default false).
    • doc.body.stored - specifies whether the body field should be stored (default = doc.stored).
    • doc.tokenized - specifies whether fields should be tokenized (default true).
    • doc.body.tokenized - specifies whether the body field should be tokenized (default = doc.tokenized).
    • doc.tokenized.norms - specifies whether norms should be stored in the index or not. (default false).
    • doc.body.tokenized.norms - specifies whether norms should be stored in the index for the body field. This can be set to true, while doc.tokenized.norms is set to false, to allow norms storing just for the body field. (default true).
    • doc.term.vector - specifies whether term vectors should be stored for fields (default false).
    • doc.term.vector.positions - specifies whether term vectors should be stored with positions (default false).
    • doc.term.vector.offsets - specifies whether term vectors should be stored with offsets (default false).
    • doc.store.body.bytes - specifies whether to store the raw bytes of the document's content in the document (default false).
    • doc.reuse.fields - specifies whether Field and Document objects should be reused (default true).
    • doc.index.props - specifies whether the properties returned by
    • doc.random.id.limit - if specified, docs will be assigned random IDs from 0 to this limit. This is useful with UpdateDoc for testing performance of IndexWriter.updateDocument. DocData.getProps() will be indexed. (default false).
    • Constructor Detail

      • DocMaker

        public DocMaker()
    • Method Detail

      • getDocState

        protected org.apache.lucene.benchmark.byTask.feeds.DocMaker.DocState getDocState()
      • getBytesCount

        public long getBytesCount()
        Returns the number of bytes generated by the content source since last reset.
      • getTotalBytesCount

        public long getTotalBytesCount()
        Returns the total number of bytes that were generated by the content source defined to that doc maker.
      • makeDocument

        public org.apache.lucene.document.Document makeDocument()
                                                         throws Exception
        Creates a Document object ready for indexing. This method uses the ContentSource to get the next document from the source, and creates a Document object from the returned fields. If reuseFields was set to true, it will reuse Document and Field instances.
        Throws:
        Exception
      • makeDocument

        public org.apache.lucene.document.Document makeDocument​(int size)
                                                         throws Exception
        Same as makeDocument(), only this method creates a document of the given size input by size.
        Throws:
        Exception
      • resetInputs

        public void resetInputs()
                         throws IOException
        Reset inputs so that the test run would behave, input wise, as if it just started.
        Throws:
        IOException
      • setConfig

        public void setConfig​(Config config)
        Set the configuration parameters of this doc maker.