Skip navigation links

oracle.search.query.webservice.client
Class OracleSearchResult

java.lang.Object
oracle.search.query.webservice.client.OracleSearchResult

All Implemented Interfaces:

Serializable

public class OracleSearchResult

extends Object

implements Serializable

OracleSearchResult encapsulates results for the user's query.

See Also:

Serialized Form

Constructor Summary

OracleSearchResult()

OracleSearchResult(Boolean returnCount, Integer estimatedHitCount, Boolean dupRemoved, Boolean dupMarked, ResultElement[] resultElements, SuggestedLink[] suggestedLinks, String query, String altKeywords, Integer startIndex, Integer docsReturned)

Method Summary

String	getAltKeywords() Returns the alternate keywords for the query.
Integer	getDocsReturned() Returns the number of search hits returned.
Boolean	getDupMarked() Returns the Boolean value indicating if the duplicate documents are marked in the hit list.
Boolean	getDupRemoved() Returns the Boolean value indicating if the duplicate documents are removed from the hit list.
Integer	getEstimatedHitCount() Returns the estimated hit count for the query.
String	getQuery() Returns the query string.
ResultElement[]	getResultElements() Returns the hit list for the query.
Boolean	getReturnCount() Returns a Boolean value indicating whether the estimated hit count is included in the result.
Integer	getStartIndex() Returns the start index for the hit list.
SuggestedLink[]	getSuggestedLinks() Returns suggested links for the query.
Boolean	isDupMarked() Returns the Boolean value indicating if the duplicate documents are marked in the hit list.
Boolean	isDupRemoved() Returns the Boolean value indicating if the duplicate documents are removed from the hit list.
Boolean	isReturnCount()

Methods inherited from class java.lang.Object

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

Constructor Detail

OracleSearchResult

public OracleSearchResult()

OracleSearchResult

public OracleSearchResult(Boolean returnCount,
                          Integer estimatedHitCount,
                          Boolean dupRemoved,
                          Boolean dupMarked,
                          ResultElement[] resultElements,
                          SuggestedLink[] suggestedLinks,
                          String query,
                          String altKeywords,
                          Integer startIndex,
                          Integer docsReturned)

Parameters:

returnCount - Boolean value indicating if the result includes count estimate for the hit list

estimatedHitCount - estimated count for the hit list. -1 means the search result does not return estimated hit count.

dupRemoved - Boolean value indicating whether duplicate documents have been removed from the result

dupMarked - Boolean value indicating whether duplicate document have been marked in the result

resultElements - hit list for the query

suggestedLinks - suggested links for the query

query - query string

altKeywords - alternate keywords for the query

startIndex - start index of the search result

docsReturned - number of search hits returned

Method Detail

getReturnCount

public Boolean getReturnCount()

Returns a Boolean value indicating whether the estimated hit count is included in the result.

isReturnCount

public Boolean isReturnCount()

getEstimatedHitCount

public Integer getEstimatedHitCount()

Returns the estimated hit count for the query.

getDupRemoved

public Boolean getDupRemoved()

Returns the Boolean value indicating if the duplicate documents are removed from the hit list.

isDupRemoved

public Boolean isDupRemoved()

Returns the Boolean value indicating if the duplicate documents are removed from the hit list.

Returns:

duplicate removal flag

getDupMarked

public Boolean getDupMarked()

Returns the Boolean value indicating if the duplicate documents are marked in the hit list.

isDupMarked

public Boolean isDupMarked()

Returns the Boolean value indicating if the duplicate documents are marked in the hit list.

Returns:

duplicate marked flag

getResultElements

public ResultElement[] getResultElements()

Returns the hit list for the query.

getSuggestedLinks

public SuggestedLink[] getSuggestedLinks()

Returns suggested links for the query.

getQuery

public String getQuery()

Returns the query string.

getAltKeywords

public String getAltKeywords()

Returns the alternate keywords for the query.

getStartIndex

public Integer getStartIndex()

Returns the start index for the hit list.

getDocsReturned

public Integer getDocsReturned()

Returns the number of search hits returned.

Skip navigation links