org.apache.lucene.document

Class IntDocValuesField

java.lang.Object

org.apache.lucene.document.Field

org.apache.lucene.document.IntDocValuesField

All Implemented Interfaces:

IndexableField

public class IntDocValuesField
extends Field

Field that stores a per-document int value for scoring, sorting or value retrieval. Here's an example usage:

   document.add(new IntDocValuesField(name, 22));
 

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

Fields

Modifier and Type	Field and Description
static FieldType	TYPE Type for 32-bit integer DocValues.

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

boost, fieldsData, name, tokenStream, type

Constructor Summary

Constructors

Constructor and Description
IntDocValuesField(String name, int value) Creates a new DocValues field with the specified 32-bit integer 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 32-bit integer DocValues.

Constructor Detail

IntDocValuesField

public IntDocValuesField(String name,
                 int value)

Creates a new DocValues field with the specified 32-bit integer value

Parameters:

name - field name

value - 32-bit integer value

Throws:

IllegalArgumentException - if the field name is null