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

Class SignificantTermsStream

java.lang.Object

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

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

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

Since:

6.5.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	SignificantTermsStream.SignificantTermsCall

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 String	collection
protected String	field
protected float	maxDocFreq
protected float	minDocFreq
protected int	minTermLength
protected int	numTerms
protected Map<String,String>	params
protected Iterator<Tuple>	tupleIterator
protected String	zkHost

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
SignificantTermsStream(String zkHost, String collectionName, Map<String,String> params, String field, float minDocFreq, float maxDocFreq, int minTermLength, int numTerms)
SignificantTermsStream(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

append, jsonStr, toMap, write

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

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

Field Detail

zkHost

protected String zkHost

collection

protected String collection

params

protected Map<String,String> params

tupleIterator

protected Iterator<Tuple> tupleIterator

field

protected String field

numTerms

protected int numTerms

minDocFreq

protected float minDocFreq

maxDocFreq

protected float maxDocFreq

minTermLength

protected int minTermLength

Constructor Detail

SignificantTermsStream

public SignificantTermsStream(String zkHost,
                              String collectionName,
                              Map<String,String> params,
                              String field,
                              float minDocFreq,
                              float maxDocFreq,
                              int minTermLength,
                              int numTerms)
                       throws IOException

Throws:

IOException

SignificantTermsStream

public SignificantTermsStream(StreamExpression expression,
                              StreamFactory factory)
                       throws IOException

Throws:

IOException

Method Detail

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