Package org.apache.solr.response

Class DocsStreamer

java.lang.Object

org.apache.solr.response.DocsStreamer

All Implemented Interfaces:

Iterator<SolrDocument>

public class DocsStreamer
extends Object
implements Iterator<SolrDocument>

This streams SolrDocuments from a DocList and applies transformer

Field Summary

Fields

Modifier and Type	Field	Description
static Set<Class>	KNOWN_TYPES

Constructor Summary

Constructors

Constructor	Description
DocsStreamer(ResultContext rctx)

Method Summary

Modifier and Type	Method	Description
static SolrDocument	convertLuceneDocToSolrDoc(org.apache.lucene.document.Document doc, IndexSchema schema)	Deprecated. use the 3 arg version for better performance
static SolrDocument	convertLuceneDocToSolrDoc(org.apache.lucene.document.Document doc, IndexSchema schema, ReturnFields fields)	Converts the specified Document into a SolrDocument.
int	currentIndex()
static Object	getValue(SchemaField sf, org.apache.lucene.index.IndexableField f)
boolean	hasNext()
SolrDocument	next()
void	remove()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

KNOWN_TYPES

public static final Set<Class> KNOWN_TYPES

Constructor Detail

DocsStreamer

public DocsStreamer(ResultContext rctx)

Method Detail

currentIndex

public int currentIndex()

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<SolrDocument>

next

public SolrDocument next()

Specified by:

next in interface Iterator<SolrDocument>

convertLuceneDocToSolrDoc

@Deprecated
public static SolrDocument convertLuceneDocToSolrDoc(org.apache.lucene.document.Document doc,
                                                     IndexSchema schema)

Deprecated.

use the 3 arg version for better performance

This method is less efficient then the 3 arg version because it may convert some fields that are not needed

See Also:

convertLuceneDocToSolrDoc(Document,IndexSchema,ReturnFields)

convertLuceneDocToSolrDoc

public static SolrDocument convertLuceneDocToSolrDoc(org.apache.lucene.document.Document doc,
                                                     IndexSchema schema,
                                                     ReturnFields fields)

Converts the specified Document into a SolrDocument.

The use of ReturnFields can be important even when it was already used to retrieve the Document from SolrDocumentFetcher because the Document may have been cached with more fields then are desired.

Parameters:

doc - Document to be converted, must not be null

schema - IndexSchema containing the field/fieldType details for the index the Document came from, must not be null.

fields - ReturnFields instance that can be use to limit the set of fields that will be converted, must not be null

remove

public void remove()

Specified by:

remove in interface Iterator<SolrDocument>

getValue

public static Object getValue(SchemaField sf,
                              org.apache.lucene.index.IndexableField f)