org.intermine.api.results
Interface WebTable

All Superinterfaces:

java.util.Collection<MultiRow<ResultsRow<MultiRowValue<ResultElement>>>>, java.lang.Iterable<MultiRow<ResultsRow<MultiRowValue<ResultElement>>>>, java.util.List<MultiRow<ResultsRow<MultiRowValue<ResultElement>>>>

All Known Implementing Classes:

WebResults

public interface WebTable
extends java.util.List<MultiRow<ResultsRow<MultiRowValue<ResultElement>>>>

A List that can understand ResultElement objects.

Method Summary

java.util.List<Column>	getColumns() Returns the Column objects for this table.
int	getEstimatedSize() Get the estimated number of rows of this table
ResultsInfo	getInfo() Gets the underlying results object info
int	getMaxRetrievableIndex() Return the maximum retrievable index for this PagedTable.
PathQuery	getPathQuery() Get the PathQuery associated with this WebTable
java.util.Map<java.lang.String,BagQueryResult>	getPathToBagQueryResult() Returns the pathToBagQueryResult Map.
MultiRow<ResultsRow<MultiRowValue<ResultElement>>>	getResultElements(int index) Return a List containing a ResultElement object for each element given in the given row.
boolean	isSingleBatch() Returns true if the results are known to be contained in a single batch.
boolean	isSizeEstimate() Check whether the result of getEstimatedSize() is an estimate

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Method Detail

isSingleBatch

boolean isSingleBatch()

Returns true if the results are known to be contained in a single batch. If true, then it would not be sensible to perform precomputing.

Returns:

a boolean

getResultElements

MultiRow<ResultsRow<MultiRowValue<ResultElement>>> getResultElements(int index)

Return a List containing a ResultElement object for each element given in the given row.

Parameters:

index - the row of the results to fetch

Returns:

the results row

getColumns

java.util.List<Column> getColumns()

Returns the Column objects for this table.

Returns:

the columns

isSizeEstimate

boolean isSizeEstimate()

Check whether the result of getEstimatedSize() is an estimate

Returns:

true if the size is an estimate

getEstimatedSize

int getEstimatedSize()

Get the estimated number of rows of this table

Returns:

the number of rows

getMaxRetrievableIndex

int getMaxRetrievableIndex()

Return the maximum retrievable index for this PagedTable. This will only ever return less than getExactSize() if the underlying data source has a restriction on the maximum index that can be retrieved.

Returns:

the maximum retrieved index

getPathToBagQueryResult

java.util.Map<java.lang.String,BagQueryResult> getPathToBagQueryResult()

Returns the pathToBagQueryResult Map.

Returns:

a Map

getPathQuery

PathQuery getPathQuery()

Get the PathQuery associated with this WebTable

Returns:

the PathQuery

getInfo

ResultsInfo getInfo()
                    throws ObjectStoreException

Gets the underlying results object info

Returns:

the ResultsInfo

Throws:

ObjectStoreException - exception