A C G I L N P R S T V W

A

addLicense(String) - Method in class com.yahoo.search.ContextSearchRequest

The Creative Commons license that the contents are licensed under.

addLicense(String) - Method in class com.yahoo.search.WebSearchRequest

The Creative Commons license that the contents are licensed under.

C

CacheInfo - interface com.yahoo.search.CacheInfo.

Represents the cached copy of the URL content.

com.yahoo.search - package com.yahoo.search

Yahoo Search Web Service SDK

ContentAnalysisRequest - class com.yahoo.search.ContentAnalysisRequest.

Content analyis request.

ContentAnalysisRequest(String) - Constructor for class com.yahoo.search.ContentAnalysisRequest

Constructs a new content analysis request.

ContentAnalysisResults - interface com.yahoo.search.ContentAnalysisResults.

Content analysis (term extraction) results.

ContextSearchRequest - class com.yahoo.search.ContextSearchRequest.

Context search request object.

ContextSearchRequest(String) - Constructor for class com.yahoo.search.ContextSearchRequest

Constructs a new image search request.

contextWebSearch(ContextSearchRequest) - Method in class com.yahoo.search.SearchClient

Searches the Yahoo database for web results using a context-based query.

G

getAddress() - Method in interface com.yahoo.search.LocalSearchResult

Street address of the result.

getBusinessClickUrl() - Method in interface com.yahoo.search.LocalSearchResult

The URL for linking to the businesses website if known.

getBusinessUrl() - Method in interface com.yahoo.search.LocalSearchResult

The URL of the businesses website, if known.

getCache() - Method in interface com.yahoo.search.WebSearchResult

The URL of the cached result, and its size in bytes.

getChannels() - Method in interface com.yahoo.search.VideoSearchResult

Either 1 (mono) or 2 (stereo).

getCity() - Method in interface com.yahoo.search.LocalSearchResult

City in which the result is located.

getClickUrl() - Method in interface com.yahoo.search.NewsSearchResult

The URL for linking to the article.

getClickUrl() - Method in interface com.yahoo.search.VideoSearchResult

The URL for linking to the video file.

getClickUrl() - Method in interface com.yahoo.search.ImageSearchResult

The URL for linking to the image file.

getClickUrl() - Method in interface com.yahoo.search.LocalSearchResult

The URL for linking to the detailed page for a business.

getClickUrl() - Method in interface com.yahoo.search.WebSearchResult

The URL for linking to the page.

getCopyright() - Method in interface com.yahoo.search.VideoSearchResult

The copyright owner.

getCopyright() - Method in interface com.yahoo.search.ImageSearchResult

The copyright owner.

getDistance() - Method in interface com.yahoo.search.LocalSearchResult

Distance in miles.

getDuration() - Method in interface com.yahoo.search.VideoSearchResult

The duration of the video file in seconds.

getExtractedTerms() - Method in interface com.yahoo.search.ContentAnalysisResults

The terms extracted from the content.

getFileFormat() - Method in interface com.yahoo.search.VideoSearchResult

One of avi, flash, mpeg, msmedia, quicktime, or realmedia.

getFileFormat() - Method in interface com.yahoo.search.ImageSearchResult

One of bmp, gif, jpg, or png.

getFileSize() - Method in interface com.yahoo.search.VideoSearchResult

The size of the file in bytes.

getFileSize() - Method in interface com.yahoo.search.ImageSearchResult

The size of the file in bytes.

getFirstResultPosition() - Method in interface com.yahoo.search.ImageSearchResults

The position of the first result in the overall search.

getFirstResultPosition() - Method in interface com.yahoo.search.NewsSearchResults

The position of the first result in the overall search.

getFirstResultPosition() - Method in interface com.yahoo.search.LocalSearchResults

The position of the first result in the overall search.

getFirstResultPosition() - Method in interface com.yahoo.search.WebSearchResults

The position of the first result in the overall search.

getFirstResultPosition() - Method in interface com.yahoo.search.VideoSearchResults

The position of the first result in the overall search.

getHeight() - Method in interface com.yahoo.search.ImageThumbnail

The height of the image thumbnail in pixels.

getHeight() - Method in interface com.yahoo.search.VideoSearchResult

The height of the keyframe Yahoo extracted from the video in pixels.

getHeight() - Method in interface com.yahoo.search.ImageSearchResult

