Package org.apache.solr.client.solrj.io.stream

Class ModelStream

java.lang.Object

org.apache.solr.client.solrj.io.stream.TupleStream

org.apache.solr.client.solrj.io.stream.ModelStream

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 ModelStream
extends TupleStream
implements Expressible

The ModelStream retrieves a stored model from a Solr Cloud collection.

Syntax: model(collection, id="modelID")

Since:

6.3.0

See Also:

• Serialized Form

Nested Class Summary

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

Modifier and Type	Field	Description
protected long	cacheMillis
protected String	collection
protected Tuple	model
protected ModelCache	modelCache
protected String	modelID
protected String	zkHost

Fields inherited from interface org.apache.solr.common.MapWriter

EMPTY

Constructor Summary

Constructors

Constructor	Description
ModelStream(String zkHost, String collectionName, String modelID, long cacheMillis)
ModelStream(StreamExpression expression, StreamFactory factory)

Method Summary

Modifier and Type	Method	Description
List<TupleStream>	children()
void	close()
StreamComparator	getStreamSort()	Return the stream sort - ie, the order in which records are returned
void	open()
Tuple	read()
void	setStreamContext(StreamContext context)
Explanation	toExplanation(StreamFactory factory)	Returns an explanation about the stream object
StreamExpressionParameter	toExpression(StreamFactory factory)

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

jsonStr, toMap, write

Methods inherited from interface org.apache.solr.common.NavigableObject

_forEachEntry, _forEachEntry, _forEachEntry, _get, _get, _getStr, _getStr, _size

Field Details

zkHost

protected String zkHost

collection

protected String collection

modelID

protected String modelID

modelCache

protected ModelCache modelCache

model

protected Tuple model

cacheMillis

protected long cacheMillis

Constructor Details

ModelStream

public ModelStream(String zkHost,
 String collectionName,
 String modelID,
 long cacheMillis)
            throws IOException

Throws:

IOException

ModelStream

public ModelStream(StreamExpression expression,
 StreamFactory factory)
            throws IOException

Throws:

IOException

Method Details

toExpression

public StreamExpressionParameter toExpression(StreamFactory factory)
                                       throws IOException

Specified by:

toExpression in interface Expressible

Throws:

IOException

setStreamContext

public void setStreamContext(StreamContext context)

Specified by:

setStreamContext in class TupleStream

open

public void open()
          throws IOException

Specified by:

open in class TupleStream

Throws:

IOException

children

public List<TupleStream> children()

Specified by:

children in class TupleStream

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class TupleStream

Throws:

IOException

getStreamSort

public StreamComparator getStreamSort()

Return the stream sort - ie, the order in which records are returned

Specified by:

getStreamSort in class TupleStream

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

Specified by:

toExplanation in class TupleStream

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

read

public Tuple read()
           throws IOException

Specified by:

read in class TupleStream

Throws:

IOException