org.apache.lucene.document

Class ByteDocValuesField

java.lang.Object

org.apache.lucene.document.Field

org.apache.lucene.document.NumericDocValuesField

org.apache.lucene.document.ByteDocValuesField

All Implemented Interfaces:

IndexableField

Deprecated.

use NumericDocValuesField instead.

@Deprecated
public class ByteDocValuesField
extends NumericDocValuesField

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:

NumericDocValues

Nested Class Summary

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

Field.Index, Field.Store, Field.TermVector

Field Summary

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

TYPE

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) Deprecated. Creates a new DocValues field with the specified 8-bit byte value

Method Summary

Methods

Modifier and Type	Method and Description
void	setByteValue(byte value) Deprecated. Expert: change the value of this field.

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

binaryValue, boost, fieldType, name, numericValue, readerValue, setBoost, setBytesValue, setBytesValue, 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

Constructor Detail

ByteDocValuesField

public ByteDocValuesField(String name,
                  byte value)

Deprecated.

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.

Method Detail

setByteValue

public void setByteValue(byte value)

Deprecated.

Description copied from class: Field

Expert: change the value of this field. See Field.setStringValue(String).

Overrides:

setByteValue in class Field