Class LazyDocument.LazyField

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Inheritance
System.Object
LazyDocument.LazyField
Implements
Lucene.Net.Index.IIndexableField
System.IFormattable
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)
Namespace: Lucene.Net.Documents
Assembly: Lucene.Net.Misc.dll
Syntax
public class LazyField : IIndexableField, IFormattable

Properties

| Improve this Doc View Source

Boost

Gets the boost factor on this field.

Declaration
public virtual float Boost { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

FieldType

Returns the Lucene.Net.Documents.FieldType for this field as type Lucene.Net.Documents.FieldType.

Declaration
public virtual FieldType FieldType { get; }
Property Value
Type Description
Lucene.Net.Documents.FieldType
| Improve this Doc View Source

HasBeenLoaded

non-private for test only access

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration
public virtual bool HasBeenLoaded { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IndexableFieldType

Returns the Lucene.Net.Documents.FieldType for this field as type Lucene.Net.Index.IIndexableFieldType.

Declaration
public virtual IIndexableFieldType IndexableFieldType { get; }
Property Value
Type Description
Lucene.Net.Index.IIndexableFieldType
| Improve this Doc View Source

Name

The field's name

Declaration
public virtual string Name { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

NumericType

Gets the Lucene.Net.Documents.NumericFieldType of the underlying value, or NONE if the value is not set or non-numeric.

Expert: The difference between this property and NumericType is this is represents the current state of the field (whether being written or read) and the FieldType property represents instructions on how the field will be written, but does not re-populate when reading back from an index (it is write-only).

In Java, the numeric type was determined by checking the type of
GetNumericValue(). However, since there are no reference number types in .NET, using GetNumericValue() so will cause boxing/unboxing. It is therefore recommended to use this property to check the underlying type and the corresponding Get*Value() method to retrieve the value.

NOTE: Since Lucene codecs do not support BYTE or INT16, fields created with these types will always be INT32 when read back from the index.

Declaration
public virtual NumericFieldType NumericType { get; }
Property Value
Type Description
Lucene.Net.Documents.NumericFieldType

Methods

| Improve this Doc View Source

GetBinaryValue()

Non-null if this field has a binary value.

Declaration
public virtual BytesRef GetBinaryValue()
Returns
Type Description
Lucene.Net.Util.BytesRef
| Improve this Doc View Source

GetByteValue()

Returns the field value as System.Byte or null if the type is non-numeric.

Declaration
public virtual byte? GetByteValue()
Returns
Type Description
System.Nullable<System.Byte>

The field value or null if the type is non-numeric.
| Improve this Doc View Source

GetDoubleValue()

Returns the field value as System.Double or null if the type is non-numeric.

Declaration
public virtual double? GetDoubleValue()
Returns
Type Description
System.Nullable<System.Double>

The field value or null if the type is non-numeric.
| Improve this Doc View Source

GetInt16Value()

Returns the field value as System.Int16 or null if the type is non-numeric.

Declaration
public virtual short? GetInt16Value()
Returns
Type Description
System.Nullable<System.Int16>

The field value or null if the type is non-numeric.
| Improve this Doc View Source

GetInt32Value()

Returns the field value as System.Int32 or null if the type is non-numeric.

Declaration
public virtual int? GetInt32Value()
Returns
Type Description
System.Nullable<System.Int32>

The field value or null if the type is non-numeric.
| Improve this Doc View Source

GetInt64Value()

Returns the field value as System.Int64 or null if the type is non-numeric.

Declaration
public virtual long? GetInt64Value()
Returns
Type Description
System.Nullable<System.Int64>

The field value or null if the type is non-numeric.
| Improve this Doc View Source

GetNumericValue()

Declaration
[Obsolete("In .NET, use of this method will cause boxing/unboxing. Instead, use the NumericType property to check the underlying type and call the appropriate GetXXXValue() method to retrieve the value.")]
public virtual object GetNumericValue()
Returns
Type Description
System.Object
| Improve this Doc View Source

GetReaderValue()

The value of the field as a System.IO.TextReader, or null. If null, the System.String value or binary value is used. Exactly one of GetStringValue(), GetReaderValue(), and GetBinaryValue() must be set.

Declaration
public virtual TextReader GetReaderValue()
Returns
Type Description
System.IO.TextReader
| Improve this Doc View Source

GetSingleValue()

Returns the field value as System.Single or null if the type is non-numeric.

Declaration
public virtual float? GetSingleValue()
Returns
Type Description
System.Nullable<System.Single>

The field value or null if the type is non-numeric.
| Improve this Doc View Source

GetStringValue()

The value of the field as a System.String, or null. If null, the System.IO.TextReader value or binary value is used. Exactly one of GetStringValue(), GetReaderValue(), and GetBinaryValue() must be set.

Declaration
public virtual string GetStringValue()
Returns
Type Description
System.String

The string representation of the value if it is either a System.String or numeric type.
| Improve this Doc View Source

GetStringValue(IFormatProvider)

The value of the field as a System.String, or null. If null, the System.IO.TextReader value or binary value is used. Exactly one of GetStringValue(), GetReaderValue(), and GetBinaryValue() must be set.

Declaration
public virtual string GetStringValue(IFormatProvider provider)
Parameters
Type Name Description
System.IFormatProvider provider

An object that supplies culture-specific formatting information. This parameter has no effect if this field is non-numeric.
Returns
Type Description
System.String

The string representation of the value if it is either a System.String or numeric type.
| Improve this Doc View Source

GetStringValue(String)

The value of the field as a System.String, or null. If null, the System.IO.TextReader value or binary value is used. Exactly one of GetStringValue(), GetReaderValue(), and GetBinaryValue() must be set.

Declaration
public virtual string GetStringValue(string format)
Parameters
Type Name Description
System.String format

A standard or custom numeric format string. This parameter has no effect if this field is non-numeric.
Returns
Type Description
System.String

The string representation of the value if it is either a System.String or numeric type.
| Improve this Doc View Source

GetStringValue(String, IFormatProvider)

The value of the field as a System.String, or null. If null, the System.IO.TextReader value or binary value is used. Exactly one of GetStringValue(), GetReaderValue(), and GetBinaryValue() must be set.

Declaration
public virtual string GetStringValue(string format, IFormatProvider provider)
Parameters
Type Name Description
System.String format

A standard or custom numeric format string. This parameter has no effect if this field is non-numeric.
System.IFormatProvider provider

An object that supplies culture-specific formatting information. This parameter has no effect if this field is non-numeric.
Returns
Type Description
System.String

The string representation of the value if it is either a System.String or numeric type.
| Improve this Doc View Source

GetTokenStream(Analyzer)

Declaration
public virtual TokenStream GetTokenStream(Analyzer analyzer)
Parameters
Type Name Description
Lucene.Net.Analysis.Analyzer analyzer
Returns
Type Description
Lucene.Net.Analysis.TokenStream
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()
| Improve this Doc View Source

ToString(IFormatProvider)

Declaration
public virtual string ToString(IFormatProvider provider)
Parameters
Type Name Description
System.IFormatProvider provider
Returns
Type Description
System.String
| Improve this Doc View Source

ToString(String)

Declaration
public virtual string ToString(string format)
Parameters
Type Name Description
System.String format
Returns
Type Description
System.String
| Improve this Doc View Source

ToString(String, IFormatProvider)

Declaration
public virtual string ToString(string format, IFormatProvider provider)
Parameters
Type Name Description
System.String format
System.IFormatProvider provider
Returns
Type Description
System.String

Implements

Lucene.Net.Index.IIndexableField
System.IFormattable