de.innovationgate.webgate.api

Class WGStandardResultSet

java.lang.Object

de.innovationgate.webgate.api.WGAbstractResultSet

de.innovationgate.webgate.api.WGStandardResultSet

All Implemented Interfaces:

WGResultSet, java.lang.Iterable<WGContent>

public class WGStandardResultSet
extends WGAbstractResultSet

Represents the results of a query. This result set is used for result set cores that return content keys. Core implementations of this object should retrieve only the documents that are really accessed via this object, so it is a good idea to restrict access to the documents really needed to avoid overhead.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	WGStandardResultSet.FetchingIterator

Constructor Summary

Constructors

Constructor and Description
WGStandardResultSet(WGDatabase db, WGResultSetCore core, java.util.Map parameters, java.lang.String query) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
WGContentList	getContentList() Called to retrieve a list of all content in this result set.
WGContentList	getContentList(int start, int length) Called to retrieve a subset of content of this result set.
long	getExecutionTime() This method may return the execution time of the backend query in milliseconds.
de.innovationgate.utils.SkippingIterator<WGContent>	getResultIterator() Returns an iterator iterating over the results
boolean	hasResults() Indicates if the result set contains any results
void	limitResults(int limit) Call to limit the results to return to the given count.
int	results() Number of results that are in this results set.

Methods inherited from class de.innovationgate.webgate.api.WGAbstractResultSet

close, isLimitingResultsInBackend, iterator

Methods inherited from class java.lang.Object

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

Constructor Detail

WGStandardResultSet

public WGStandardResultSet(WGDatabase db,
                   WGResultSetCore core,
                   java.util.Map parameters,
                   java.lang.String query)

Constructor. Should not be used outside WGAPI.

Parameters:

db -

core -

parameters -

Method Detail

getContentList

public WGContentList getContentList()
                             throws WGAPIException

Description copied from interface: WGResultSet

Called to retrieve a list of all content in this result set.

Returns:

List of contents. Empty list if this result set holds no content.

Throws:

WGAPIException

getContentList

public WGContentList getContentList(int start,
                           int length)
                             throws WGAPIException

Description copied from interface: WGResultSet

Called to retrieve a subset of content of this result set.

Parameters:

start - Starting index of contents to be retrieved. First index is 1.

length - Number of contents to be retrieved

Returns:

List of the requested contents. Partial or empty list, if the requested position/amount exceeded the result sets size.

Throws:

WGAPIException

results

public int results()
            throws WGBackendException

Description copied from interface: WGResultSet

Number of results that are in this results set.

Throws:

WGBackendException

limitResults

public void limitResults(int limit)
                  throws WGBackendException

Description copied from interface: WGResultSet

Call to limit the results to return to the given count. The resultset will only return results to this number. If the available results are fewer than this number this call has no effect.

Parameters:

limit - Maximum number of results to return.

Throws:

WGBackendException

getResultIterator

public de.innovationgate.utils.SkippingIterator<WGContent> getResultIterator()
                                                                      throws WGAPIException

Description copied from interface: WGResultSet

Returns an iterator iterating over the results

Throws:

WGAPIException

hasResults

public boolean hasResults()
                   throws WGBackendException

Description copied from interface: WGResultSet

Indicates if the result set contains any results

Throws:

WGBackendException

getExecutionTime

public long getExecutionTime()

Description copied from interface: WGResultSet

This method may return the execution time of the backend query in milliseconds. Returns 0 if not supported.