oracle.workspaces.search
Class CwSearchResultSet

java.lang.Object
oracle.workspaces.search.CwSearchResultSet

Direct Known Subclasses:

CwCalendarSearchResultSet, CwDiscussionSearchResultSet, CwFilesSearchResultSet

public class CwSearchResultSet

extends java.lang.Object

Result Set corresponding to a particular CwSearchContainer. Each CW query has a list of containers to search. For each container, a CwSearchResultSet object is generated.

Method Summary

void	fetchRows(int rowStart, int rowLimit) This method can be used to get arbitrary chunk of the results.
java.util.List	getColumns() Get result columns in this result set.
CwSearchContainer	getContainer() Returns the container for which this result set was computed.
CwException	getCwException() For an error result, returns the CwException encountered; otherwise, returns null.
boolean	getIsErrorResult() Returns boolean indicating whether an error occurred during search.
oracle.search.Query	getQuery() Get the query for this result set.
oracle.search.QueryResult	getQueryResult() The search result in QueryResult format.
int	getRowCount() Retuns RowCount value for this result set.
int	getRowLimit() Retuns RowLimit value for this result set.
java.util.List	getRows() Returns a list of rows in this result set.
int	getRowStart() Retuns RowStart value for this result set.
CwSearchSession	getSearchSession() Returns the search session object for this result set.
CwSession	getSession() Returns the CwSession for which this result set was computed.
int	getTotalCount() Returns an estimated number total rows that satisfy the search query.

Methods inherited from class java.lang.Object

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

Method Detail

fetchRows

public void fetchRows(int rowStart,
                      int rowLimit)
               throws CwException

This method can be used to get arbitrary chunk of the results. The chunk is specified by rowStart and rowLimit parameters. The results will be computed for the original search query but limited to the container for this result set. This method is useful for paging through result set for each container.

Parameters:

rowStart - The starting row number of the search results.

rowLimit - the max number of rows to be returned.

Throws:

CwException

getColumns

public java.util.List getColumns()

Get result columns in this result set.

Returns:

A list of String objects where each component in the list is result column name.

getContainer

public CwSearchContainer getContainer()

Returns the container for which this result set was computed.

Returns:

the container for which this result set was computed.

getCwException

public CwException getCwException()

For an error result, returns the CwException encountered; otherwise, returns null.

getIsErrorResult

public boolean getIsErrorResult()

Returns boolean indicating whether an error occurred during search. Note that if an error occurred, you may retrieve the CwException object; also, the Query and CwSearchContainer are guaranteed to be valid.

getQuery

public oracle.search.Query getQuery()

Get the query for this result set. This query only has the container for which this result set was computed.

Returns:

the single container query for which this result was computed.

getQueryResult

public oracle.search.QueryResult getQueryResult()

The search result in QueryResult format.

Returns:

the QueryResult object for this search result.

getRowCount

public int getRowCount()

Retuns RowCount value for this result set.

Returns:

RowCount value for this result set. Note that row count could be less than RowLimit if not enough rows qualify for the search query.

getRowLimit

public int getRowLimit()

Retuns RowLimit value for this result set.

Returns:

RowLimit value for this result set.

getRows

public java.util.List getRows()

Returns a list of rows in this result set.

Returns:

A list of result rows where each row in this list is represented using a HashMap of (columnName, columnValue) pairs. The type for columnValue is a string.

See Also:

fetchRows(int rowStart, int rowLimit)

getRowStart

public int getRowStart()

Retuns RowStart value for this result set.

Returns:

RowStart value for this result set.

getSearchSession

public CwSearchSession getSearchSession()

Returns the search session object for this result set.

Returns:

the search session object for this result set.

getSession

public CwSession getSession()

Returns the CwSession for which this result set was computed.

Returns:

the CwSession for which this result set was computed.

getTotalCount

public int getTotalCount()

Returns an estimated number total rows that satisfy the search query. It is the number of rows that would be returned if RowStart and RowLimit were not specified.

Returns:

the total number of rows that satisfy the search query.