com.englishtown.vertx.solr.streams.impl

Class ReadJsonStreamBase<T extends ReadJsonStreamBase<T>>

java.lang.Object

com.englishtown.vertx.solr.streams.impl.ReadJsonStreamBase<T>

All Implemented Interfaces:

ReadJsonStream<T>, org.vertx.java.core.streams.ExceptionSupport<T>, org.vertx.java.core.streams.ReadSupport<T,org.vertx.java.core.json.JsonObject>

Direct Known Subclasses:

CursorMarkReadJsonStream, OffsetReadJsonStream

public abstract class ReadJsonStreamBase<T extends ReadJsonStreamBase<T>>
extends Object
implements ReadJsonStream<T>

Base implementation of ReadJsonStream

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReadJsonStreamBase()

Method Summary

Modifier and Type	Method and Description
T	address(String address) This is a optional parameter.
T	dataHandler(org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> handler) This method starts the SolrPump.
T	endHandler(org.vertx.java.core.Handler<Void> endHandler) Set an end handler.
T	eventBus(org.vertx.java.core.eventbus.EventBus eventBus) This is a required parameter.
T	exceptionHandler(org.vertx.java.core.Handler<Throwable> handler)
protected void	handleReply(org.vertx.java.core.json.JsonObject reply) Pagination looping logic - continuously runs through a doQuery loop until all results have been streamed
protected abstract boolean	isComplete(org.vertx.java.core.json.JsonObject reply)
T	pause()
T	resume()
T	serializer(SolrQuerySerializer serializer) This is a required parameter.
protected abstract void	setQueryStart(org.apache.solr.client.solrj.SolrQuery query) Set the query start point for pagination.
T	solrQuery(org.apache.solr.client.solrj.SolrQuery query) This is a required parameter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReadJsonStreamBase

protected ReadJsonStreamBase()

Method Detail

solrQuery

public T solrQuery(org.apache.solr.client.solrj.SolrQuery query)

This is a required parameter.

Parameters:

query - SolrQuery object which holds the query data

Returns:

Returns this

serializer

public T serializer(SolrQuerySerializer serializer)

This is a required parameter.

Parameters:

serializer - SolrQuerySerializer which helps to serialize/deserialize SolrQuery objects

Returns:

Returns this

eventBus

public T eventBus(org.vertx.java.core.eventbus.EventBus eventBus)

This is a required parameter.

Parameters:

eventBus - Vert.x eventBus

Returns:

Returns this

address

public T address(String address)

This is a optional parameter.

Parameters:

address - address the read and write streams will communicate with on over the Vert.x eventBus. This will default to "et.solr.address" if not explicitly set.

Returns:

Returns this

endHandler

public T endHandler(org.vertx.java.core.Handler<Void> endHandler)

Description copied from interface: ReadJsonStream

Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.

Specified by:

endHandler in interface ReadJsonStream<T extends ReadJsonStreamBase<T>>

Parameters:

endHandler - Handler called when the pump has finished

Returns:

Returns this

dataHandler

public T dataHandler(org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> handler)

This method starts the SolrPump. It takes a dataHandler, which is passed in from the Pump, sets this class's dataHandler equal to the one passed in and starts the Solr query and begins running through the pagination loops

Specified by:

dataHandler in interface org.vertx.java.core.streams.ReadSupport<T extends ReadJsonStreamBase<T>,org.vertx.java.core.json.JsonObject>

Parameters:

handler - Handler responsible for writing data to the stream

Returns:

Returns this

pause

public T pause()

Specified by:

pause in interface org.vertx.java.core.streams.ReadSupport<T extends ReadJsonStreamBase<T>,org.vertx.java.core.json.JsonObject>

resume

public T resume()

Specified by:

resume in interface org.vertx.java.core.streams.ReadSupport<T extends ReadJsonStreamBase<T>,org.vertx.java.core.json.JsonObject>

exceptionHandler

public T exceptionHandler(org.vertx.java.core.Handler<Throwable> handler)

Specified by:

exceptionHandler in interface org.vertx.java.core.streams.ExceptionSupport<T extends ReadJsonStreamBase<T>>

setQueryStart

protected abstract void setQueryStart(org.apache.solr.client.solrj.SolrQuery query)

Set the query start point for pagination. Typically either the start or cursorMark param.

Parameters:

query - SolrQuery object

isComplete

protected abstract boolean isComplete(org.vertx.java.core.json.JsonObject reply)

handleReply

protected void handleReply(org.vertx.java.core.json.JsonObject reply)

Pagination looping logic - continuously runs through a doQuery loop until all results have been streamed

Parameters:

reply - JsonObject query reply from Solr