Class DocumentStoredFieldVisitor

A StoredFieldVisitor that creates a Document containing all stored fields, or only specific requested fields provided to DocumentStoredFieldVisitor(ISet<String>).

This is used by Document(Int32) to load a document.

Note

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

Inheritance
System.Object
StoredFieldVisitor
DocumentStoredFieldVisitor
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Lucene.Net.Documents
Assembly: Lucene.Net.dll
Syntax
public class DocumentStoredFieldVisitor : StoredFieldVisitor

Constructors

| Improve this Doc View Source

DocumentStoredFieldVisitor()

Load all stored fields.

Declaration
public DocumentStoredFieldVisitor()
| Improve this Doc View Source

DocumentStoredFieldVisitor(ISet<String>)

Load only fields named in the provided System.Collections.Generic.ISet<T>.

Declaration
public DocumentStoredFieldVisitor(ISet<string> fieldsToAdd)
Parameters
Type Name Description
System.Collections.Generic.ISet<System.String> fieldsToAdd

Set of fields to load, or null (all fields).

| Improve this Doc View Source

DocumentStoredFieldVisitor(String[])

Load only fields named in the provided fields.

Declaration
public DocumentStoredFieldVisitor(params string[] fields)
Parameters
Type Name Description
System.String[] fields

Properties

| Improve this Doc View Source

Document

Retrieve the visited document.

Declaration
public virtual Document Document { get; }
Property Value
Type Description
Document

Document populated with stored fields. Note that only the stored information in the field instances is valid, data such as boosts, indexing options, term vector options, etc is not set.

Methods

| Improve this Doc View Source

BinaryField(FieldInfo, Byte[])

Declaration
public override void BinaryField(FieldInfo fieldInfo, byte[] value)
Parameters
Type Name Description
FieldInfo fieldInfo
System.Byte[] value
Overrides
| Improve this Doc View Source

DoubleField(FieldInfo, Double)

Declaration
public override void DoubleField(FieldInfo fieldInfo, double value)
Parameters
Type Name Description
FieldInfo fieldInfo
System.Double value
Overrides
| Improve this Doc View Source

Int32Field(FieldInfo, Int32)

Declaration
public override void Int32Field(FieldInfo fieldInfo, int value)
Parameters
Type Name Description
FieldInfo fieldInfo
System.Int32 value
Overrides
| Improve this Doc View Source

Int64Field(FieldInfo, Int64)

Declaration
public override void Int64Field(FieldInfo fieldInfo, long value)
Parameters
Type Name Description
FieldInfo fieldInfo
System.Int64 value
Overrides
| Improve this Doc View Source

NeedsField(FieldInfo)

Declaration
public override StoredFieldVisitor.Status NeedsField(FieldInfo fieldInfo)
Parameters
Type Name Description
FieldInfo fieldInfo
Returns
Type Description
StoredFieldVisitor.Status
Overrides
| Improve this Doc View Source

SingleField(FieldInfo, Single)

Declaration
public override void SingleField(FieldInfo fieldInfo, float value)
Parameters
Type Name Description
FieldInfo fieldInfo
System.Single value
Overrides
| Improve this Doc View Source

StringField(FieldInfo, String)

Declaration
public override void StringField(FieldInfo fieldInfo, string value)
Parameters
Type Name Description
FieldInfo fieldInfo
System.String value
Overrides