org.apache.jackrabbit.core.query.lucene

Interface CloseableHits

All Known Subinterfaces:

MultiColumnQueryHits, QueryHits

All Known Implementing Classes:

AbstractQueryHits, ChildNodesQueryHits, DefaultQueryHits, FilterMultiColumnQueryHits, Join, LuceneQueryHits, NodeTraversingQueryHits, QueryHitsAdapter, SortedLuceneQueryHits, SortedMultiColumnQueryHits

public interface CloseableHits

Defines an interface for query hits that need to be closed when done reading from it. A client will call close() to release resources after a query has been executed and the results have been read.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Releases resources held by this hits instance.
int	getSize()
void	skip(int n) Skips a n score nodes.

Method Detail

close

void close()
           throws IOException

Releases resources held by this hits instance.

Throws:

IOException - if an error occurs while releasing resources.

getSize

int getSize()

Returns:

the number of results or -1 if the size is unknown.

skip

void skip(int n)
          throws IOException

Skips a n score nodes.

Parameters:

n - the number of score nodes to skip.

Throws:

IOException - if an error occurs while skipping.