org.apache.lucene.document

Class ShortDocValuesField

java.lang.Object

org.apache.lucene.document.Field

org.apache.lucene.document.ShortDocValuesField

All Implemented Interfaces:

IndexableField

public class ShortDocValuesField
extends Field

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

   document.add(new ShortDocValuesField(name, (short) 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 16-bit short DocValues.

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

boost, fieldsData, name, tokenStream, type

Constructor Summary

Constructors

Constructor and Description
ShortDocValuesField(String name, short value) Creates a new DocValues field with the specified 16-bit short 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 16-bit short DocValues.

Constructor Detail

ShortDocValuesField

public ShortDocValuesField(String name,
                   short value)

Creates a new DocValues field with the specified 16-bit short value

Parameters:

name - field name

value - 16-bit short value

Throws:

IllegalArgumentException - if the field name is null