org.dspace.search

Class QueryResults

java.lang.Object

org.dspace.search.QueryResults

public class QueryResults
extends java.lang.Object

Contains the results of a query. Use access methods to examine and retrieve the results.

Constructor Summary

Constructors

Constructor and Description
QueryResults()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getErrorMsg() get error message
int	getEtAl()
int	getHitCount() get total number of hits found by search engine, not just number of returned results
java.util.List<java.lang.String>	getHitHandles() get the List of handles corresponding to hits
java.util.List<java.lang.Integer>	getHitIds() get the List of handles corresponding to hits
java.util.List<java.lang.Integer>	getHitTypes() get the List of types corresponding to handles
int	getPageSize() get length of 'page' of results
long	getQueryTime()
int	getStart() get start of 'page' of results
void	setErrorMsg(java.lang.String msg) set error message
void	setEtAl(int etAl) set the number of metadata fields at which to truncate with "et al"
void	setHitCount(int newCount) set total number of hits found by search engine, not number in hitHandles
void	setHitHandles(java.util.List<java.lang.String> myHits) set the List of handles corresponding to hits
void	setHitIds(java.util.List<java.lang.Integer> myHits) set the List of ids corresponding to hits
void	setHitTypes(java.util.List<java.lang.Integer> newTypes) set the List of types corresponding to handles
void	setPageSize(int newSize) set length of 'page' of results
void	setQueryTime(long queryTime)
void	setStart(int newStart) set start of 'page' of results

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryResults

public QueryResults()

Method Detail

getQueryTime

public long getQueryTime()

setQueryTime

public void setQueryTime(long queryTime)

getEtAl

public int getEtAl()

Returns:

the number of metadata fields at which to truncate with "et al"

setEtAl

public void setEtAl(int etAl)

set the number of metadata fields at which to truncate with "et al"

Parameters:

etAl -

setHitCount

public void setHitCount(int newCount)

set total number of hits found by search engine, not number in hitHandles

getHitCount

public int getHitCount()

get total number of hits found by search engine, not just number of returned results

setStart

public void setStart(int newStart)

set start of 'page' of results

getStart

public int getStart()

get start of 'page' of results

setPageSize

public void setPageSize(int newSize)

set length of 'page' of results

getPageSize

public int getPageSize()

get length of 'page' of results

setHitHandles

public void setHitHandles(java.util.List<java.lang.String> myHits)

set the List of handles corresponding to hits

getHitHandles

public java.util.List<java.lang.String> getHitHandles()

get the List of handles corresponding to hits

setHitIds

public void setHitIds(java.util.List<java.lang.Integer> myHits)

set the List of ids corresponding to hits

getHitIds

public java.util.List<java.lang.Integer> getHitIds()

get the List of handles corresponding to hits

setHitTypes

public void setHitTypes(java.util.List<java.lang.Integer> newTypes)

set the List of types corresponding to handles

getHitTypes

public java.util.List<java.lang.Integer> getHitTypes()

get the List of types corresponding to handles

setErrorMsg

public void setErrorMsg(java.lang.String msg)

set error message

getErrorMsg

public java.lang.String getErrorMsg()

get error message