org.apache.lucene.document
Class DerefBytesDocValuesField

java.lang.Object
  extended by org.apache.lucene.document.Field
      extended by org.apache.lucene.document.DerefBytesDocValuesField
All Implemented Interfaces:
IndexableField

public class DerefBytesDocValuesField
extends Field

This class provides a Field that enables storing of a per-document BytesRef value. The values are stored indirectly, such that many documents sharing the same value all point to a single copy of the value, which is a good fit when the fields share values. If values are (mostly) unique it's better to use StraightBytesDocValuesField. Here's an example usage:

   document.add(new DerefBytesDocValuesField(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
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
DerefBytesDocValuesField(String name, BytesRef bytes)
           
DerefBytesDocValuesField(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

DerefBytesDocValuesField

public DerefBytesDocValuesField(String name,
                                BytesRef bytes)

DerefBytesDocValuesField

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


Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.