com.raritantechnologies.federated
Class FederatedResult

java.lang.Object
  com.raritantechnologies.searchApp.BasicResult
      com.raritantechnologies.xml.XMLResult
          com.raritantechnologies.federated.FederatedResult

All Implemented Interfaces:

IResult

Direct Known Subclasses:

FastResult, FastResult

public class FederatedResult

extends XMLResult

implements IResult

IResult implemented to handle the Normalized Result structure for federated searching.

 <result>
  <date>Date</date>
  <score>score</score>
  <title>title</title>
  <summary>summary</summary>
  <url>url</url>
  <field>
    <name>extendedFieldName1</name>
    <value>extendedField1Val1</value>
  </field>
  <field>
    <name>extendedFieldName1</name>
    <value>extendedField1Val2</value>
  </field>
  <field>
    <name>extendedFieldName2</name>
    <value>extendedField2Val</value>
  </field>
 </result>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

Fields inherited from class com.raritantechnologies.xml.XMLResult

INIT_XML

Fields inherited from class com.raritantechnologies.searchApp.BasicResult

fieldValues

Constructor Summary

FederatedResult()

FederatedResult(org.w3c.dom.Element element)

FederatedResult(IResult result)

FederatedResult(SearchSource searchSource)

FederatedResult(java.lang.String xml)

Method Summary

void	addNestedResult(java.lang.String nestedField, IResult nestedResult)
void	addNestedResults(java.lang.String nestedField, IResultSet nestedResults)
void	addValue(java.lang.String field, java.lang.String value) Adds a value to a field.
void	appendValue(java.lang.String field, java.lang.String value) Appends (concatenates) the value parameter to the current value of the field if the field already has a value.
java.lang.String	formatDate()
java.lang.String	formatScore()
java.util.Date	getDate()
org.w3c.dom.Document	getDOM(ILoginInfo userInfo) return a DOM Document object with the field data.
org.w3c.dom.Document	getDOM(ILoginInfo userInfo, int docNum)
java.lang.String[]	getFullTextFormats(ILoginInfo userInfo) returns a list of formats available for the "full text" electronic format formats can be text, html, pdf etc.
double	getScore()
java.lang.String	getSummary()
java.lang.String	getTitle()
java.lang.String	getTitleField()
java.lang.String	getURL()
java.lang.String	getURLField()
java.lang.String	getValue(java.lang.String field) returns the value of a vield.
java.lang.String	getXML(ILoginInfo userInfo)
void	setDate(java.util.Date date)
void	setDate(java.lang.String dateSt)
void	setDateFormatter(DateFieldFormatter dateFormatter)
void	setDocument(org.w3c.dom.Document doc)
void	setRecordTagName(java.lang.String recordTagName)
void	setScore(double score)
void	setScore(java.lang.String score)
void	setSummary(java.lang.String summary)
void	setTitle(java.lang.String title)
void	setURL(java.lang.String url)
void	setValue(java.lang.String field, java.lang.String value) Sets a new result field.
void	writeFullText(ILoginInfo userInfo, java.lang.String formatType, java.io.OutputStream toStream) filters the full text document for this result to the out put stream toStream.

Methods inherited from class com.raritantechnologies.xml.XMLResult

addNestedResultTag, getValues, getXML, getXML, hasMultipleValues, hasNestedResults, setCallbacks, setCallbacks, setDelimiterMap, setFieldDelim, setMultiValuePath, setMultiValuePaths, setNestedResultPath, setNestedResultPaths, setRootTagName, setSingleValuePaths, setValuePath, setWrapCData, setXMLString, setXMLTag

Methods inherited from class com.raritantechnologies.searchApp.BasicResult

addTree, clearValue, getFieldNames, getIDField, getNestedFieldNames, getNestedResults, getResultSet, getSearchSource, getSearchSourceName, getTree, getTreeNames, getValue, getXML, setIDField, setNestedResults, setSearchSourceName, setTitleField, setURLField, setValues

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.raritantechnologies.searchApp.IResult

addTree, clearValue, getFieldNames, getIDField, getNestedFieldNames, getNestedResults, getSearchSource, getSearchSourceName, getTree, getTreeNames, getValue, getValues, getXML, hasMultipleValues, hasNestedResults, setIDField, setNestedResults, setSearchSourceName, setTitleField, setURLField, setValues

