com.raritantechnologies.federated.html
Class HTMLQueryProcessor

java.lang.Object
  com.raritantechnologies.federated.html.HTMLQueryProcessor

All Implemented Interfaces:

IQueryProcessor

public class HTMLQueryProcessor

extends java.lang.Object

implements IQueryProcessor

Implements the IQueryProcessor interface by sending an HTTP query (Post or Get) to an http search site and "scraping" the HTML page returned by the HTTP server to a XML result.

Associated with an HTMLSearchSource which defines the search form mapping needed to search an HTTP site and the HTML scraper configuration needed to transform the returned HTML pages into XML. The XML produced by the HTMLScraper is then transformed by an XSL transform to create a FederatedResultSet.

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Constructor Summary

HTMLQueryProcessor()

Method Summary

IResultSet

executeQuery(java.lang.Integer queryID, ISearchFieldMap searchMap, SourceLoginInfo[] sources, OrderedMap inputParameters, java.lang.Integer pageSize, java.lang.Integer startRec) Executes the search assuming that SourceLoginInfo contains a HTMLSearchSource.

Methods inherited from class java.lang.Object

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

Constructor Detail

HTMLQueryProcessor

public HTMLQueryProcessor()

Method Detail

executeQuery

public IResultSet executeQuery(java.lang.Integer queryID,
                               ISearchFieldMap searchMap,
                               SourceLoginInfo[] sources,
                               OrderedMap inputParameters,
                               java.lang.Integer pageSize,
                               java.lang.Integer startRec)
                        throws QueryProcessorException

Executes the search assuming that SourceLoginInfo contains a HTMLSearchSource. This should be established by the mappings established in the Config XML.

Specified by:

executeQuery in interface IQueryProcessor

Parameters:

queryID - Unique ID for this query. Used by front end to manage queries and query pages. QueryProcessor may use this parameter to organize its search results, and to organize any state information it needs to process future page requests (future executeQuery( ) calls with the same queryID.

searchMap - Provides mapping information needed to translate the inputParameters into a search string appropriate for this type of QueryProcessor. Mapping information is obtained by the application framework from local configuration data.

sources - The LoginInfo and SearchSource(s) to be used for this query. The SearchSource(s) must be of the appropriate type for the QueryProcessor.

inputParameters - Form inputs. Use ISearchFieldMap to translate these into implementation and source-specific fields.

pageSize - Integer specifying the number of results to include in the returned Document. if null - use the default page size.

startRec - Integer specifying the starting record in the result set to be returned. if null - start with the first record.

Returns:

IResultSet containing result set.

Throws:

QueryProcessorException