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

Class Facet2DStream

java.lang.Object

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

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

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, Expressible, org.apache.solr.common.MapSerializable, org.apache.solr.common.MapWriter, org.apache.solr.common.NavigableObject

public class Facet2DStream
extends TupleStream
implements Expressible

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 SolrClientCache	cache
protected org.apache.solr.client.solrj.impl.CloudSolrClient	cloudSolrClient

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
Facet2DStream(String zkHost, String collection, org.apache.solr.common.params.ModifiableSolrParams params, Bucket x, Bucket y, String dimensions, Metric metric)
Facet2DStream(StreamExpression expression, StreamFactory factory)

Method Summary

Modifier and Type	Method	Description
List<TupleStream>	children()
void	close()
String	getCollection()
int	getCost()
StreamComparator	getStreamSort()
Bucket	getX()
Bucket	getY()
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

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

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

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

Field Detail

cache

protected transient SolrClientCache cache

cloudSolrClient

protected transient org.apache.solr.client.solrj.impl.CloudSolrClient cloudSolrClient

Constructor Detail

Facet2DStream

public Facet2DStream(String zkHost,
                     String collection,
                     org.apache.solr.common.params.ModifiableSolrParams params,
                     Bucket x,
                     Bucket y,
                     String dimensions,
                     Metric metric)
              throws IOException

Throws:

IOException

Facet2DStream

public Facet2DStream(StreamExpression expression,
                     StreamFactory factory)
              throws IOException

Throws:

IOException

Method Detail

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

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

children

public List<TupleStream> children()

Specified by:

children in class TupleStream

open

public void open()
          throws IOException

Specified by:

open in class TupleStream

Throws:

IOException

read

public Tuple read()
           throws IOException

Specified by:

read in class TupleStream

Throws:

IOException

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

getCost

public int getCost()

Overrides:

getCost in class TupleStream

getStreamSort

public StreamComparator getStreamSort()

Specified by:

getStreamSort in class TupleStream

getCollection

public String getCollection()

getX

public Bucket getX()

getY

public Bucket getY()