com.yahoo.search.xmlparser
Class XmlParserLocalSearchResults

java.lang.Object
  extended by com.yahoo.search.xmlparser.XmlParserLocalSearchResults
All Implemented Interfaces:
LocalSearchResults

public class XmlParserLocalSearchResults
extends Object
implements LocalSearchResults


Nested Class Summary
static class XmlParserLocalSearchResults.XmlParserLocalSearchResult
           
 
Field Summary
static Map TYPE_MAP
           
 
Constructor Summary
XmlParserLocalSearchResults(Map root)
           
 
Method Summary
 BigInteger getFirstResultPosition()
          The position of the first result in the overall search.
 String getResultsMapUrl()
          The URL of a webpage containing a map graphic with all returned results plotted on it.
 BigInteger getTotalResultsAvailable()
          The number of query matches in the database.
 BigInteger getTotalResultsReturned()
          The number of query matches returned.
 LocalSearchResult[] listResults()
          The list (in order) of results from the search.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPE_MAP

public static final Map TYPE_MAP
Constructor Detail

XmlParserLocalSearchResults

public XmlParserLocalSearchResults(Map root)
Method Detail

getTotalResultsAvailable

public BigInteger getTotalResultsAvailable()
Description copied from interface: LocalSearchResults
The number of query matches in the database.

Specified by:
getTotalResultsAvailable in interface LocalSearchResults
Returns:
The number of query matches in the database.

getTotalResultsReturned

public BigInteger getTotalResultsReturned()
Description copied from interface: LocalSearchResults
The number of query matches returned. This may be lower than the number of results requested if there were fewer total results available.

Specified by:
getTotalResultsReturned in interface LocalSearchResults
Returns:
The number of query matches returned.

getFirstResultPosition

public BigInteger getFirstResultPosition()
Description copied from interface: LocalSearchResults
The position of the first result in the overall search.

Specified by:
getFirstResultPosition in interface LocalSearchResults
Returns:
The position of the first result in the overall search.

getResultsMapUrl

public String getResultsMapUrl()
Description copied from interface: LocalSearchResults
The URL of a webpage containing a map graphic with all returned results plotted on it.

Specified by:
getResultsMapUrl in interface LocalSearchResults
Returns:
The URL of a webpage containing a map graphic with all returned results plotted on it.

listResults

public LocalSearchResult[] listResults()
Description copied from interface: LocalSearchResults
The list (in order) of results from the search.

Specified by:
listResults in interface LocalSearchResults
Returns:
The list (in order) of results from the search.