MainJavadocSource
IResultSet

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.StringELAPSEDTIME
           
static java.lang.StringPAGESIZE
           
static java.lang.StringQUERYSTRING
           
static java.lang.StringRESULTSETID
           
static java.lang.StringSTARTDOC
           
static java.lang.StringTOTALDOCS
           
 
Method Summary
 voidaddAttribute(java.lang.String name, java.lang.Object attr)
           
 voidaddResult(IResult result)
           
 java.lang.ObjectgetAttribute(java.lang.String name)
           
 java.util.IteratorgetAttributes()
          ResultSet Properties
 doublegetElapsedTime()
           
 longgetElapsedTimeMS()
           
 intgetEndDoc()
           
 INavigatorgetNavigator()
          To Support Faceted Navigation
 intgetPageSize()
           
 java.lang.StringgetQueryString()
           
 IResultgetResult(int index)
           
 java.util.IteratorgetResults()
           
 java.util.IteratorgetResults(ISorter sortBy)
           
 java.lang.IntegergetResultSetID()
           
 intgetStartDoc()
           
 intgetTotalDocs()
           
 java.lang.StringgetXML()
           
 java.lang.StringgetXML(ISorter sortBy)
           
 java.lang.StringgetXML(java.util.Iterator headerFields, java.util.Iterator resultFields, java.util.Iterator nestedFields)
           
 voidsetElapsedTimeMS(long time)
           
 voidsetNavigator(INavigator navigator)
           
 voidsetPageSize(int pageSize)
           
 voidsetQueryString(java.lang.String queryString)
           
 voidsetResultSetID(java.lang.Integer resultSetID)
           
 voidsetStartDoc(int startDoc)
           
 voidsetTotalDocs(int totalDocs)
           
 intsize()
           
 java.lang.StringtoString()
           
 

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)