org.apache.lucene.document
Class PackedLongDocValuesField

java.lang.Object
  org.apache.lucene.document.Field
      org.apache.lucene.document.PackedLongDocValuesField

All Implemented Interfaces:

IndexableField

public class PackedLongDocValuesField
extends Field

Field that stores a per-document long value for scoring, sorting or value retrieval. The values are encoded in the index an in RAM (when loaded via AtomicReader.docValues(java.lang.String)) using packed ints. Here's an example usage:

   document.add(new PackedLongDocValuesField(name, 22L));
 

If you also need to store the value, you should add a separate StoredField instance.

See Also:

DocValues

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.document.Field

Field.Index, Field.Store, Field.TermVector

Field Summary

static FieldType

TYPE Type for packed long DocValues.

Fields inherited from class org.apache.lucene.document.Field

boost, fieldsData, name, tokenStream, type

Constructor Summary

PackedLongDocValuesField(String name, long value)
Creates a new DocValues field with the specified long value

Method Summary

Methods inherited from class org.apache.lucene.document.Field

binaryValue, boost, fieldType, name, numericValue, readerValue, setBoost, setBytesValue, setBytesValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setReaderValue, setShortValue, setStringValue, setTokenStream, stringValue, tokenStream, tokenStreamValue, toString, translateFieldType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final FieldType TYPE

Type for packed long DocValues.

Constructor Detail

PackedLongDocValuesField

public PackedLongDocValuesField(String name,
                                long value)

Creates a new DocValues field with the specified long value

Parameters:

name - field name

value - 64-bit long value

Throws:

IllegalArgumentException - if the field name is null