Package edu.indiana.lib.twinpeaks.search
Class QueryBase
- java.lang.Object
-
- edu.indiana.lib.twinpeaks.search.QueryBase
-
- All Implemented Interfaces:
QueryInterface
- Direct Known Subclasses:
HttpTransactionQueryBase
public abstract class QueryBase extends Object implements QueryInterface
This module provides a single, core implementation of QueryInterface. It provides "lowest common denominator" functionality. In reality, each search application should extend QueryBase and implement appropriate methods. See HttpTransactionQueryBase.java for an example.
-
-
Constructor Summary
Constructors Constructor Description QueryBase()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description IntegergetIntegerRequestParameter(String name)Fetch a request parameter by nameStringgetRequestParameter(String name)Fetch a request parameter by nameMapgetRequestParameterMap()Fetch the entire request parameter Mapabstract StringgetSearchString()Fetch the current search textabstract StringgetUrl()Fetch the current search URLvoidparseRequest(Map parameterMap)Parse user request parameters.protected voidpopulateRequestParameters(Map parameterMap)Populate user request parameters-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface edu.indiana.lib.twinpeaks.search.QueryInterface
doQuery, getResponseBytes, getResponseString, initialize
-
-
-
-
Method Detail
-
getUrl
public abstract String getUrl()
Fetch the current search URL- Returns:
- The URL (as a String)
-
getSearchString
public abstract String getSearchString()
Fetch the current search text- Returns:
- The search string
-
populateRequestParameters
protected void populateRequestParameters(Map parameterMap)
Populate user request parameters- Parameters:
parameterMap- Request details as a map (name=value pairs)
-
parseRequest
public void parseRequest(Map parameterMap)
Parse user request parameters. This base method supports only the standard, simple query format. Override if necessary.- Specified by:
parseRequestin interfaceQueryInterface- Parameters:
parameterMap- Request details (name=value pairs)
-
getRequestParameter
public String getRequestParameter(String name)
Fetch a request parameter by name- Specified by:
getRequestParameterin interfaceQueryInterface- Parameters:
name- Parameter name- Returns:
- Parameter value
-
getIntegerRequestParameter
public Integer getIntegerRequestParameter(String name)
Fetch a request parameter by name- Parameters:
name- Parameter name- Returns:
- Parameter value (an Integer)
-
getRequestParameterMap
public Map getRequestParameterMap()
Fetch the entire request parameter Map- Returns:
- Parameter Map
-
-