org.apache.solr.response.DocsStreamer Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.solr.response;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import org.apache.lucene.document.Document;
import org.apache.lucene.index.IndexableField;
import org.apache.lucene.util.BytesRef;
import org.apache.solr.common.SolrDocument;
import org.apache.solr.common.SolrException;
import org.apache.solr.response.transform.DocTransformer;
import org.apache.solr.schema.BinaryField;
import org.apache.solr.schema.BoolField;
import org.apache.solr.schema.DatePointField;
import org.apache.solr.schema.DoublePointField;
import org.apache.solr.schema.FieldType;
import org.apache.solr.schema.FloatPointField;
import org.apache.solr.schema.IndexSchema;
import org.apache.solr.schema.IntPointField;
import org.apache.solr.schema.LongPointField;
import org.apache.solr.schema.SchemaField;
import org.apache.solr.schema.StrField;
import org.apache.solr.schema.TextField;
import org.apache.solr.schema.TrieDateField;
import org.apache.solr.schema.TrieDoubleField;
import org.apache.solr.schema.TrieField;
import org.apache.solr.schema.TrieFloatField;
import org.apache.solr.schema.TrieIntField;
import org.apache.solr.schema.TrieLongField;
import org.apache.solr.search.DocIterator;
import org.apache.solr.search.DocList;
import org.apache.solr.search.ReturnFields;
import org.apache.solr.search.SolrDocumentFetcher;
import org.apache.solr.search.SolrReturnFields;
/**
* This streams SolrDocuments from a DocList and applies transformer
*/
public class DocsStreamer implements Iterator {
public static final Set KNOWN_TYPES = new HashSet<>();
private final org.apache.solr.response.ResultContext rctx;
private final SolrDocumentFetcher docFetcher; // a collaborator of SolrIndexSearcher
private final DocList docs;
private final DocTransformer transformer;
private final DocIterator docIterator;
private final SolrReturnFields solrReturnFields;
private int idx = -1;
public DocsStreamer(ResultContext rctx) {
this.rctx = rctx;
this.docs = rctx.getDocList();
transformer = rctx.getReturnFields().getTransformer();
docIterator = this.docs.iterator();
docFetcher = rctx.getSearcher().getDocFetcher();
solrReturnFields = (SolrReturnFields)rctx.getReturnFields();
if (transformer != null) transformer.setContext(rctx);
}
public int currentIndex() {
return idx;
}
public boolean hasNext() {
return docIterator.hasNext();
}
public SolrDocument next() {
int id = docIterator.nextDoc();
idx++;
SolrDocument sdoc = docFetcher.solrDoc(id, solrReturnFields);
if (transformer != null) {
boolean doScore = rctx.wantsScores();
try {
if (doScore) {
transformer.transform(sdoc, id, docIterator.score());
} else {
transformer.transform(sdoc, id);
}
} catch (IOException e) {
throw new SolrException(SolrException.ErrorCode.SERVER_ERROR, "Error applying transformer", e);
}
}
return sdoc;
}
/**
* This method is less efficient then the 3 arg version because it may convert some fields that
* are not needed
*
* @deprecated use the 3 arg version for better performance
* @see #convertLuceneDocToSolrDoc(Document,IndexSchema,ReturnFields)
*/
@Deprecated
public static SolrDocument convertLuceneDocToSolrDoc(Document doc, final IndexSchema schema) {
return convertLuceneDocToSolrDoc(doc,schema, new SolrReturnFields());
}
/**
* Converts the specified Document into a SolrDocument.
*
* The use of {@link ReturnFields} can be important even when it was already used to retrieve the
* {@link Document} from {@link SolrDocumentFetcher} because the Document may have been cached with
* more fields then are desired.
*
*
* @param doc Document to be converted, must not be null
* @param schema IndexSchema containing the field/fieldType details for the index
* the Document came from, must not be null.
* @param fields ReturnFields instance that can be use to limit the set of fields
* that will be converted, must not be null
*/
public static SolrDocument convertLuceneDocToSolrDoc(Document doc,
final IndexSchema schema,
final ReturnFields fields) {
// TODO move to SolrDocumentFetcher ? Refactor to also call docFetcher.decorateDocValueFields(...) ?
assert null != doc;
assert null != schema;
assert null != fields;
// can't just use fields.wantsField(String)
// because that doesn't include extra fields needed by transformers
final Set fieldNamesNeeded = fields.getLuceneFieldNames();
BinaryResponseWriter.MaskCharSeqSolrDocument masked = null;
final SolrDocument out = ResultContext.READASBYTES.get() == null ?
new SolrDocument() :
(masked = new BinaryResponseWriter.MaskCharSeqSolrDocument());
// NOTE: it would be tempting to try and optimize this to loop over fieldNamesNeeded
// when it's smaller then the IndexableField[] in the Document -- but that's actually *less* effecient
// since Document.getFields(String) does a full (internal) iteration over the full IndexableField[]
// see SOLR-11891
for (IndexableField f : doc.getFields()) {
final String fname = f.name();
if (null == fieldNamesNeeded || fieldNamesNeeded.contains(fname) ) {
// Make sure multivalued fields are represented as lists
Object existing = masked == null ? out.get(fname) : masked.getRaw(fname);
if (existing == null) {
SchemaField sf = schema.getFieldOrNull(fname);
if (sf != null && sf.multiValued()) {
List