Package org.nuxeo.ecm.core.storage.sql.jdbc

Class ResultSetQueryResult

java.lang.Object

org.nuxeo.ecm.core.storage.sql.jdbc.ResultSetQueryResult

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<Map<String,Serializable>>, Iterator<Map<String,Serializable>>, IterableQueryResult

public class ResultSetQueryResult
extends Object
implements IterableQueryResult, Iterator<Map<String,Serializable>>

Iterable query result implemented as a cursor on a SQL ResultSet.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResultSetQueryResult.ClosedIteratorException

Constructor Summary

Constructors

Constructor	Description
ResultSetQueryResult(QueryMaker queryMaker, String query, QueryFilter queryFilter, Session.PathResolver pathResolver, JDBCMapper mapper, Object... params)

Method Summary

Modifier and Type	Method	Description
protected void	checkNotClosed()
void	close()	Closes the query result and releases the underlying resources held by the cursor.
protected static void	closePreparedStatement(PreparedStatement ps)
protected Map<String,Serializable>	fetchCurrent()
protected Map<String,Serializable>	fetchNext()
boolean	hasNext()
Iterator<Map<String,Serializable>>	iterator()
boolean	mustBeClosed()	Indicates if the query result must be closed (because it holds resources).
Map<String,Serializable>	next()
long	pos()	Gets the current position in the iterator.
void	remove()
long	size()	Gets the total size of the query result.
void	skipTo(long pos)	Skips to a given position in the iterator.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Details

ResultSetQueryResult

public ResultSetQueryResult(QueryMaker queryMaker,
 String query,
 QueryFilter queryFilter,
 Session.PathResolver pathResolver,
 JDBCMapper mapper,
 Object... params)
                     throws SQLException

Throws:

SQLException

Method Details

closePreparedStatement

protected static void closePreparedStatement(PreparedStatement ps)
                                      throws SQLException

Throws:

SQLException

close

public void close()

Description copied from interface: IterableQueryResult

Closes the query result and releases the underlying resources held by the cursor.

This MUST be called when the query result is no more needed, otherwise underlying resources will be leaked. There is no auto-closing at the end of the iteration.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface IterableQueryResult

mustBeClosed

public boolean mustBeClosed()

Description copied from interface: IterableQueryResult

Indicates if the query result must be closed (because it holds resources).

Specified by:

mustBeClosed in interface IterableQueryResult

Returns:

true if the query result must be closed, false otherwise

checkNotClosed

protected void checkNotClosed()

size

public long size()

Description copied from interface: IterableQueryResult

Gets the total size of the query result.

Note that this may be costly, and that some backends may not be able to do this operation, in which case -1 will be returned.

Specified by:

size in interface IterableQueryResult

Returns:

the size, or -1 for an unknown size

pos

public long pos()

Description copied from interface: IterableQueryResult

Gets the current position in the iterator.

Positions start at 0.

Specified by:

pos in interface IterableQueryResult

Returns:

the position

skipTo

public void skipTo(long pos)

Description copied from interface: IterableQueryResult

Skips to a given position in the iterator.

Positions start at 0.

Specified by:

skipTo in interface IterableQueryResult

iterator

public Iterator<Map<String,Serializable>> iterator()

Specified by:

iterator in interface Iterable<Map<String,Serializable>>

fetchNext

protected Map<String,Serializable> fetchNext()
                                      throws SQLException

Throws:

SQLException

fetchCurrent

protected Map<String,Serializable> fetchCurrent()
                                         throws SQLException

Throws:

SQLException

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Map<String,Serializable>>

next

public Map<String,Serializable> next()

Specified by:

next in interface Iterator<Map<String,Serializable>>

remove

public void remove()

Specified by:

remove in interface Iterator<Map<String,Serializable>>