The height of the image in pixels.

getLanguage() - Method in interface com.yahoo.search.NewsSearchResult

The language the article is written in.

getMapUrl() - Method in interface com.yahoo.search.LocalSearchResult

The URL of a map for the address.

getMimeType() - Method in interface com.yahoo.search.WebSearchResult

The MIME type of the page.

getModificationDate() - Method in interface com.yahoo.search.NewsSearchResult

The date the article was last modified, in unix timestamp format.

getModificationDate() - Method in interface com.yahoo.search.WebSearchResult

The date the page was last modified, in unix timestamp format.

getNewsSource() - Method in interface com.yahoo.search.NewsSearchResult

The company that distributed the news article, such as API or BBC.

getNewsSourceUrl() - Method in interface com.yahoo.search.NewsSearchResult

The URL for the news source.

getPhone() - Method in interface com.yahoo.search.LocalSearchResult

Phone number of the business, if known.

getPublishDate() - Method in interface com.yahoo.search.NewsSearchResult

The date the article was first published, in unix timestamp format.

getPublisher() - Method in interface com.yahoo.search.VideoSearchResult

The creator of the video file.

getPublisher() - Method in interface com.yahoo.search.ImageSearchResult

The creator of the image file.

getRating() - Method in interface com.yahoo.search.LocalSearchResult

End-user ratings for the business or service.

getRefererUrl() - Method in interface com.yahoo.search.VideoSearchResult

The URL of the web page hosting the content.

getRefererUrl() - Method in interface com.yahoo.search.ImageSearchResult

The URL of the web page hosting the content.

getRestrictions() - Method in interface com.yahoo.search.VideoSearchResult

Provides any restrictions for this media object.

getRestrictions() - Method in interface com.yahoo.search.ImageSearchResult

Provides any restrictions for this media object.

getResultsMapUrl() - Method in interface com.yahoo.search.LocalSearchResults

The URL of a webpage containing a map graphic with all returned results plotted on it.

getSize() - Method in interface com.yahoo.search.CacheInfo

Size of the cached result, in bytes.

getState() - Method in interface com.yahoo.search.LocalSearchResult

State in which the result is located.

getSuggestion() - Method in interface com.yahoo.search.SpellingSuggestionResults

The text of the suggested correction.

getSuggestions() - Method in interface com.yahoo.search.RelatedSuggestionResults

The suggestions found for the given search query.

getSummary() - Method in interface com.yahoo.search.NewsSearchResult

Summary text associated with the article.

getSummary() - Method in interface com.yahoo.search.VideoSearchResult

Summary text associated with the video file.

getSummary() - Method in interface com.yahoo.search.ImageSearchResult

Summary text associated with the image file.

getSummary() - Method in interface com.yahoo.search.WebSearchResult

Summary text associated with the web page.

getThumbnail() - Method in interface com.yahoo.search.NewsSearchResult

The URL of a thumbnail file associated with the article, if present, and its height and width in pixels.

getThumbnail() - Method in interface com.yahoo.search.VideoSearchResult

The URL of the thumbnail file and its height and width in pixels.

getThumbnail() - Method in interface com.yahoo.search.ImageSearchResult

The URL of the thumbnail file and its height and width in pixels.

getTitle() - Method in interface com.yahoo.search.NewsSearchResult

The title of the article.

getTitle() - Method in interface com.yahoo.search.VideoSearchResult

The title of the video file.

getTitle() - Method in interface com.yahoo.search.ImageSearchResult

The title of the image file.

getTitle() - Method in interface com.yahoo.search.LocalSearchResult

Name of the result.

getTitle() - Method in interface com.yahoo.search.WebSearchResult

The title of the web page.

getTotalResultsAvailable() - Method in interface com.yahoo.search.ImageSearchResults

The number of query matches in the database.

getTotalResultsAvailable() - Method in interface com.yahoo.search.NewsSearchResults

The number of query matches in the database.

getTotalResultsAvailable() - Method in interface com.yahoo.search.LocalSearchResults

The number of query matches in the database.

getTotalResultsAvailable() - Method in interface com.yahoo.search.WebSearchResults

The number of query matches in the database.

getTotalResultsAvailable() - Method in interface com.yahoo.search.VideoSearchResults

The number of query matches in the database.

