Package org.opencastproject.assetmanager.api.query

Class RichAResult

java.lang.Object

org.opencastproject.assetmanager.api.query.RichAResult

All Implemented Interfaces:

Iterable<ARecord>, AResult

public final class RichAResult
extends Object
implements AResult

Extensions for AResult.

Constructor Summary

Constructors

Constructor	Description
RichAResult(AResult result)

Method Summary

Modifier and Type	Method	Description
int	countProperties()	Count all properties contained in the result.
int	countSnapshots()	Count all snapshots contained in the result.
long	getLimit()	Return the set's size limit.
long	getOffset()	Return the offset within the total result set.
com.entwinemedia.fn.Stream<Property>	getProperties()
String	getQuery()	Return a string representation of the query.
com.entwinemedia.fn.Stream<ARecord>	getRecords()	Return the found records.
long	getSearchTime()	Return the search time of the query.
long	getSize()	Return the size of the retrieved slice.
com.entwinemedia.fn.Stream<Snapshot>	getSnapshots()	Get all selected snapshots.
long	getTotalSize()	Return the number of items the query could potentially yield.
com.entwinemedia.fn.Stream<Version>	getVersions()	Get all selected versions.
Iterator<ARecord>	iterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

RichAResult

public RichAResult(AResult result)

Method Detail

getProperties

public com.entwinemedia.fn.Stream<Property> getProperties()

countProperties

public int countProperties()

Count all properties contained in the result.

getSnapshots

public com.entwinemedia.fn.Stream<Snapshot> getSnapshots()

Get all selected snapshots.

countSnapshots

public int countSnapshots()

Count all snapshots contained in the result.

getVersions

public com.entwinemedia.fn.Stream<Version> getVersions()

Get all selected versions.

iterator

public Iterator<ARecord> iterator()

Specified by:

iterator in interface Iterable<ARecord>

getRecords

public com.entwinemedia.fn.Stream<ARecord> getRecords()

Description copied from interface: AResult

Return the found records.

Specified by:

getRecords in interface AResult

getSize

public long getSize()

Description copied from interface: AResult

Return the size of the retrieved slice. This value is <= AResult.getLimit().

Specified by:

getSize in interface AResult

See Also:

AResult.getLimit()

getQuery

public String getQuery()

Description copied from interface: AResult

Return a string representation of the query.

Specified by:

getQuery in interface AResult

getTotalSize

public long getTotalSize()

Description copied from interface: AResult

Return the number of items the query could potentially yield.

Specified by:

getTotalSize in interface AResult

Returns:

the total value or -1 to indicate that the value has not been calculated

getLimit

public long getLimit()

Description copied from interface: AResult

Return the set's size limit. It reflects the requested page size if specified in the query. This value is >= AResult.getSize().

Specified by:

getLimit in interface AResult

Returns:

the requested size limit or -1 if none has been specified

See Also:

AResult.getSize()

getOffset

public long getOffset()

Description copied from interface: AResult

Return the offset within the total result set.

Specified by:

getOffset in interface AResult

getSearchTime

public long getSearchTime()

Description copied from interface: AResult

Return the search time of the query.

Specified by:

getSearchTime in interface AResult

Returns:

the search time or -1 to indicate that it has not been measured