de.innovationgate.webgate.api.query.rss

Class WGResultSetImpl

java.lang.Object

de.innovationgate.webgate.api.query.rss.WGResultSetImpl

All Implemented Interfaces:

WGResultSetCore

public class WGResultSetImpl
extends java.lang.Object
implements WGResultSetCore

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NS_RSS1_NETSCAPE
static java.lang.String	NS_RSS1_PURL

Constructor Summary

Constructors

Constructor and Description
WGResultSetImpl(WGDatabase db, org.dom4j.Document doc)

Method Summary

Methods

Modifier and Type	Method and Description
WGDocumentCore	createDocumentImpl(org.dom4j.Element element, java.lang.String key)
java.util.List	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	getContentList() Called to retrieve a list of all content in this result set.
java.util.List	getContentList(int start, int length) Called to retrieve a subset of content of this result 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

Field Detail

NS_RSS1_NETSCAPE

public static final java.lang.String NS_RSS1_NETSCAPE

See Also:

Constant Field Values

NS_RSS1_PURL

public static final java.lang.String NS_RSS1_PURL

See Also:

Constant Field Values

Constructor Detail

WGResultSetImpl

public WGResultSetImpl(WGDatabase db,
               org.dom4j.Document doc)

Method Detail

getContentList

public java.util.List getContentList()

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.

See Also:

WGResultSetCore.getContentList()

getContentList

public java.util.List getContentList(int start,
                            int length)

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.

See Also:

WGResultSetCore.getContentList(int, int)

createDocumentImpl

public WGDocumentCore createDocumentImpl(org.dom4j.Element element,
                                java.lang.String key)

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

See Also:

WGResultSetCore.results()

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

getColumnNames

public java.util.List 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

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