getTotalResultsReturned() - Method in interface com.yahoo.search.ImageSearchResults

The number of query matches returned.

getTotalResultsReturned() - Method in interface com.yahoo.search.NewsSearchResults

The number of query matches returned.

getTotalResultsReturned() - Method in interface com.yahoo.search.LocalSearchResults

The number of query matches returned.

getTotalResultsReturned() - Method in interface com.yahoo.search.WebSearchResults

The number of query matches returned.

getTotalResultsReturned() - Method in interface com.yahoo.search.VideoSearchResults

The number of query matches returned.

getUrl() - Method in interface com.yahoo.search.CacheInfo

The URL of the cached result.

getUrl() - Method in interface com.yahoo.search.NewsSearchResult

The URL for the article.

getUrl() - Method in interface com.yahoo.search.ImageThumbnail

The URL for the image thumbnail.

getUrl() - Method in interface com.yahoo.search.VideoSearchResult

The URL for the video file or stream.

getUrl() - Method in interface com.yahoo.search.ImageSearchResult

The URL for the image file.

getUrl() - Method in interface com.yahoo.search.LocalSearchResult

The URL to the detailed page for a business.

getUrl() - Method in interface com.yahoo.search.WebSearchResult

The URL for the web page.

getWidth() - Method in interface com.yahoo.search.ImageThumbnail

The width of the image thumbnail in pixels.

getWidth() - Method in interface com.yahoo.search.VideoSearchResult

The width of the keyframe Yahoo extracted from the video in pixels.

getWidth() - Method in interface com.yahoo.search.ImageSearchResult

The width of the image in pixels.

I

imageSearch(ImageSearchRequest) - Method in class com.yahoo.search.SearchClient

Searches the Yahoo database for image files.

ImageSearchRequest - class com.yahoo.search.ImageSearchRequest.

Image search request object.

ImageSearchRequest(String) - Constructor for class com.yahoo.search.ImageSearchRequest

Constructs a new image search request.

ImageSearchResult - interface com.yahoo.search.ImageSearchResult.

Individual image search result.

ImageSearchResults - interface com.yahoo.search.ImageSearchResults.

Image search results and results metadata.

ImageThumbnail - interface com.yahoo.search.ImageThumbnail.

Image thumbnail.

isStreaming() - Method in interface com.yahoo.search.VideoSearchResult

Whether the video file is streaming (true) or not (false).

L

listResults() - Method in interface com.yahoo.search.ImageSearchResults

The list (in order) of results from the search.

listResults() - Method in interface com.yahoo.search.NewsSearchResults

The list (in order) of results from the search.

listResults() - Method in interface com.yahoo.search.LocalSearchResults

The list (in order) of results from the search.

listResults() - Method in interface com.yahoo.search.WebSearchResults

The list (in order) of results from the search.

listResults() - Method in interface com.yahoo.search.VideoSearchResults

The list (in order) of results from the search.

localSearch(LocalSearchRequest) - Method in class com.yahoo.search.SearchClient

Searches the Yahoo database for local results.

LocalSearchRequest - class com.yahoo.search.LocalSearchRequest.

Local search request object.

LocalSearchRequest(String) - Constructor for class com.yahoo.search.LocalSearchRequest

Constructs a new local search request.

LocalSearchResult - interface com.yahoo.search.LocalSearchResult.

Local search result.

LocalSearchResults - interface com.yahoo.search.LocalSearchResults.

Local search results.

N

newsSearch(NewsSearchRequest) - Method in class com.yahoo.search.SearchClient

Searches the Yahoo database for news results.

NewsSearchRequest - class com.yahoo.search.NewsSearchRequest.

News search request object.

NewsSearchRequest(String) - Constructor for class com.yahoo.search.NewsSearchRequest

Constructs a new news search request.

NewsSearchResult - interface com.yahoo.search.NewsSearchResult.

News search result.

NewsSearchResults - interface com.yahoo.search.NewsSearchResults.

News search results.

P

printStackTrace() - Method in class com.yahoo.search.SearchException

printStackTrace(PrintStream) - Method in class com.yahoo.search.SearchException

printStackTrace(PrintWriter) - Method in class com.yahoo.search.SearchException

R

relatedSuggestion(RelatedSuggestionRequest) - Method in class com.yahoo.search.SearchClient

Requests search terms related to the given search term.

