edu.indiana.lib.twinpeaks.search

Interface SearchResultInterface

All Known Implementing Classes:

Response, Response, SearchResultBase, Web2Response

public interface SearchResultInterface

Search characteristics, all matching items

Method Summary

Modifier and Type	Method and Description
boolean	canPaginate() Can this display be paginated (next/previous pages for display)?
void	doParse() Populate the search result list
int	getMatchCount() Return the count of matching items found
String	getNextPreviewPage() Fetch the "next preview page" reference (used to paginate results null if none)
String	getPreviousPreviewPage() Fetch the "previous preview page" reference (used to paginate results, null if none)
String	getQuery() Fetch the original query text
String	getSearchResponseString() Return search results as a String
int	getSearchStart() Return the starting item number for this search (one based)
void	initialize(QueryBase query) Save various attributes of the general search request
Iterator	iterator() Get an iterator to the result list

Method Detail

initialize

void initialize(QueryBase query)

Save various attributes of the general search request

Parameters:

query - The QueryBase extension that sent the search request

doParse

void doParse()

Populate the search result list

getQuery

String getQuery()

Fetch the original query text

Returns:

Search string

getSearchResponseString

String getSearchResponseString()

Return search results as a String

Returns:

Result Document

getSearchStart

int getSearchStart()

Return the starting item number for this search (one based)

Returns:

Starting item number

getMatchCount

int getMatchCount()

Return the count of matching items found

Returns:

Item count

getNextPreviewPage

String getNextPreviewPage()

Fetch the "next preview page" reference (used to paginate results null if none)

Returns:

Next page reference

getPreviousPreviewPage

String getPreviousPreviewPage()

Fetch the "previous preview page" reference (used to paginate results, null if none)

Returns:

Previous page reference

canPaginate

boolean canPaginate()

Can this display be paginated (next/previous pages for display)?

Returns:

true if so

iterator

Iterator iterator()

Get an iterator to the result list

Returns:

An iterator to the list of matching items