net.sf.gsaapi
Class GSAResponse

java.lang.Object
  net.sf.gsaapi.GSAResponse

public class GSAResponse

extends java.lang.Object

The Java binding to the XML response received from querying the GSA.

Author:

Amol S Deshmukh adeshmuk .at inxight .dot com

Constructor Summary

GSAResponse()
constructor is intended for internal use only.

Method Summary

long	getEndIndex() index of the last available result
java.lang.String	getNextResponseUrl() return the url to the next batch of responses
long	getNumResults() number of results
java.util.List	getOneBoxResponses() return the object that wraps the OneBox response
java.util.Map	getParams() meta field-values associated with this query-response
java.lang.String	getPreviousResponseUrl() return the url to the previous batch of responses
java.lang.String	getQuery() (canonical form of) the query that was made in order to get this response
java.util.List	getResults() get list of results in this batch
double	getSearchTime() how long did this search take (in seconds)
long	getStartIndex() start index of the results with respect to first result for the query
boolean	isFiltered() true if result is automatically filtered
java.lang.String	toString() to aid in debugging

Methods inherited from class java.lang.Object

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

Constructor Detail

GSAResponse

public GSAResponse()

constructor is intended for internal use only.

Method Detail

getEndIndex

public long getEndIndex()

index of the last available result

Returns:

the index as a long

isFiltered

public boolean isFiltered()

true if result is automatically filtered

Returns:

boolean indicating whether or not result was filtered.

getPreviousResponseUrl

public java.lang.String getPreviousResponseUrl()

return the url to the previous batch of responses

Returns:

the urlstring pointing to the next set of responses (to request the previous "page" of results).

getNextResponseUrl

public java.lang.String getNextResponseUrl()

return the url to the next batch of responses

Returns:

the urlstring pointing to the next set of responses (ie. to request the next "page" of results)

getOneBoxResponses

public java.util.List getOneBoxResponses()

return the object that wraps the OneBox response

Returns:

List containing GSAOneBoxResponse instances

getQuery

public java.lang.String getQuery()

(canonical form of) the query that was made in order to get this response

Returns:

String representing the query

getNumResults

public long getNumResults()

number of results

Returns:

total number of results as a long

getParams

public java.util.Map getParams()

meta field-values associated with this query-response

Returns:

Map of metafield names and values.

getSearchTime

public double getSearchTime()

how long did this search take (in seconds)

Returns:

search time in seconds

getStartIndex

public long getStartIndex()

start index of the results with respect to first result for the query

Returns:

index (1-based) as a long value.

getResults

public java.util.List getResults()

get list of results in this batch

Returns:

List of GSAResult instances.

toString

public java.lang.String toString()

to aid in debugging

Returns:

String indicating the value of internal fields.