RelatedSuggestionRequest - class com.yahoo.search.RelatedSuggestionRequest.

Related search suggestion request.

RelatedSuggestionRequest(String) - Constructor for class com.yahoo.search.RelatedSuggestionRequest

Constructs a new related search suggestion request.

RelatedSuggestionResults - interface com.yahoo.search.RelatedSuggestionResults.

Related search suggestion results.

S

SearchClient - class com.yahoo.search.SearchClient.

The SearchClient class handles all calls to/from the Yahoo Search Web Service.

SearchClient(String) - Constructor for class com.yahoo.search.SearchClient

Constructs a new SearchClient with the given application ID using the default settings.

SearchException - exception com.yahoo.search.SearchException.

Exception class indicating a search failure caused by either a client error (invalid or missing argument) or a service error.

SearchException(String) - Constructor for class com.yahoo.search.SearchException

Constructs a search exception with a message.

SearchException(String, Throwable) - Constructor for class com.yahoo.search.SearchException

Constructs a search exception with a message and an underlying cause.

setAdultOk(boolean) - Method in class com.yahoo.search.VideoSearchRequest

Specifies if adult related results are permitted.

setAdultOk(boolean) - Method in class com.yahoo.search.ContextSearchRequest

Specifies if adult related results are permitted.

setAdultOk(boolean) - Method in class com.yahoo.search.ImageSearchRequest

Specifies if adult related results are permitted.

setAdultOk(boolean) - Method in class com.yahoo.search.WebSearchRequest

Specifies if adult related results are permitted.

setCity(String) - Method in class com.yahoo.search.LocalSearchRequest

City name.

setColoration(String) - Method in class com.yahoo.search.ImageSearchRequest

The service returns only the images of the coloration specified (color or black-and-white).

setContext(String) - Method in class com.yahoo.search.ContextSearchRequest

The context to extract meaning from.

setContext(String) - Method in class com.yahoo.search.ContentAnalysisRequest

The context to extract terms from.

setCountry(String) - Method in class com.yahoo.search.ContextSearchRequest

The country code for the country the website is located in.

setCountry(String) - Method in class com.yahoo.search.WebSearchRequest

Restricts the results to a given country.

setFormat(String) - Method in class com.yahoo.search.VideoSearchRequest

Specifies the kind of video file to search for.

setFormat(String) - Method in class com.yahoo.search.ContextSearchRequest

Specifies the kind of content to search for.

setFormat(String) - Method in class com.yahoo.search.ImageSearchRequest

Specifies the kind of image file to search for.

setFormat(String) - Method in class com.yahoo.search.WebSearchRequest

Specifies the kind of web document to search for.

setLanguage(String) - Method in class com.yahoo.search.ContextSearchRequest

The language the results are written in.

setLanguage(String) - Method in class com.yahoo.search.WebSearchRequest

The language the results are written in.

setLanguage(String) - Method in class com.yahoo.search.NewsSearchRequest

The language the results are written in.

setLatitude(String) - Method in class com.yahoo.search.LocalSearchRequest

Sets the latitude of the local area to search.

setLocation(String) - Method in class com.yahoo.search.LocalSearchRequest

Sets the location portion of the search as a string.

setLongitude(String) - Method in class com.yahoo.search.LocalSearchRequest

Sets the longitude of the local area to search.

setQuery(String) - Method in class com.yahoo.search.VideoSearchRequest

setQuery(String) - Method in class com.yahoo.search.ContextSearchRequest

The query to search for.

setQuery(String) - Method in class com.yahoo.search.ContentAnalysisRequest

An optional query to help with the extraction process.

setQuery(String) - Method in class com.yahoo.search.ImageSearchRequest

The image query to search for.

setQuery(String) - Method in class com.yahoo.search.WebSearchRequest

setQuery(String) - Method in class com.yahoo.search.SpellingSuggestionRequest

setQuery(String) - Method in class com.yahoo.search.NewsSearchRequest

setQuery(String) - Method in class com.yahoo.search.LocalSearchRequest

setQuery(String) - Method in class com.yahoo.search.RelatedSuggestionRequest

setRadius(float) - Method in class com.yahoo.search.LocalSearchRequest

How far from the specified location to search for the query terms.

setResults(int) - Method in class com.yahoo.search.VideoSearchRequest

The maximum number of results to return.

