org.springframework.data.solr.core.query.result

Class DelegatingCursor<T>

java.lang.Object

org.springframework.data.solr.core.query.result.DelegatingCursor<T>

Type Parameters:

T -

All Implemented Interfaces:

Closeable, AutoCloseable, Iterator<T>, Cursor<T>

public abstract class DelegatingCursor<T>
extends Object
implements Cursor<T>

DelegatingCursor is a base Cursor implementation that temporarily holds data fetched in one run and delegates iteration.

Author:

Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DelegatingCursor.PartialResult<T> DelegatingCursor.PartialResult provided by a round trip to SolrClient loading data for an iteration.

Nested classes/interfaces inherited from interface org.springframework.data.solr.core.query.result.Cursor

Cursor.State

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DelegatingCursor(org.apache.solr.client.solrj.SolrQuery query)
protected	DelegatingCursor(org.apache.solr.client.solrj.SolrQuery query, String initalCursorMark)

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	doClose() Customization hook for clean up operations
protected abstract DelegatingCursor.PartialResult<T>	doLoad(org.apache.solr.client.solrj.SolrQuery nativeQuery) Read data from Solr.
protected void	doOpen(String cursorMark) Customization hook for open().
String	getCursorMark() Get the current set cursorMark
long	getPosition()
boolean	hasNext()
boolean	isClosed()
boolean	isFinished()
boolean	isOpen()
boolean	isReady()
protected T	moveNext(Iterator<T> source) Move one position next in given source.
T	next()
DelegatingCursor<T>	open() Opens the cursor.
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

DelegatingCursor

protected DelegatingCursor(org.apache.solr.client.solrj.SolrQuery query)

DelegatingCursor

protected DelegatingCursor(org.apache.solr.client.solrj.SolrQuery query,
                           String initalCursorMark)

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<T>

next

public T next()

Specified by:

next in interface Iterator<T>

moveNext

protected T moveNext(Iterator<T> source)

Move one position next in given source.

Parameters:

source -

Returns:

doLoad

protected abstract DelegatingCursor.PartialResult<T> doLoad(org.apache.solr.client.solrj.SolrQuery nativeQuery)

Read data from Solr.

Parameters:

nativeQuery - The query to execute already positioned at the next cursor mark.

Returns:

open

public DelegatingCursor<T> open()

Description copied from interface: Cursor

Opens the cursor.
Only Cursor.State.READY cursors can be opened.

Specified by:

open in interface Cursor<T>

Returns:

doOpen

protected void doOpen(@Nullable
                      String cursorMark)

Customization hook for open().

Parameters:

cursorMark -

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

doClose

protected void doClose()

Customization hook for clean up operations

remove

public void remove()

Specified by:

remove in interface Iterator<T>

getPosition

public long getPosition()

Specified by:

getPosition in interface Cursor<T>

Returns:

the current position starting a zero.

getCursorMark

@Nullable
public String getCursorMark()

Description copied from interface: Cursor

Get the current set cursorMark

Specified by:

getCursorMark in interface Cursor<T>

Returns:

isReady

public boolean isReady()

Returns:

true if State#REDAY

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Cursor<T>

Returns:

true if Cursor.State.OPEN

isFinished

public boolean isFinished()

Returns:

true if State#FINISHED

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Cursor<T>

Returns:

true if Cursor.State.CLOSED