public class QueryResult extends CollectionResult
CollectionResult.getPage(int, int)
, CollectionResult.getFirstResult()
, the iterator()
or the backend result set via getSet()
to retrieve results.CollectionResult.Filter, CollectionResult.Wrapper<T>
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
|
determineCurrentIndex, exclude, filter, getFirstResult, getOriginalResult, getPage, getPage, getSingleValue, isEmpty, skip, toString, wrap
public de.innovationgate.webgate.api.WGResultSet getSet() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public boolean isServedFromCache() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public java.lang.String getFullQuery() throws de.innovationgate.webgate.api.WGException
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 de.innovationgate.webgate.api.WGException
public java.util.Map<java.lang.String,java.lang.Object> getOutputParams() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public de.innovationgate.webgate.api.WGContent getFirstResultContent() throws de.innovationgate.webgate.api.WGException
CollectionResult
getFirstResultContent
in class CollectionResult
de.innovationgate.webgate.api.WGException
public de.innovationgate.utils.SkippingIterator<Context> iterator()
iterator
in interface java.lang.Iterable<Context>
iterator
in class CollectionResult
public int getSize() throws de.innovationgate.webgate.api.WGException
getSize
in class CollectionResult
de.innovationgate.webgate.api.WGException
public long getExecutionTime() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException