org.apache.lucene.document

Class ByteDocValuesField

java.lang.Object

org.apache.lucene.document.Field

org.apache.lucene.document.ByteDocValuesField

All Implemented Interfaces:

IndexableField

public class ByteDocValuesField
extends Field

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

   document.add(new ByteDocValuesField(name, (byte) 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 8-bit byte DocValues.

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

boost, fieldsData, name, tokenStream, type

Constructor Summary

Constructors

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

Constructor Detail

ByteDocValuesField

public ByteDocValuesField(String name,
                  byte value)

Creates a new DocValues field with the specified 8-bit byte value

Parameters:

name - field name

value - 8-bit byte value

Throws:

IllegalArgumentException - if the field name is null.