org.apache.lucene.document

Class StraightBytesDocValuesField

java.lang.Object

org.apache.lucene.document.Field

org.apache.lucene.document.StraightBytesDocValuesField

All Implemented Interfaces:

IndexableField

public class StraightBytesDocValuesField
extends Field

This class provides a Field that enables storing of a per-document BytesRef value. The values are stored directly with no sharing, which is a good fit when the fields don't share (many) values, such as a title field. If values may be shared it's better to use DerefBytesDocValuesField. Here's an example usage:

   document.add(new StraightBytesDocValuesField(name, new BytesRef("hello")));
 

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

See Also:

for further information

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_FIXED_LEN
static FieldType	TYPE_VAR_LEN

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

boost, fieldsData, name, numericTokenStream, tokenStream, type

Constructor Summary

Constructors

Constructor and Description
StraightBytesDocValuesField(String name, BytesRef bytes)
StraightBytesDocValuesField(String name, BytesRef bytes, boolean isFixedLength)

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_FIXED_LEN

public static final FieldType TYPE_FIXED_LEN

TYPE_VAR_LEN

public static final FieldType TYPE_VAR_LEN

Constructor Detail

StraightBytesDocValuesField

public StraightBytesDocValuesField(String name,
                           BytesRef bytes)

StraightBytesDocValuesField

public StraightBytesDocValuesField(String name,
                           BytesRef bytes,
                           boolean isFixedLength)