Class NumericTokenStream

Expert: This class provides a TokenStream for indexing numeric values that can be used by NumericRangeQuery<T> or NumericRangeFilter<T>.

Note that for simple usage, NumericField is recommended. NumericField disables norms and term freqs, as they are not usually needed during searching. If you need to change these settings, you should use this class.

See NumericField for capabilities of fields indexed numerically.

Here's an example usage, for an int field:

 Field field = new Field(name, new NumericTokenStream(precisionStep).setIntValue(value));
 field.setOmitNorms(true);
 field.setOmitTermFreqAndPositions(true);
 document.add(field);

For optimal performance, re-use the TokenStream and Field instance for more than one document:

 NumericTokenStream stream = new NumericTokenStream(precisionStep);
 Field field = new Field(name, stream);
 field.setOmitNorms(true);
 field.setOmitTermFreqAndPositions(true);
 Document document = new Document();
 document.add(field);

 for(all documents) {
   stream.setIntValue(value)
   writer.addDocument(document);
 }

This stream is not intended to be used in analyzers; it's more for iterating the different precisions during indexing a specific numeric value.

NOTE: as token streams are only consumed once the document is added to the index, if you index more than one numeric field, use a separate NumericTokenStream instance for each.

See NumericRangeQuery<T> for more details on the precisionStep parameter as well as how numeric fields work under the hood.

NOTE: This API is experimental and might change in incompatible ways in the next release. Since 2.9

Inheritance

System.Object

Lucene.Net.Util.AttributeSource

TokenStream

NumericTokenStream

Inherited Members

TokenStream.End()

TokenStream.Close()

TokenStream.Dispose()

Namespace:

Assembly: Lucene.Net.NetCore.dll

Syntax

public sealed class NumericTokenStream : TokenStream, IDisposable

Constructors

Name	Description
NumericTokenStream()	Creates a token stream for numeric values using the default `precisionStep` Lucene.Net.Util.NumericUtils.PRECISION_STEP_DEFAULT (4). The stream is not yet initialized, before using set a value using the various set???Value() methods.
NumericTokenStream(AttributeSource, Int32)	Expert: Creates a token stream for numeric values with the specified `precisionStep` using the given Lucene.Net.Util.AttributeSource. The stream is not yet initialized, before using set a value using the various set???Value() methods.
NumericTokenStream(AttributeSource.AttributeFactory, Int32)	Expert: Creates a token stream for numeric values with the specified `precisionStep` using the given Lucene.Net.Util.AttributeSource.AttributeFactory. The stream is not yet initialized, before using set a value using the various set???Value() methods.
NumericTokenStream(Int32)	Creates a token stream for numeric values with the specified `precisionStep`. The stream is not yet initialized, before using set a value using the various set???Value() methods.

Fields

Name	Description
TOKEN_TYPE_FULL_PREC	The full precision token gets this token type assigned.
TOKEN_TYPE_LOWER_PREC	The lower precision tokens gets this token type assigned.

Methods

Name	Description
Dispose(Boolean)
IncrementToken()
Reset()
SetDoubleValue(Double)	Initializes the token stream with the supplied `double` value.
SetFloatValue(Single)	Initializes the token stream with the supplied `float` value.
SetIntValue(Int32)	Initializes the token stream with the supplied `int` value.
SetLongValue(Int64)	Initializes the token stream with the supplied `long` value.
ToString()