oracle.ifs.beans

Class SearchResultObject

java.lang.Object

oracle.ifs.beans.SearchResultObject

public final class SearchResultObject
extends Object

The SearchResultObject encapsulates a row of a Search result. A Result row contains one or more LibraryObjects. It also contains the scores of any ContextQualifications if your search was interMedia search.

Version:

1.0

Author:

Harish Butani

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
protected String	m_DefaultResultClass
protected Hashtable	m_Objects
protected Hashtable	m_Scores

Constructor Summary

Constructors

Constructor and Description
SearchResultObject(LibrarySession sess, S_SearchResultObjectData sData) Constructs a SearchResultObject from SearchResultObjectData.

Method Summary

Modifier and Type	Method and Description
LibraryObject	getLibraryObject() Returns the first object in the SearchResult.
LibraryObject	getLibraryObject(String className) Returns the result object for the class.
int	getScore(String ctxClauseName) Returns the score associated with a ContextQualification.

Methods inherited from class java.lang.Object

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

Field Detail

m_Objects

protected Hashtable m_Objects

(Unpublished)

m_Scores

protected Hashtable m_Scores

(Unpublished)

m_DefaultResultClass

protected String m_DefaultResultClass

(Unpublished)

Constructor Detail

SearchResultObject

public SearchResultObject(LibrarySession sess,
                          S_SearchResultObjectData sData)
                   throws IfsException

Constructs a SearchResultObject from SearchResultObjectData. Called from Search.

Parameters:

sess - LibrarySession used for constructing LibrarYObjects from Dats objects

sData - SearchResultObjectData structure

Throws:

IfsException - if constructing of elements of SearchResult fails

(Unpublished)

Method Detail

getLibraryObject

public LibraryObject getLibraryObject(String className)
                               throws IfsException

Returns the result object for the class. If an alias was used in the SearchClassSpecification, it must be specified here.

Parameters:

className - name of the class or alias of the class in the result

Returns:

LibraryObject if present; null otherwise.

Throws:

IfsExceptionm - if the operation fails

IfsException

(Published)

getLibraryObject

public LibraryObject getLibraryObject()
                               throws IfsException

Returns the first object in the SearchResult.

Returns:

first object in SearchResult.

Throws:

IfsException - if the operation fails

(Published)

getScore

public int getScore(String ctxClauseName)
             throws IfsException

Returns the score associated with a ContextQualification. The ctxClauseName should be the same as the name specified for the ContextQualification.

Parameters:

ctxClauseName - name of ContextQualification whose score is required.

Returns:

the interMedia score for this row of result.

Throws:

IfeException - if the operation fails.

IfsException

(Published)