Class StoredField

A field whose value is stored so that Doc(Int32) and Document(Int32) will return the field and its value.

Inheritance

System.Object

Field

StoredField

Implements

IIndexableField

System.IFormattable

Inherited Members

Field.m_type

Field.m_name

Field.FieldsData

Field.m_tokenStream

Field.m_boost

Field.GetStringValue()

Field.GetStringValue(IFormatProvider)

Field.GetStringValue(String)

Field.GetStringValue(String, IFormatProvider)

Field.GetReaderValue()

Field.GetTokenStreamValue()

Field.SetStringValue(String)

Field.SetReaderValue(TextReader)

Field.SetBytesValue(BytesRef)

Field.SetBytesValue(Byte[])

Field.SetByteValue(Byte)

Field.SetInt16Value(Int16)

Field.SetInt32Value(Int32)

Field.SetInt64Value(Int64)

Field.SetSingleValue(Single)

Field.SetDoubleValue(Double)

Field.SetTokenStream(TokenStream)

Field.Name

Field.Boost

Field.GetNumericValue()

Field.NumericType

Field.GetByteValue()

Field.GetInt16Value()

Field.GetInt32Value()

Field.GetInt64Value()

Field.GetSingleValue()

Field.GetDoubleValue()

Field.GetBinaryValue()

Field.ToString()

Field.ToString(String)

Field.ToString(IFormatProvider)

Field.ToString(String, IFormatProvider)

Field.FieldType

Field.IndexableFieldType

Field.GetTokenStream(Analyzer)

Field.TranslateFieldType(Field.Store, Field.Index, Field.TermVector)

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)

Namespace: Lucene.Net.Documents

Assembly: Lucene.Net.dll

Syntax

public sealed class StoredField : Field, IIndexableField, IFormattable

Constructors

StoredField(String, BytesRef)

Create a stored-only field with the given binary value.

NOTE: the provided BytesRef is not copied so be sure not to change it until you're done with this field.

Declaration

public StoredField(string name, BytesRef value)

Parameters

Type	Name	Description
System.String	name	field name
BytesRef	value	BytesRef pointing to binary content (not copied)

Exceptions

Type	Condition
System.ArgumentNullException	if the field name is null.

StoredField(String, Byte[])

Create a stored-only field with the given binary value.

NOTE: the provided byte[] is not copied so be sure not to change it until you're done with this field.

Declaration

public StoredField(string name, byte[] value)

Parameters

Type	Name	Description
System.String	name	field name
System.Byte[]	value	byte array pointing to binary content (not copied)

Exceptions

Type	Condition
System.ArgumentNullException	if the field name is null.

StoredField(String, Byte[], Int32, Int32)

Create a stored-only field with the given binary value.

NOTE: the provided byte[] is not copied so be sure not to change it until you're done with this field.

Declaration

public StoredField(string name, byte[] value, int offset, int length)

Parameters

Type	Name	Description
System.String	name	field name
System.Byte[]	value	System.Byte array pointing to binary content (not copied)
System.Int32	offset	starting position of the byte array
System.Int32	length	valid length of the byte array

Exceptions

Type	Condition
System.ArgumentNullException	if the field name is null.

StoredField(String, Double)

Create a stored-only field with the given System.Double value.

Declaration

public StoredField(string name, double value)

Parameters

Type	Name	Description
System.String	name	field name
System.Double	value	System.Double value

Exceptions

Type	Condition
System.ArgumentNullException	if the field name is null.

StoredField(String, Int32)

Create a stored-only field with the given System.Int32 value.

Declaration

public StoredField(string name, int value)

Parameters

Type	Name	Description
System.String	name	field name
System.Int32	value	System.Int32 value

Exceptions

Type	Condition
System.ArgumentNullException	if the field name is null.

StoredField(String, Int64)

Create a stored-only field with the given System.Int64 value.

Declaration

public StoredField(string name, long value)

Parameters

Type	Name	Description
System.String	name	field name
System.Int64	value	System.Int64 value

Exceptions

Type	Condition
System.ArgumentNullException	if the field name is null.

StoredField(String, Single)

Create a stored-only field with the given System.Single value.

Declaration

public StoredField(string name, float value)

Parameters

Type	Name	Description
System.String	name	field name
System.Single	value	System.Single value

Exceptions

Type	Condition
System.ArgumentNullException	if the field name is null.

StoredField(String, String)

Create a stored-only field with the given System.String value.

Declaration

public StoredField(string name, string value)

Parameters

Type	Name	Description
System.String	name	field name
System.String	value	System.String value

Exceptions

Type	Condition
System.ArgumentNullException	if the field name or value is null.

Fields

TYPE

Type for a stored-only field.

Declaration

public static readonly FieldType TYPE

Field Value

Type	Description
FieldType

Implements

IIndexableField

System.IFormattable

Extension Methods

IndexableFieldExtensions.GetByteValueOrDefault(IIndexableField)

IndexableFieldExtensions.GetInt16ValueOrDefault(IIndexableField)

IndexableFieldExtensions.GetInt32ValueOrDefault(IIndexableField)

IndexableFieldExtensions.GetInt64ValueOrDefault(IIndexableField)

IndexableFieldExtensions.GetSingleValueOrDefault(IIndexableField)

IndexableFieldExtensions.GetDoubleValueOrDefault(IIndexableField)