com.raritantechnologies.searchApp
Interface IResultSet

All Known Implementing Classes:

BasicResultSet, FederatedResultSet, ProxyResultSet, SwingResultSet, XMLResultDispatchCollector, Z3950ResultSet

public interface IResultSet

Interface for a general result set. Provides method to initialize a result set from XML and to export the result set as an XML string.

Contains a set of IResult objects

The following Class diagram demonstrates the basic design of IResultSet classes:

Developed by Raritan Technologies .

Author:

Ted Sullivan, Glenn Robitaille

Field Summary

static java.lang.String	ELAPSEDTIME
static java.lang.String	PAGESIZE
static java.lang.String	QUERYSTRING
static java.lang.String	RESULTSETID
static java.lang.String	STARTDOC
static java.lang.String	TOTALDOCS

Method Summary

void	addAttribute(java.lang.String name, java.lang.Object attr)
void	addResult(IResult result)
java.lang.Object	getAttribute(java.lang.String name)
java.util.Iterator	getAttributes() ResultSet Properties
double	getElapsedTime()
long	getElapsedTimeMS()
int	getEndDoc()
INavigator	getNavigator() To Support Faceted Navigation
int	getPageSize()
java.lang.String	getQueryString()
IResult	getResult(int index)
java.util.Iterator	getResults()
java.util.Iterator	getResults(ISorter sortBy)
java.lang.Integer	getResultSetID()
int	getStartDoc()
int	getTotalDocs()
java.lang.String	getXML()
java.lang.String	getXML(ISorter sortBy)
java.lang.String	getXML(java.util.Iterator headerFields, java.util.Iterator resultFields, java.util.Iterator nestedFields)
void	setElapsedTimeMS(long time)
void	setNavigator(INavigator navigator)
void	setPageSize(int pageSize)
void	setQueryString(java.lang.String queryString)
void	setResultSetID(java.lang.Integer resultSetID)
void	setStartDoc(int startDoc)
void	setTotalDocs(int totalDocs)
int	size()
java.lang.String	toString()

Field Detail

TOTALDOCS

public static final java.lang.String TOTALDOCS

See Also:

Constant Field Values

QUERYSTRING

public static final java.lang.String QUERYSTRING

See Also:

Constant Field Values

ELAPSEDTIME

public static final java.lang.String ELAPSEDTIME

See Also:

Constant Field Values

STARTDOC

public static final java.lang.String STARTDOC

See Also:

Constant Field Values

PAGESIZE

public static final java.lang.String PAGESIZE

See Also:

Constant Field Values

RESULTSETID

public static final java.lang.String RESULTSETID

See Also:

Constant Field Values

Method Detail

setResultSetID

public void setResultSetID(java.lang.Integer resultSetID)

getResultSetID

public java.lang.Integer getResultSetID()

setQueryString

public void setQueryString(java.lang.String queryString)

getQueryString

public java.lang.String getQueryString()

setTotalDocs

public void setTotalDocs(int totalDocs)

getTotalDocs

public int getTotalDocs()

setStartDoc

public void setStartDoc(int startDoc)

getStartDoc

public int getStartDoc()

setPageSize

public void setPageSize(int pageSize)

getPageSize

public int getPageSize()

getEndDoc

public int getEndDoc()

addResult

public void addResult(IResult result)

getResults

public java.util.Iterator getResults()

getResults

public java.util.Iterator getResults(ISorter sortBy)

size

public int size()

getResult

public IResult getResult(int index)

getXML

public java.lang.String getXML()

getXML

public java.lang.String getXML(ISorter sortBy)

getXML

public java.lang.String getXML(java.util.Iterator headerFields,
                               java.util.Iterator resultFields,
                               java.util.Iterator nestedFields)

toString

public java.lang.String toString()

setElapsedTimeMS

public void setElapsedTimeMS(long time)

getElapsedTimeMS

public long getElapsedTimeMS()

getElapsedTime

public double getElapsedTime()

getAttributes

public java.util.Iterator getAttributes()

ResultSet Properties

addAttribute

public void addAttribute(java.lang.String name,
                         java.lang.Object attr)

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

getNavigator

public INavigator getNavigator()

To Support Faceted Navigation

setNavigator

public void setNavigator(INavigator navigator)