Class DocMaker

Creates Lucene.Net.Documents.Document objects. Uses a ContentSource to generate DocData objects.

Inheritance
object
DocMaker
SpatialDocMaker
Implements
Inherited Members
Namespace: Lucene.Net.Benchmarks.ByTask.Feeds
Assembly: Lucene.Net.Benchmark.dll
Syntax
public class DocMaker : IDisposable
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

Constructors

DocMaker()

Creates Lucene.Net.Documents.Document objects. Uses a ContentSource to generate DocData objects.

Declaration
public DocMaker()
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

Fields

BODY_FIELD

Creates Lucene.Net.Documents.Document objects. Uses a ContentSource to generate DocData objects.

Declaration
public static readonly string BODY_FIELD
Field Value
Type Description
string
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

BYTES_FIELD

Creates Lucene.Net.Documents.Document objects. Uses a ContentSource to generate DocData objects.

Declaration
public static readonly string BYTES_FIELD
Field Value
Type Description
string
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

DATE_FIELD

Creates Lucene.Net.Documents.Document objects. Uses a ContentSource to generate DocData objects.

Declaration
public static readonly string DATE_FIELD
Field Value
Type Description
string
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

DATE_MSEC_FIELD

Creates Lucene.Net.Documents.Document objects. Uses a ContentSource to generate DocData objects.

Declaration
public static readonly string DATE_MSEC_FIELD
Field Value
Type Description
string
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

ID_FIELD

Creates Lucene.Net.Documents.Document objects. Uses a ContentSource to generate DocData objects.

Declaration
public static readonly string ID_FIELD
Field Value
Type Description
string
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

NAME_FIELD

Creates Lucene.Net.Documents.Document objects. Uses a ContentSource to generate DocData objects.

Declaration
public static readonly string NAME_FIELD
Field Value
Type Description
string
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

TIME_SEC_FIELD

Creates Lucene.Net.Documents.Document objects. Uses a ContentSource to generate DocData objects.

Declaration
public static readonly string TIME_SEC_FIELD
Field Value
Type Description
string
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

TITLE_FIELD

Creates Lucene.Net.Documents.Document objects. Uses a ContentSource to generate DocData objects.

Declaration
public static readonly string TITLE_FIELD
Field Value
Type Description
string
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

m_bodyValType

Creates Lucene.Net.Documents.Document objects. Uses a ContentSource to generate DocData objects.

Declaration
protected FieldType m_bodyValType
Field Value
Type Description
FieldType
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

m_config

Creates Lucene.Net.Documents.Document objects. Uses a ContentSource to generate DocData objects.

Declaration
protected Config m_config
Field Value
Type Description
Config
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

m_indexProperties

Creates Lucene.Net.Documents.Document objects. Uses a ContentSource to generate DocData objects.

Declaration
protected bool m_indexProperties
Field Value
Type Description
bool
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

m_reuseFields

Creates Lucene.Net.Documents.Document objects. Uses a ContentSource to generate DocData objects.

Declaration
protected bool m_reuseFields
Field Value
Type Description
bool
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

m_source

Creates Lucene.Net.Documents.Document objects. Uses a ContentSource to generate DocData objects.

Declaration
protected ContentSource m_source
Field Value
Type Description
ContentSource
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

m_valType

Creates Lucene.Net.Documents.Document objects. Uses a ContentSource to generate DocData objects.

Declaration
protected FieldType m_valType
Field Value
Type Description
FieldType
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

Methods

Dispose()

Closes the DocMaker.

Declaration
public void Dispose()
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

Dispose(bool)

Closes the DocMaker. The base implementation closes the ContentSource, and it can be overridden to do more work (but make sure to call base.Dispose(bool)).

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

GetDocState()

Creates Lucene.Net.Documents.Document objects. Uses a ContentSource to generate DocData objects.

Declaration
protected virtual DocMaker.DocState GetDocState()
Returns
Type Description
DocMaker.DocState
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

MakeDocument()

Creates a Lucene.Net.Documents.Document object ready for indexing. This method uses the ContentSource to get the next document from the source, and creates a Lucene.Net.Documents.Document object from the returned fields. If reuseFields was set to true, it will reuse Lucene.Net.Documents.Document and Lucene.Net.Documents.Field instances.

Declaration
public virtual Document MakeDocument()
Returns
Type Description
Document
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

MakeDocument(int)

Same as MakeDocument(), only this method creates a document of the given size input by size.

Declaration
public virtual Document MakeDocument(int size)
Parameters
Type Name Description
int size
Returns
Type Description
Document
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

ResetInputs()

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

Declaration
public virtual void ResetInputs()
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

SetConfig(Config, ContentSource)

Set the configuration parameters of this doc maker.

Declaration
public virtual void SetConfig(Config config, ContentSource source)
Parameters
Type Name Description
Config config
ContentSource source
Remarks

Supports the following parameters:

  • content.sourcespecifies the ContentSource class to use (default SingleDocSource).
  • doc.storedspecifies whether fields should be stored (default false).
  • doc.body.storedspecifies whether the body field should be stored (default = doc.stored).
  • doc.tokenizedspecifies whether fields should be tokenized (default true).
  • doc.body.tokenizedspecifies whether the body field should be tokenized (default = doc.tokenized).
  • doc.tokenized.normsspecifies 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.vectorspecifies whether term vectors should be stored for fields (default false).
  • doc.term.vector.positionsspecifies whether term vectors should be stored with positions (default false).
  • doc.term.vector.offsetsspecifies whether term vectors should be stored with offsets (default false).
  • doc.store.body.bytesspecifies whether to store the raw bytes of the document's content in the document (default false).
  • doc.reuse.fieldsspecifies whether Lucene.Net.Documents.Field and Lucene.Net.Documents.Document objects should be reused (default true).
  • doc.index.propsspecifies 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 UpdateDocument(Term, IEnumerable<IIndexableField>). Props will be indexed. (default false).

Implements