setResults(int) - Method in class com.yahoo.search.ContextSearchRequest

The maximum number of results to return.

setResults(int) - Method in class com.yahoo.search.ImageSearchRequest

The maximum number of results to return.

setResults(int) - Method in class com.yahoo.search.WebSearchRequest

The maximum number of results to return.

setResults(int) - Method in class com.yahoo.search.NewsSearchRequest

The maximum number of results to return.

setResults(int) - Method in class com.yahoo.search.LocalSearchRequest

The maximum number of results to return.

setResults(int) - Method in class com.yahoo.search.RelatedSuggestionRequest

The maximum number of results to return.

setSimilarOk(boolean) - Method in class com.yahoo.search.ContextSearchRequest

Specifies whether to allow multiple results with similar content.

setSimilarOk(boolean) - Method in class com.yahoo.search.WebSearchRequest

Specifies whether to allow multiple results with similar content.

setSort(String) - Method in class com.yahoo.search.NewsSearchRequest

The sort order for news articles.

setSort(String) - Method in class com.yahoo.search.LocalSearchRequest

Sets the sort order for local search results.

setStart(BigInteger) - Method in class com.yahoo.search.VideoSearchRequest

The starting result position.

setStart(BigInteger) - Method in class com.yahoo.search.ImageSearchRequest

The starting result position.

setStart(BigInteger) - Method in class com.yahoo.search.WebSearchRequest

The starting result position.

setStart(BigInteger) - Method in class com.yahoo.search.NewsSearchRequest

The starting result position.

setStart(BigInteger) - Method in class com.yahoo.search.LocalSearchRequest

The starting result position.

setStart(int) - Method in class com.yahoo.search.ContextSearchRequest

The starting result position.

setState(String) - Method in class com.yahoo.search.LocalSearchRequest

The United States state.

setStreet(String) - Method in class com.yahoo.search.LocalSearchRequest

Street name, the number is optional.

setType(String) - Method in class com.yahoo.search.VideoSearchRequest

Sets the type of the search.

setType(String) - Method in class com.yahoo.search.ContextSearchRequest

Sets the type of the search.

setType(String) - Method in class com.yahoo.search.ImageSearchRequest

Sets the type of the search.

setType(String) - Method in class com.yahoo.search.WebSearchRequest

Sets the type of the search.

setType(String) - Method in class com.yahoo.search.NewsSearchRequest

Sets the type of the search.

setZip(String) - Method in class com.yahoo.search.LocalSearchRequest

The five-digit zip code, or the five-digit code plus four-digit extension.

spellingSuggestion(SpellingSuggestionRequest) - Method in class com.yahoo.search.SearchClient

Requests a possible spelling correction for the given query.

SpellingSuggestionRequest - class com.yahoo.search.SpellingSuggestionRequest.

Spelling suggestion request object.

SpellingSuggestionRequest(String) - Constructor for class com.yahoo.search.SpellingSuggestionRequest

Constructs a new spelling suggestion request.

SpellingSuggestionResults - interface com.yahoo.search.SpellingSuggestionResults.

Spelling suggestion results.

T

termExtractionSearch(ContentAnalysisRequest) - Method in class com.yahoo.search.SearchClient

Searches a bit of content for relevant, related search terms.

V

videoSearch(VideoSearchRequest) - Method in class com.yahoo.search.SearchClient

Searches the Yahoo database for video files.

VideoSearchRequest - class com.yahoo.search.VideoSearchRequest.

Video search request object.

VideoSearchRequest(String) - Constructor for class com.yahoo.search.VideoSearchRequest

Constructs a new video search request.

VideoSearchResult - interface com.yahoo.search.VideoSearchResult.

Video search result.

VideoSearchResults - interface com.yahoo.search.VideoSearchResults.

Video search results.

W

webSearch(WebSearchRequest) - Method in class com.yahoo.search.SearchClient

Searches the Yahoo database for web results.

WebSearchRequest - class com.yahoo.search.WebSearchRequest.

Web search request object.

WebSearchRequest(String) - Constructor for class com.yahoo.search.WebSearchRequest

Constructs a new web search request.

WebSearchResult - interface com.yahoo.search.WebSearchResult.

Web search result.

WebSearchResults - interface com.yahoo.search.WebSearchResults.

Web search results.

A C G I L N P R S T V W