org.apache.blur.utils
Class ResetableDocumentStoredFieldVisitor

java.lang.Object
  extended by org.apache.lucene.index.StoredFieldVisitor
      extended by org.apache.blur.utils.ResetableDocumentStoredFieldVisitor

public class ResetableDocumentStoredFieldVisitor
extends org.apache.lucene.index.StoredFieldVisitor

A StoredFieldVisitor that creates a Document containing all stored fields, or only specific requested fields provided to #DocumentStoredFieldVisitor(Set).

This is used by IndexReader.document(int) to load a document.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.lucene.index.StoredFieldVisitor
org.apache.lucene.index.StoredFieldVisitor.Status
 
Constructor Summary
ResetableDocumentStoredFieldVisitor()
          Load all stored fields.
ResetableDocumentStoredFieldVisitor(Set<String> fieldsToAdd)
          Load only fields named in the provided Set<String>.
ResetableDocumentStoredFieldVisitor(String... fields)
          Load only fields named in the provided Set<String>.
 
Method Summary
 void binaryField(org.apache.lucene.index.FieldInfo fieldInfo, byte[] value)
           
 void doubleField(org.apache.lucene.index.FieldInfo fieldInfo, double value)
           
 void floatField(org.apache.lucene.index.FieldInfo fieldInfo, float value)
           
 org.apache.lucene.document.Document getDocument()
          Retrieve the visited document.
 int getSize()
           
 void intField(org.apache.lucene.index.FieldInfo fieldInfo, int value)
           
 void longField(org.apache.lucene.index.FieldInfo fieldInfo, long value)
           
 org.apache.lucene.index.StoredFieldVisitor.Status needsField(org.apache.lucene.index.FieldInfo fieldInfo)
           
 void reset()
           
 void stringField(org.apache.lucene.index.FieldInfo fieldInfo, String value)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ResetableDocumentStoredFieldVisitor

public ResetableDocumentStoredFieldVisitor(Set<String> fieldsToAdd)
Load only fields named in the provided Set<String>.


ResetableDocumentStoredFieldVisitor

public ResetableDocumentStoredFieldVisitor(String... fields)
Load only fields named in the provided Set<String>.


ResetableDocumentStoredFieldVisitor

public ResetableDocumentStoredFieldVisitor()
Load all stored fields.

Method Detail

binaryField

public void binaryField(org.apache.lucene.index.FieldInfo fieldInfo,
                        byte[] value)
                 throws IOException
Overrides:
binaryField in class org.apache.lucene.index.StoredFieldVisitor
Throws:
IOException

stringField

public void stringField(org.apache.lucene.index.FieldInfo fieldInfo,
                        String value)
                 throws IOException
Overrides:
stringField in class org.apache.lucene.index.StoredFieldVisitor
Throws:
IOException

intField

public void intField(org.apache.lucene.index.FieldInfo fieldInfo,
                     int value)
Overrides:
intField in class org.apache.lucene.index.StoredFieldVisitor

longField

public void longField(org.apache.lucene.index.FieldInfo fieldInfo,
                      long value)
Overrides:
longField in class org.apache.lucene.index.StoredFieldVisitor

floatField

public void floatField(org.apache.lucene.index.FieldInfo fieldInfo,
                       float value)
Overrides:
floatField in class org.apache.lucene.index.StoredFieldVisitor

doubleField

public void doubleField(org.apache.lucene.index.FieldInfo fieldInfo,
                        double value)
Overrides:
doubleField in class org.apache.lucene.index.StoredFieldVisitor

needsField

public org.apache.lucene.index.StoredFieldVisitor.Status needsField(org.apache.lucene.index.FieldInfo fieldInfo)
                                                             throws IOException
Specified by:
needsField in class org.apache.lucene.index.StoredFieldVisitor
Throws:
IOException

getDocument

public org.apache.lucene.document.Document getDocument()
Retrieve the visited document.

Returns:
Document populated with stored fields. Note that only the stored information in the field instances is valid, data such as boosts, indexing options, term vector options, etc is not set.

getSize

public int getSize()

reset

public void reset()


Copyright © 2012-2014 The Apache Software Foundation. All Rights Reserved.