de.innovationgate.wga.server.api

Class QueryResult

java.lang.Object

de.innovationgate.wga.server.api.CollectionResult

de.innovationgate.wga.server.api.QueryResult

All Implemented Interfaces:

java.lang.Iterable<Context>

public class QueryResult
extends CollectionResult

Represents an object carrying all resulting data of an executed query. Use methods CollectionResult.getPage(int, int), CollectionResult.getFirstResult(), the iterator() or the backend result set via getSet() to retrieve results.

Nested Class Summary

Nested classes/interfaces inherited from class de.innovationgate.wga.server.api.CollectionResult

CollectionResult.Filter, CollectionResult.Wrapper<T>

Method Summary

Methods

Modifier and Type	Method and Description
long	getExecutionTime() This method may return the execution time of the backend query in milliseconds.
de.innovationgate.webgate.api.WGContent	getFirstResultContent() Returns the first result content of the query as WGAPI content object This is an effective way of returning the very first content document that is returned by the query if only this is important.
java.lang.String	getFullQuery() Returns the full query that was executed In order to enforce additional parameters in effect for a query WebTML may further enhance the query string that was given to the Database.query(String, String) method internally.
java.util.Map<java.lang.String,java.lang.Object>	getOutputParams() Returns all output parameters of the query Special query types may have special "output parameters", i.e. parameters that are given back from the query to the caller.
de.innovationgate.webgate.api.WGResultSet	getSet() Returns the WGAPI result set of the query result containing the resulting contents
int	getSize() Returns the number of contents in this query result
boolean	isServedFromCache() Returns if the query result was served from the WGAPI query cache When attribute "cache:true" was given to the query then the result may be served from the query cache.
de.innovationgate.utils.SkippingIterator<Context>	iterator() Iterators over the query results in the form of WebTML context objects

Methods inherited from class de.innovationgate.wga.server.api.CollectionResult

determineCurrentIndex, exclude, filter, getFirstResult, getOriginalResult, getPage, getPage, getSingleValue, isEmpty, skip, toString, wrap

Methods inherited from class java.lang.Object

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

Method Detail

getSet

public de.innovationgate.webgate.api.WGResultSet getSet()
                                                 throws de.innovationgate.webgate.api.WGException

Returns the WGAPI result set of the query result containing the resulting contents

Throws:

de.innovationgate.webgate.api.WGException

isServedFromCache

public boolean isServedFromCache()
                          throws de.innovationgate.webgate.api.WGException

Returns if the query result was served from the WGAPI query cache When attribute "cache:true" was given to the query then the result may be served from the query cache. This property being true indicates that it was served like that. This property being false means that the cache did not exist or was stale and that the query had to be executed. The cache may have been filled by this execution. This is the same as retrieving taginfo "cacheused" from .

Throws:

de.innovationgate.webgate.api.WGException

getFullQuery

public java.lang.String getFullQuery()
                              throws de.innovationgate.webgate.api.WGException

Returns the full query that was executed In order to enforce additional parameters in effect for a query WebTML may further enhance the query string that was given to the Database.query(String, String) method internally. This property returns the full query like it was executed on the database backend. This is the same as retrieving taginfo "fullquery" from .

Throws:

de.innovationgate.webgate.api.WGException

getOutputParams

public java.util.Map<java.lang.String,java.lang.Object> getOutputParams()
                                                                 throws de.innovationgate.webgate.api.WGException

Returns all output parameters of the query Special query types may have special "output parameters", i.e. parameters that are given back from the query to the caller. This Lookup table may be used to retrieve them by their names as keys.

Throws:

de.innovationgate.webgate.api.WGException

getFirstResultContent

public de.innovationgate.webgate.api.WGContent getFirstResultContent()
                                                              throws de.innovationgate.webgate.api.WGException

Description copied from class: CollectionResult

Returns the first result content of the query as WGAPI content object This is an effective way of returning the very first content document that is returned by the query if only this is important. If the result contains no contents this method returns null.

Overrides:

getFirstResultContent in class CollectionResult

Throws:

de.innovationgate.webgate.api.WGException

iterator

public de.innovationgate.utils.SkippingIterator<Context> iterator()

Iterators over the query results in the form of WebTML context objects

Specified by:

iterator in interface java.lang.Iterable<Context>

Specified by:

iterator in class CollectionResult

getSize

public int getSize()
            throws de.innovationgate.webgate.api.WGException

Returns the number of contents in this query result

Overrides:

getSize in class CollectionResult

Throws:

de.innovationgate.webgate.api.WGException

getExecutionTime

public long getExecutionTime()
                      throws de.innovationgate.webgate.api.WGException

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

Throws:

de.innovationgate.webgate.api.WGException