com.raritantechnologies.federated
Class FederatedResultSet

java.lang.Object
  com.raritantechnologies.searchApp.BasicResultSet
      com.raritantechnologies.xml.XMLResultSet
          com.raritantechnologies.federated.FederatedResultSet

All Implemented Interfaces:

IFederatedResultSet, IResultSet

Direct Known Subclasses:

EndecaResultSet, FastResultSet, FastResultSet, SOLRResultSet

public class FederatedResultSet

extends XMLResultSet

implements IResultSet, IFederatedResultSet

Extension of XMLResultSet specialized for handling results accumulated by a FederatedSearchSource. Contains special code for normalizing search results across sources.

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

static java.lang.String

COOKIES

Fields inherited from class com.raritantechnologies.searchApp.BasicResultSet

attrMap, lastSorter, navigator, needsReSort, results

Fields inherited from interface com.raritantechnologies.searchApp.IResultSet

ELAPSEDTIME, PAGESIZE, QUERYSTRING, RESULTSETID, STARTDOC, TOTALDOCS

Constructor Summary

FederatedResultSet()

FederatedResultSet(org.w3c.dom.Document doc, SearchSource searchSource)

FederatedResultSet(org.w3c.dom.Document doc, java.lang.String xslTransformFile)

FederatedResultSet(org.w3c.dom.Document doc, java.lang.String xslTransformFile, SearchSource searchSource)

FederatedResultSet(org.w3c.dom.Document doc, java.lang.String xslTransformFile, SearchSource searchSource, boolean retransform)

FederatedResultSet(org.w3c.dom.Document doc, javax.xml.transform.Transformer xFormer, SearchSource searchSource)

FederatedResultSet(org.w3c.dom.Document doc, javax.xml.transform.Transformer xFormer, SearchSource searchSource, boolean retransform)

Method Summary

org.w3c.dom.Document	getDOMDocument()
int	getEndDoc()
int	getEndDoc(java.lang.String sourceName)
java.lang.String	getQueryString()
IResult	getResult(java.lang.String xmlString)
java.util.Iterator	getSourceNames()
int	getStartDoc(java.lang.String sourceName)
int	getTotalDocs(java.lang.String sourceName)
java.lang.String	getXML()
java.lang.String	getXML(ISorter sorter)
void	setDocument(org.w3c.dom.Document doc)
void	setDocument(org.w3c.dom.Document doc, java.lang.String rootTagName, java.lang.String recordTagName)
void	setEndDoc(int endDoc)
void	setEndDoc(java.lang.String sourceName, int endDoc)
void	setSearchSource(SearchSource sSource)
void	setStartDoc(java.lang.String sourceName, int startDoc)
void	setTotalDocs(java.lang.String sourceName, int totalDocs)
java.lang.String	toString()

Methods inherited from class com.raritantechnologies.xml.XMLResultSet

addXMLResult, initialize, initialize, setCharacterEncoding, setMultiValuePaths, setNestedResultPaths, setSingleValuePaths, setWrapCData

Methods inherited from class com.raritantechnologies.searchApp.BasicResultSet

addAttribute, addResult, getAttribute, getAttributes, getElapsedTime, getElapsedTimeMS, getNavigator, getPageSize, getResult, getResults, getResults, getResultSetID, getStartDoc, getTotalDocs, getXML, setElapsedTimeMS, setNavigator, setPageSize, setQueryString, setResultSetID, setStartDoc, setTotalDocs, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.raritantechnologies.searchApp.IResultSet

addAttribute, addResult, getAttribute, getAttributes, getElapsedTime, getElapsedTimeMS, getNavigator, getPageSize, getResult, getResults, getResults, getResultSetID, getStartDoc, getTotalDocs, getXML, setElapsedTimeMS, setNavigator, setPageSize, setQueryString, setResultSetID, setStartDoc, setTotalDocs, size

Field Detail

COOKIES

public static final java.lang.String COOKIES

See Also:

Constant Field Values

Constructor Detail

FederatedResultSet

public FederatedResultSet()

FederatedResultSet

public FederatedResultSet(org.w3c.dom.Document doc,
                          SearchSource searchSource)

FederatedResultSet

public FederatedResultSet(org.w3c.dom.Document doc,
                          java.lang.String xslTransformFile)

FederatedResultSet

public FederatedResultSet(org.w3c.dom.Document doc,
                          java.lang.String xslTransformFile,
                          SearchSource searchSource)

FederatedResultSet

public FederatedResultSet(org.w3c.dom.Document doc,
                          java.lang.String xslTransformFile,
                          SearchSource searchSource,
                          boolean retransform)

FederatedResultSet

public FederatedResultSet(org.w3c.dom.Document doc,
                          javax.xml.transform.Transformer xFormer,
                          SearchSource searchSource)

FederatedResultSet

public FederatedResultSet(org.w3c.dom.Document doc,
                          javax.xml.transform.Transformer xFormer,
                          SearchSource searchSource,
                          boolean retransform)

Method Detail

getQueryString

public java.lang.String getQueryString()

Specified by:

getQueryString in interface IResultSet

Overrides:

getQueryString in class BasicResultSet

getXML

public java.lang.String getXML()

Specified by:

getXML in interface IResultSet

Overrides:

getXML in class BasicResultSet

getXML

public java.lang.String getXML(ISorter sorter)

Specified by:

getXML in interface IResultSet

Overrides:

getXML in class BasicResultSet

toString

public java.lang.String toString()

Specified by:

toString in interface IResultSet

Overrides:

toString in class BasicResultSet

setDocument

public void setDocument(org.w3c.dom.Document doc)

setDocument

public void setDocument(org.w3c.dom.Document doc,
                        java.lang.String rootTagName,
                        java.lang.String recordTagName)

setSearchSource

public void setSearchSource(SearchSource sSource)

getDOMDocument

public org.w3c.dom.Document getDOMDocument()

getResult

public IResult getResult(java.lang.String xmlString)

Overrides:

getResult in class XMLResultSet

setTotalDocs

public void setTotalDocs(java.lang.String sourceName,
                         int totalDocs)

Specified by:

setTotalDocs in interface IFederatedResultSet

getTotalDocs

public int getTotalDocs(java.lang.String sourceName)

Specified by:

getTotalDocs in interface IFederatedResultSet

setStartDoc

public void setStartDoc(java.lang.String sourceName,
                        int startDoc)

getStartDoc

public int getStartDoc(java.lang.String sourceName)

setEndDoc

public void setEndDoc(java.lang.String sourceName,
                      int endDoc)

getEndDoc

public int getEndDoc(java.lang.String sourceName)

setEndDoc

public void setEndDoc(int endDoc)

getEndDoc

public int getEndDoc()

Specified by:

getEndDoc in interface IResultSet

Overrides:

getEndDoc in class BasicResultSet

getSourceNames

public java.util.Iterator getSourceNames()

Specified by:

getSourceNames in interface IFederatedResultSet