org.licas_text.search.vendor

Class VendorEngine

java.lang.Object

org.licas_text.search.vendor.VendorEngine

Direct Known Subclasses:

BingSearchEngine, GoogleApiSearchEngine, SwoogleSearchEngine, YahooSearchEngine

public abstract class VendorEngine
extends java.lang.Object

Base class for web-based searches, using a vendor-specific commercial search engine.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	baseUri URI for the site search engine
static java.lang.String	HTML
static java.lang.String	JSON
protected java.lang.String	searchUri URI with the current search query appended
protected java.util.ArrayList<java.net.URL>	searchUrls Lists of search result URLs

Constructor Summary

Constructors

Constructor and Description
VendorEngine() Create a new instance of VendorEngine.

Method Summary

Modifier and Type	Method and Description
static VendorEngine	getSearchEngine(java.lang.String vendor) Create and return a search engine object for the specified vendor type.
java.lang.String	getSearchURI() Get the last search URI that was constructed.
static java.util.ArrayList<java.lang.String>	getSearchVendors() Get a list of search vendors that supply an online search engine.
abstract java.lang.String	replyFormat() Return the type of format that the search reply is in.
protected abstract java.lang.String	restOfURI(int pageNumber) Construct a basic 'rest of the URI' to add to the search request.
void	setSearchURI(java.lang.String thisSearchUri) Set the search URI description.
java.util.ArrayList<java.lang.String>	vendorSearch(SearchInfo searchInfo) Search the web using the Vendor search engine.
java.util.ArrayList<java.lang.String>	vendorSearch(SearchInfo searchInfo, boolean constructUri) Search the web using the Vendor search engine.

Methods inherited from class java.lang.Object

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

Field Detail

HTML

public static java.lang.String HTML

JSON

public static java.lang.String JSON

baseUri

protected java.lang.String baseUri

URI for the site search engine

searchUri

protected java.lang.String searchUri

URI with the current search query appended

searchUrls

protected java.util.ArrayList<java.net.URL> searchUrls

Lists of search result URLs

Constructor Detail

VendorEngine

public VendorEngine()

Create a new instance of VendorEngine.

Method Detail

replyFormat

public abstract java.lang.String replyFormat()

Return the type of format that the search reply is in.

Returns:

the reply format, can be HTML or JSON.

restOfURI

protected abstract java.lang.String restOfURI(int pageNumber)

Construct a basic 'rest of the URI' to add to the search request.

Parameters:

pageNumber - search page number to return.

Returns:

a formatted URI description part, for after the search request.

vendorSearch

public java.util.ArrayList<java.lang.String> vendorSearch(SearchInfo searchInfo)
                                                   throws java.lang.Exception

Search the web using the Vendor search engine. The search term and page number are set. As well as that, each vendor has a different call and reply format.

Parameters:

searchInfo - the search configuration. Note that the searchInfo.pageEntryNumber method can be used to set the search result page, or start search entry number.

Returns:

a list of whole HTML pages returned as the search result. Default is 1.

Throws:

java.lang.Exception - any error.

vendorSearch

public java.util.ArrayList<java.lang.String> vendorSearch(SearchInfo searchInfo,
                                                          boolean constructUri)
                                                   throws java.lang.Exception

Search the web using the Vendor search engine. The search term and page number are set. As well as that, each vendor has a different call and reply format.

Parameters:

searchInfo - the search configuration. Note that the searchInfo.pageEntryNumber method can be used to set the search result page, or start search entry number.

constructUri - if true construct the URI description automatically from the info. If false, then it needs to be set beforehand and is then used as is.

Returns:

a list of whole HTML pages returned as the search result. Default is 1.

Throws:

java.lang.Exception - any error.

setSearchURI

public void setSearchURI(java.lang.String thisSearchUri)

Set the search URI description.

Parameters:

thisSearchUri - the search description for a REST service.

getSearchURI

public java.lang.String getSearchURI()

Get the last search URI that was constructed.

Returns:

the value of searchURI.

getSearchVendors

public static java.util.ArrayList<java.lang.String> getSearchVendors()

Get a list of search vendors that supply an online search engine.

Returns:

the list of vendor names that have engine implementations.

getSearchEngine

public static VendorEngine getSearchEngine(java.lang.String vendor)

Create and return a search engine object for the specified vendor type.

Parameters:

vendor - the name of the vendor.

Returns:

a engine implementation that calls the online service and parses the reply.