com.iland.core.web.rest.response.search

Class SearchResultResponse

java.lang.Object

com.iland.core.web.rest.response.search.SearchResultResponse

All Implemented Interfaces:

Serializable

public class SearchResultResponse
extends Object
implements Serializable

Search Result Response.

Author:

Brett Snyder

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchResultResponse(String query, int pageOffset, int pageSize, int returnedHits, int totalHits, List<Map<String,String>> results)

Method Summary

Modifier and Type	Method and Description
int	getPageOffset() Get the page Offset of search results.
int	getPageSize() Get the page size of search results.
String	getQuery() Get the query string for the search.
List<Map<String,String>>	getResults() A list of search results as a map of properties in the returned document.
int	getReturnedHits() Get the number of hits returned.
Map<String,String>	getTopResult() Return the top scoring search result.
int	getTotalHits() Get the total number of hits from query.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResultResponse

public SearchResultResponse(String query,
                            int pageOffset,
                            int pageSize,
                            int returnedHits,
                            int totalHits,
                            List<Map<String,String>> results)

Method Detail

getQuery

public String getQuery()

Get the query string for the search.

Returns:

String query string

getReturnedHits

public int getReturnedHits()

Get the number of hits returned.

Returns:

number of hits returned

getResults

public List<Map<String,String>> getResults()

A list of search results as a map of properties in the returned document.

Returns:

search results list

getTotalHits

public int getTotalHits()

Get the total number of hits from query.

Returns:

total hits

getTopResult

public Map<String,String> getTopResult()

Return the top scoring search result.

Returns:

top search result

getPageOffset

public int getPageOffset()

Get the page Offset of search results.

Returns:

the page offset

getPageSize

public int getPageSize()

Get the page size of search results.

Returns:

the page size