Class SimpleTextStoredFieldsWriter

Writes plain-text stored fields.

FOR RECREATIONAL USE ONLY

Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance

object

StoredFieldsWriter

SimpleTextStoredFieldsWriter

Implements

IDisposable

Inherited Members

StoredFieldsWriter.FinishDocument()

StoredFieldsWriter.Merge(MergeState)

StoredFieldsWriter.AddDocument<T1>(IEnumerable<T1>, FieldInfos)

StoredFieldsWriter.Dispose()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Codecs.SimpleText

Assembly: Lucene.Net.Codecs.dll

Syntax

public class SimpleTextStoredFieldsWriter : StoredFieldsWriter, IDisposable

Constructors

SimpleTextStoredFieldsWriter(Directory, string, IOContext)

Writes plain-text stored fields.

FOR RECREATIONAL USE ONLY

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration

public SimpleTextStoredFieldsWriter(Directory directory, string segment, IOContext context)

Parameters

Type	Name	Description
Directory	directory
string	segment
IOContext	context

Methods

Abort()

Aborts writing entirely, implementation should remove any partially-written files, etc.

Declaration

public override void Abort()

Overrides

Lucene.Net.Codecs.StoredFieldsWriter.Abort()

Dispose(bool)

Implementations must override and should dispose all resources used by this instance.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

Overrides

StoredFieldsWriter.Dispose(bool)

Finish(FieldInfos, int)

Called before Lucene.Net.Codecs.StoredFieldsWriter.Dispose(), passing in the number of documents that were written. Note that this is intentionally redundant (equivalent to the number of calls to StartDocument(int), but a Lucene.Net.Codecs.Codec should check that this is the case to detect the bug described in LUCENE-1282.

Declaration

public override void Finish(FieldInfos fis, int numDocs)

Parameters

Type	Name	Description
FieldInfos	fis
int	numDocs

Overrides

StoredFieldsWriter.Finish(FieldInfos, int)

StartDocument(int)

Called before writing the stored fields of the document. Lucene.Net.Codecs.StoredFieldsWriter.WriteField(Lucene.Net.Index.FieldInfo, Lucene.Net.Index.IIndexableField) will be called numStoredFields times. Note that this is called even if the document has no stored fields, in this case numStoredFields will be zero.

Declaration

public override void StartDocument(int numStoredFields)

Parameters

Type	Name	Description
int	numStoredFields

Overrides

StoredFieldsWriter.StartDocument(int)

WriteField(FieldInfo, IIndexableField)

Writes a single stored field.

Declaration

public override void WriteField(FieldInfo info, IIndexableField field)

Parameters

Type	Name	Description
FieldInfo	info
IIndexableField	field

Overrides

Lucene.Net.Codecs.StoredFieldsWriter.WriteField(Lucene.Net.Index.FieldInfo, Lucene.Net.Index.IIndexableField)

Implements

IDisposable