de.innovationgate.wga.server.api

Class CollectionResult

java.lang.Object

de.innovationgate.wga.server.api.CollectionResult

All Implemented Interfaces:

java.lang.Iterable<Context>

Direct Known Subclasses:

NavigatorResult, QueryResult

public abstract class CollectionResult
extends java.lang.Object
implements java.lang.Iterable<Context>

Represents an object carrying all resulting data of a document collection.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CollectionResult.Filter A filter to be applied to a CollectionResult via method filter(Filter)
static interface	CollectionResult.Wrapper<T> A wrapper that transforms Contextes in other result objects

Method Summary

Methods

Modifier and Type	Method and Description
int	determineCurrentIndex(java.util.Iterator<?> it) Returns the index of the last returned result document from the given iterator that this document had on the original collection result.
CollectionResult	exclude(Context cx) Creates a new CollectionResult omitting the given document
CollectionResult	filter(CollectionResult.Filter filter) Creates a new CollectionResult containing only documents that pass the given filter
Context	getFirstResult() Returns the first result of the query This is an effective way of returning the very first document that is returned by the query if only this is important.
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.
CollectionResult	getOriginalResult() Returns the original QueryResult or NavigatorResultt of this collection result
CollectionPage	getPage(int size) Returns a page of contents from the navigator result on its current offset (being 1 if no offset-modifying actions like skip(int) have been used)
CollectionPage	getPage(int start, int size) Returns a page of contents from the navigator result
java.lang.Object	getSingleValue(java.lang.String itemName) Returns a single value of the first result content of the query.
int	getSize() Returns the number of result documents in the collection This is the number of results in the original collection, containing all documents that may be unreadable, not visible or skipped.
boolean	isEmpty()
abstract de.innovationgate.utils.SkippingIterator<Context>	iterator()
CollectionResult	skip(int size) Creates a CollectionResult which skips the first documents in the current collection result
java.lang.String	toString()
<T> java.lang.Iterable<T>	wrap(CollectionResult.Wrapper<T> wrapper) Returns an iterable whose iterators wrap/transform the returned documents into some custom object

Methods inherited from class java.lang.Object

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

Method Detail

filter

public CollectionResult filter(CollectionResult.Filter filter)
                        throws de.innovationgate.webgate.api.WGException

Creates a new CollectionResult containing only documents that pass the given filter

Parameters:

filter - A collection result filter

Throws:

de.innovationgate.webgate.api.WGException

skip

public CollectionResult skip(int size)
                      throws de.innovationgate.webgate.api.WGException

Creates a CollectionResult which skips the first documents in the current collection result

Parameters:

size - Number of documents to skip

Throws:

de.innovationgate.webgate.api.WGException

getOriginalResult

public CollectionResult getOriginalResult()
                                   throws de.innovationgate.webgate.api.WGException

Returns the original QueryResult or NavigatorResultt of this collection result

Throws:

de.innovationgate.webgate.api.WGException

getPage

public CollectionPage getPage(int start,
                     int size)
                       throws de.innovationgate.webgate.api.WGException

Returns a page of contents from the navigator result

Parameters:

start - The starting number from which to retrieve, 1 being the first content. Note that this is the start position from the offset that may already been chosen by previous actions, like skip(int)

size - The number of contents to retrieve

Returns:

List of contents as Context objects

Throws:

de.innovationgate.webgate.api.WGException

determineCurrentIndex

public int determineCurrentIndex(java.util.Iterator<?> it)

Returns the index of the last returned result document from the given iterator that this document had on the original collection result. Index 1 is the first document.

Parameters:

it - The iterator. Must be an iterator returned from a CollectionResult object

getPage

public CollectionPage getPage(int size)
                       throws de.innovationgate.webgate.api.WGException

Returns a page of contents from the navigator result on its current offset (being 1 if no offset-modifying actions like skip(int) have been used)

Parameters:

size - The number of contents to retrieve

Returns:

List of contents as Context objects

Throws:

de.innovationgate.webgate.api.WGException

getSize

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

Returns the number of result documents in the collection This is the number of results in the original collection, containing all documents that may be unreadable, not visible or skipped. The actual returned results may be lower.

Throws:

de.innovationgate.webgate.api.WGException

iterator

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

Specified by:

iterator in interface java.lang.Iterable<Context>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

exclude

public CollectionResult exclude(Context cx)
                         throws de.innovationgate.webgate.api.WGException

Creates a new CollectionResult omitting the given document

Parameters:

cx - Context of the document to omit

Throws:

de.innovationgate.webgate.api.WGException

getFirstResult

public Context getFirstResult()
                       throws de.innovationgate.webgate.api.WGException

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

Throws:

de.innovationgate.webgate.api.WGException

getSingleValue

public java.lang.Object getSingleValue(java.lang.String itemName)
                                throws de.innovationgate.webgate.api.WGException

Returns a single value of the first result content of the query. This may be useful if your query only really returns a a single value (for example a document count, a sum etc.) which this method can directly retrieve

Parameters:

itemName - The name of the item on the first result content, containing the desired value

Returns:

The desired value or null if the item does not exist or there is no result content

Throws:

de.innovationgate.webgate.api.WGException

getFirstResultContent

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

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.

Throws:

de.innovationgate.webgate.api.WGException

isEmpty

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

Throws:

de.innovationgate.webgate.api.WGException

wrap

public <T> java.lang.Iterable<T> wrap(CollectionResult.Wrapper<T> wrapper)
                           throws de.innovationgate.webgate.api.WGException

Returns an iterable whose iterators wrap/transform the returned documents into some custom object

Parameters:

wrapper - A wrapping implementation

Returns:

The wrapping iterable

Throws:

de.innovationgate.webgate.api.WGException