ShuffleStream (Solr 9.6.1 solrj-streaming API)

java.lang.Object
- org.apache.solr.client.solrj.io.stream.TupleStream
- - org.apache.solr.client.solrj.io.stream.CloudSolrStream
  - - org.apache.solr.client.solrj.io.stream.ShuffleStream

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, Expressible, org.apache.solr.common.MapSerializable, org.apache.solr.common.MapWriter, org.apache.solr.common.NavigableObject, org.noggit.JSONWriter.Writable
```
public class ShuffleStream
extends CloudSolrStream
implements Expressible
```
Since:

6.6.0

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.solr.client.solrj.io.stream.CloudSolrStream
  CloudSolrStream.StreamOpener, CloudSolrStream.TupleWrapper
- Nested classes/interfaces inherited from class org.apache.solr.client.solrj.io.stream.TupleStream
  TupleStream.IgnoreException
- Nested classes/interfaces inherited from interface org.apache.solr.common.MapWriter
  org.apache.solr.common.MapWriter.EntryWriter

Field Summary
- Fields inherited from class org.apache.solr.client.solrj.io.stream.CloudSolrStream
  collection, comp, eofTuples, fieldMappings, params, solrStreams, streamContext, tuples, zkHost
- Fields inherited from interface org.apache.solr.common.MapWriter
  EMPTY

Constructor Summary

Constructors
Constructor Description

ShuffleStream(StreamExpression expression, StreamFactory factory)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`org.apache.solr.common.params.ModifiableSolrParams`	`adjustParams(org.apache.solr.common.params.ModifiableSolrParams mParams)`
`Explanation`	`toExplanation(StreamFactory factory)`	Returns an explanation about the stream object
`StreamExpression`	`toExpression(StreamFactory factory)`

Methods inherited from class org.apache.solr.client.solrj.io.stream.CloudSolrStream
_read, children, close, constructStreams, getEofTuples, getSlices, getStreamSort, open, read, setFieldMappings, setStreamContext, setTrace

Methods inherited from class org.apache.solr.client.solrj.io.stream.TupleStream
getCost, getShards, getShards, getStreamNodeId, writeMap

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.solr.common.MapWriter
append, jsonStr, toMap, write

Methods inherited from interface org.apache.solr.common.NavigableObject
_forEachEntry, _forEachEntry, _forEachEntry, _get, _get, _getStr, _getStr, _size

- Constructor Detail
  - ShuffleStream
```
public ShuffleStream(StreamExpression expression,
                     StreamFactory factory)
              throws IOException
```
    Throws:
    
    IOException
- Method Detail
  - toExpression
```
public StreamExpression toExpression(StreamFactory factory)
                              throws IOException
```
    Specified by:
    
    toExpression in interface Expressible
    
    Overrides:
    
    toExpression in class CloudSolrStream
    
    Throws:
    
    IOException
  - toExplanation
```
public Explanation toExplanation(StreamFactory factory)
                          throws IOException
```
    Description copied from interface: Expressible
    
    Returns an explanation about the stream object
    
    Specified by:
    
    toExplanation in interface Expressible
    
    Overrides:
    
    toExplanation in class CloudSolrStream
    
    Parameters:
    
    factory - Stream factory for this, contains information about the function name
    
    Returns:
    
    Explanation about this stream object containing explanations of any child stream objects
    
    Throws:
    
    IOException - throw on any error
  - adjustParams
```
public org.apache.solr.common.params.ModifiableSolrParams adjustParams(org.apache.solr.common.params.ModifiableSolrParams mParams)
```
    Overrides:
    
    adjustParams in class CloudSolrStream