oracle.ultrasearch.query
Class Result

java.lang.Object
oracle.ultrasearch.query.Result

public class Result

extends java.lang.Object

A result provides access to a search result. A Result object is generated by performing a Query on an Instance.

Since:

9.0.2

Method Summary

int	estimateHitCount() Get the estimated total number of hits for this query.
Request	getRequest() return the request this result is for.
java.util.Iterator	iterator() Get an iterator of the documents in the search result.
int	size() Returns the number of documents in this result.
java.lang.String	toXML() Returns a string containing the XML representation of the query result.

Methods inherited from class java.lang.Object

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

Method Detail

getRequest

public Request getRequest()

return the request this result is for.

Returns:

a Request object, null allowed.

iterator

public java.util.Iterator iterator()

Get an iterator of the documents in the search result.

Returns:

an iterator of Document objects

estimateHitCount

public int estimateHitCount()

Get the estimated total number of hits for this query.

Returns:

the estimated hit count, -1 if hit count was not requested.

size

public int size()

Returns the number of documents in this result.

Returns:

the number of documents in this result.

toXML

public java.lang.String toXML()

Returns a string containing the XML representation of the query result.

Returns:

an xml string