Constructor Detail

FederatedResult

public FederatedResult()

FederatedResult

public FederatedResult(SearchSource searchSource)

FederatedResult

public FederatedResult(org.w3c.dom.Element element)

FederatedResult

public FederatedResult(java.lang.String xml)

FederatedResult

public FederatedResult(IResult result)

Method Detail

setTitle

public void setTitle(java.lang.String title)

getTitle

public java.lang.String getTitle()

getTitleField

public java.lang.String getTitleField()

Specified by:

getTitleField in interface IResult

Overrides:

getTitleField in class BasicResult

setURL

public void setURL(java.lang.String url)

getURL

public java.lang.String getURL()

getURLField

public java.lang.String getURLField()

Specified by:

getURLField in interface IResult

Overrides:

getURLField in class BasicResult

setSummary

public void setSummary(java.lang.String summary)

getSummary

public java.lang.String getSummary()

setDate

public void setDate(java.util.Date date)

setDate

public void setDate(java.lang.String dateSt)

getDate

public java.util.Date getDate()

setDateFormatter

public void setDateFormatter(DateFieldFormatter dateFormatter)

formatDate

public java.lang.String formatDate()

setScore

public void setScore(double score)

setScore

public void setScore(java.lang.String score)

getScore

public double getScore()

formatScore

public java.lang.String formatScore()

getDOM

public org.w3c.dom.Document getDOM(ILoginInfo userInfo)

Description copied from interface: IResult

return a DOM Document object with the field data.

Specified by:

getDOM in interface IResult

Overrides:

getDOM in class BasicResult

getDOM

public org.w3c.dom.Document getDOM(ILoginInfo userInfo,
                                   int docNum)

getXML

public java.lang.String getXML(ILoginInfo userInfo)

Specified by:

getXML in interface IResult

Overrides:

getXML in class XMLResult

setDocument

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

getValue

public java.lang.String getValue(java.lang.String field)

Description copied from interface: IResult

returns the value of a vield. For multiple value fields, implementation should return a delimited string.

Specified by:

getValue in interface IResult

Overrides:

getValue in class XMLResult

setValue

public void setValue(java.lang.String field,
                     java.lang.String value)

Description copied from interface: IResult

Sets a new result field. Used for fields that have only one value. Use addValue( ) for fields that can have more than one value.

Specified by:

setValue in interface IResult

Overrides:

setValue in class XMLResult

addNestedResults

public void addNestedResults(java.lang.String nestedField,
                             IResultSet nestedResults)

Specified by:

addNestedResults in interface IResult

Overrides:

addNestedResults in class BasicResult

addNestedResult

public void addNestedResult(java.lang.String nestedField,
                            IResult nestedResult)

Specified by:

addNestedResult in interface IResult

Overrides:

addNestedResult in class XMLResult

addValue

public void addValue(java.lang.String field,
                     java.lang.String value)

Description copied from interface: IResult

Adds a value to a field. used for fields with more than one value. Use setValue( ) for fields that can only have one value.

Specified by:

addValue in interface IResult

Overrides:

addValue in class XMLResult

appendValue

public void appendValue(java.lang.String field,
                        java.lang.String value)

Description copied from class: XMLResult

Appends (concatenates) the value parameter to the current value of the field if the field already has a value. Equivalent to setValue( ) if the field is empty.

Overrides:

appendValue in class XMLResult

setRecordTagName

public void setRecordTagName(java.lang.String recordTagName)

getFullTextFormats

public java.lang.String[] getFullTextFormats(ILoginInfo userInfo)

returns a list of formats available for the "full text" electronic format formats can be text, html, pdf etc. IResult must determine which formats the SearchSource supports, and which formats are available to the user.

Specified by:

getFullTextFormats in interface IResult

Overrides:

getFullTextFormats in class BasicResult

writeFullText

public void writeFullText(ILoginInfo userInfo,
                          java.lang.String formatType,
                          java.io.OutputStream toStream)

Description copied from interface: IResult

filters the full text document for this result to the out put stream toStream. If access is restricted, userInfo is used to login.

Specified by:

writeFullText in interface IResult

Overrides:

writeFullText in class BasicResult