Package org.apache.solr.legacy

Class LegacyNumericTokenStream

  • All Implemented Interfaces:
    Closeable, AutoCloseable
    @Deprecated
public final class LegacyNumericTokenStream
extends org.apache.lucene.analysis.TokenStream
    Deprecated.
    Please switch to PointValues instead
    Expert: This class provides a TokenStream for indexing numeric values that can be used by LegacyNumericRangeQuery.

    Note that for simple usage, LegacyIntField, LegacyLongField, LegacyFloatField or LegacyDoubleField is recommended. These fields disable norms and term freqs, as they are not usually needed during searching. If you need to change these settings, you should use this class.

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

      FieldType fieldType = new FieldType(TextField.TYPE_NOT_STORED);
  fieldType.setOmitNorms(true);
  fieldType.setIndexOptions(IndexOptions.DOCS_ONLY);
  Field field = new Field(name, new LegacyNumericTokenStream(precisionStep).setIntValue(value), fieldType);
  document.add(field);

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

      LegacyNumericTokenStream stream = new LegacyNumericTokenStream(precisionStep);
  FieldType fieldType = new FieldType(TextField.TYPE_NOT_STORED);
  fieldType.setOmitNorms(true);
  fieldType.setIndexOptions(IndexOptions.DOCS_ONLY);
  Field field = new Field(name, stream, fieldType);
  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 LegacyNumericTokenStream instance for each.

    See LegacyNumericRangeQuery for more details on the precisionStep parameter as well as how numeric fields work under the hood.

    Since:
    2.9

    • Field Detail

      • TOKEN_TYPE_FULL_PREC

        public static final String TOKEN_TYPE_FULL_PREC
        Deprecated.
        The full precision token gets this token type assigned.
        See Also:
        Constant Field Values

      • TOKEN_TYPE_LOWER_PREC

        public static final String TOKEN_TYPE_LOWER_PREC
        Deprecated.
        The lower precision tokens gets this token type assigned.
        See Also:
        Constant Field Values

    • Constructor Detail

      • LegacyNumericTokenStream

        public LegacyNumericTokenStream()
        Deprecated.
        Creates a token stream for numeric values using the default precisionStep LegacyNumericUtils.PRECISION_STEP_DEFAULT (16). The stream is not yet initialized, before using set a value using the various set???Value() methods.

      • LegacyNumericTokenStream

        public LegacyNumericTokenStream​(int precisionStep)
        Deprecated.
        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.

      • LegacyNumericTokenStream

        public LegacyNumericTokenStream​(org.apache.lucene.util.AttributeFactory factory,
                                int precisionStep)
        Deprecated.
        Expert: Creates a token stream for numeric values with the specified precisionStep using the given AttributeFactory. The stream is not yet initialized, before using set a value using the various set???Value() methods.

    • Method Detail

      • setLongValue

        public LegacyNumericTokenStream setLongValue​(long value)
        Deprecated.
        Initializes the token stream with the supplied long value.
        Parameters:
        value - the value, for which this TokenStream should enumerate tokens.
        Returns:
        this instance, because of this you can use it the following way: new Field(name, new LegacyNumericTokenStream(precisionStep).setLongValue(value))

      • setIntValue

        public LegacyNumericTokenStream setIntValue​(int value)
        Deprecated.
        Initializes the token stream with the supplied int value.
        Parameters:
        value - the value, for which this TokenStream should enumerate tokens.
        Returns:
        this instance, because of this you can use it the following way: new Field(name, new LegacyNumericTokenStream(precisionStep).setIntValue(value))

      • setDoubleValue

        public LegacyNumericTokenStream setDoubleValue​(double value)
        Deprecated.
        Initializes the token stream with the supplied double value.
        Parameters:
        value - the value, for which this TokenStream should enumerate tokens.
        Returns:
        this instance, because of this you can use it the following way: new Field(name, new LegacyNumericTokenStream(precisionStep).setDoubleValue(value))

      • setFloatValue

        public LegacyNumericTokenStream setFloatValue​(float value)
        Deprecated.
        Initializes the token stream with the supplied float value.
        Parameters:
        value - the value, for which this TokenStream should enumerate tokens.
        Returns:
        this instance, because of this you can use it the following way: new Field(name, new LegacyNumericTokenStream(precisionStep).setFloatValue(value))

      • reset

        public void reset()
        Deprecated.
        Overrides:
        reset in class org.apache.lucene.analysis.TokenStream

      • incrementToken

        public boolean incrementToken()
        Deprecated.
        Specified by:
        incrementToken in class org.apache.lucene.analysis.TokenStream

      • getPrecisionStep

        public int getPrecisionStep()
        Deprecated.
        Returns the precision step.

      • toString

        public String toString()
        Deprecated.
        Overrides:
        toString in class org.apache.lucene.util.AttributeSource