de.innovationgate.webgate.api

Class WGCachedResultSet

java.lang.Object

de.innovationgate.webgate.api.WGCachedResultSet

All Implemented Interfaces:

WGIteratingResultSetCore, WGResultSetCore

public class WGCachedResultSet
extends java.lang.Object
implements WGIteratingResultSetCore

Represents a query result set that can be cached. Therefor all the content keys of the result content are extracted.

Constructor Summary

Constructors

Constructor and Description
WGCachedResultSet(java.util.List<WGContentKey> keys)
WGCachedResultSet(WGResultSetCore resultSetCore) Creates a cached result set that will cache the contents that is given as result set core

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<? extends java.lang.Object>	getColumnNames() Returns the name of result row columns, if this query serves multi column results Result set cores not supporting this type of results should return null here
java.util.List<? extends java.lang.Object>	getContentList() Called to retrieve a list of all content in this result set.
java.util.List<? extends java.lang.Object>	getContentList(int start, int length) Called to retrieve a subset of content of this result set.
java.util.Iterator<WGContentQueryResult>	getResultIterator() Returns an iterator iterating over the result documents of the set
boolean	isLimitingResults() Indicates if the query type does honor result size limits, give via WGDatabase.QUERYOPTION_MAXRESULTS.
boolean	isReturnsKeys() Determines, if this result set core only returns WGContentKey-Objects, to allow the WGAPI to rely on cached document objects.
int	results() Returns the number of contents in this result set.

Methods inherited from class java.lang.Object

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

Constructor Detail

WGCachedResultSet

public WGCachedResultSet(WGResultSetCore resultSetCore)
                  throws WGAPIException

Creates a cached result set that will cache the contents that is given as result set core

Parameters:

resultSetCore - The result set core, whose content result is cached

Throws:

WGAPIException

WGCachedResultSet

public WGCachedResultSet(java.util.List<WGContentKey> keys)

Method Detail

results

public int results()

Description copied from interface: WGResultSetCore

Returns the number of contents in this result set.

Specified by:

results in interface WGResultSetCore

Returns:

long

getContentList

public java.util.List<? extends java.lang.Object> getContentList(int start,
                                                        int length)
                                                          throws WGAPIException

Description copied from interface: WGResultSetCore

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

Specified by:

getContentList in interface WGResultSetCore

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

getContentList

public java.util.List<? extends java.lang.Object> getContentList()
                                                          throws WGAPIException

Description copied from interface: WGResultSetCore

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

Specified by:

getContentList in interface WGResultSetCore

Returns:

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

Throws:

WGAPIException

getColumnNames

public java.util.List<? extends java.lang.Object> getColumnNames()

Description copied from interface: WGResultSetCore

Returns the name of result row columns, if this query serves multi column results Result set cores not supporting this type of results should return null here

Specified by:

getColumnNames in interface WGResultSetCore

isReturnsKeys

public boolean isReturnsKeys()

Description copied from interface: WGResultSetCore

Determines, if this result set core only returns WGContentKey-Objects, to allow the WGAPI to rely on cached document objects. If false, this result set core is expected to return WGDocumentCore objects.

Specified by:

isReturnsKeys in interface WGResultSetCore

getResultIterator

public java.util.Iterator<WGContentQueryResult> getResultIterator()

Description copied from interface: WGIteratingResultSetCore

Returns an iterator iterating over the result documents of the set

Specified by:

getResultIterator in interface WGIteratingResultSetCore

isLimitingResults

public boolean isLimitingResults()

Description copied from interface: WGResultSetCore

Indicates if the query type does honor result size limits, give via WGDatabase.QUERYOPTION_MAXRESULTS. False means that the result set does not limit itself, and the limit must be enforced by WGA.

Specified by:

isLimitingResults in interface WGResultSetCore