Package org.apache.solr.response

Class DocsStreamer

java.lang.Object

org.apache.solr.response.DocsStreamer

All Implemented Interfaces:

Iterator<org.apache.solr.common.SolrDocument>

public class DocsStreamer
extends Object
implements Iterator<org.apache.solr.common.SolrDocument>

This streams SolrDocuments from a DocList and applies transformer

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<Class<? extends FieldType>>	KNOWN_TYPES	Deprecated. new field types should not be added to this list, instead use FieldType.ExternalizeStoredValuesAsObjects

Constructor Summary

Constructors

Constructor	Description
DocsStreamer(ResultContext rctx)

Method Summary

Modifier and Type	Method	Description
static org.apache.solr.common.SolrDocument	convertLuceneDocToSolrDoc(org.apache.lucene.document.Document doc, IndexSchema schema, ReturnFields fields)	Converts the specified Document into a SolrDocument.
int	currentIndex()
static org.apache.solr.common.SolrDocument	externalizeStoredValues(org.apache.solr.common.SolrDocument doc, IndexSchema schema)	Replace Lucene IndexableField values on a SolrDocument (and nested / child documents) with the SolrJ-native objects that clients see after JavaBin deserialization.
static Object	getValue(SchemaField sf, org.apache.lucene.index.IndexableField f)
boolean	hasNext()
org.apache.solr.common.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 Details

KNOWN_TYPES

@Deprecated(since="10.1")
public static final Set<Class<? extends FieldType>> KNOWN_TYPES

Deprecated.

new field types should not be added to this list, instead use FieldType.ExternalizeStoredValuesAsObjects

A hardcoded list of known Solr field types that will be trusted to control their own conversion of stored field values into external Objects (via FieldType.toObject(org.apache.lucene.index.IndexableField)) when returning SolrDocument instances to clients.

For historic reasons, this Set is consulted using an equality basis, so subclasses of these "known" types are not given the same level of trust.

Any field type not found in this list will have stored values externalized as Strings using FieldType.toExternal(org.apache.lucene.index.IndexableField) unless they implement FieldType.ExternalizeStoredValuesAsObjects

Constructor Details

DocsStreamer

public DocsStreamer(ResultContext rctx)

Method Details

currentIndex

public int currentIndex()

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<org.apache.solr.common.SolrDocument>

next

public org.apache.solr.common.SolrDocument next()

Specified by:

next in interface Iterator<org.apache.solr.common.SolrDocument>

convertLuceneDocToSolrDoc

public static org.apache.solr.common.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<org.apache.solr.common.SolrDocument>

externalizeStoredValues

public static org.apache.solr.common.SolrDocument externalizeStoredValues(org.apache.solr.common.SolrDocument doc,
 IndexSchema schema)

Replace Lucene IndexableField values on a SolrDocument (and nested / child documents) with the SolrJ-native objects that clients see after JavaBin deserialization. The serialized JavaBin path already converts stored values through JavaBinResponseWriter.Resolver; this exists for the EmbeddedSolrServer streaming path, whose codec hands documents straight to the callback, so queryAndStreamResponse matches query / HttpSolrClient.

A stored value that cannot be converted is logged and omitted; conversion continues for the remaining values and fields.

Do not call this from convertLuceneDocToSolrDoc(org.apache.lucene.document.Document, org.apache.solr.schema.IndexSchema, org.apache.solr.search.ReturnFields); JSON/XML writers and some transformers still expect stored fields as IndexableField.

See Also:

• getValue(SchemaField, IndexableField)

getValue

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