org.alfresco.repo.webservice

Class AbstractQuerySession<RESULTSET,RESULTSETROW>

java.lang.Object

org.alfresco.repo.webservice.AbstractQuerySession<RESULTSET,RESULTSETROW>

All Implemented Interfaces:

Serializable, QuerySession<RESULTSET>

Direct Known Subclasses:

RepositoryQuerySession, UserQuerySession

public abstract class AbstractQuerySession<RESULTSET,RESULTSETROW>
extends Object
implements QuerySession<RESULTSET>

An abstract implementation of the query session that keeps track of the paging data. It provides support for paging of results of Serializable[] instances.

Since:

2.1

Author:

Derek Hulley

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractQuerySession(long maxResults, long batchSize, ServerQuery<RESULTSET> query) Common constructor that initialises the session's id and batch size

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() Retrieves the id this query session can be identified as
protected RESULTSETROW[]	getNextResults(RESULTSETROW[] allResults) Helper method to page through the results.
ServerQuery<RESULTSET>	getQuery()
protected RESULTSET	getQueryResults(ServiceRegistry serviceRegistry) Helper method to get the results.
boolean	haveMoreResults() Check if the session is expecting more results.
protected abstract RESULTSETROW[]	makeArray(int size)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.alfresco.repo.webservice.QuerySession

getNextResults

Constructor Detail

AbstractQuerySession

public AbstractQuerySession(long maxResults,
                    long batchSize,
                    ServerQuery<RESULTSET> query)

Common constructor that initialises the session's id and batch size

Parameters:

maxResults - the maximum number of results to retrieve for the query. This is not the page size, which is normally significantly smaller.

batchSize - the batch size this session will use

query - the query that generates the results

Method Detail

getId

public String getId()

Retrieves the id this query session can be identified as

Specified by:

getId in interface QuerySession<RESULTSET>

Returns:

Id of this query session

getQuery

public ServerQuery<RESULTSET> getQuery()

getQueryResults

protected RESULTSET getQueryResults(ServiceRegistry serviceRegistry)

Helper method to get the results. This may be a cached value or may be freshly retrieved from the query object.

Parameters:

serviceRegistry - the

Returns:

the query results, new or cached

haveMoreResults

public boolean haveMoreResults()

Check if the session is expecting more results. This will be false if the cursor previously passed the end of a given set of results.

Specified by:

haveMoreResults in interface QuerySession<RESULTSET>

makeArray

protected abstract RESULTSETROW[] makeArray(int size)

getNextResults

protected final RESULTSETROW[] getNextResults(RESULTSETROW[] allResults)

Helper method to page through the results. The task of retrieving, unwrapping and rewrapping the array of results (rows) is left up to the derived implementations.