edu.indiana.lib.twinpeaks.search.sru

Class SruQueryBase

java.lang.Object

edu.indiana.lib.twinpeaks.search.QueryBase

edu.indiana.lib.twinpeaks.search.HttpTransactionQueryBase

edu.indiana.lib.twinpeaks.search.sru.SruQueryBase

All Implemented Interfaces:

HttpTransactionQueryInterface, QueryInterface

Direct Known Subclasses:

Query

public abstract class SruQueryBase
extends HttpTransactionQueryBase

Basic SRU query functionality

Field Summary

Fields

Modifier and Type	Field and Description
static String	SRU_EXPLAIN
static String	SRU_MAX_RECORD
static String	SRU_OPERATION
static String	SRU_QUERY
static String	SRU_RECORD_PACKING
static String	SRU_RECORD_SCHEMA
static String	SRU_SEARCH_RETRIEVE
static String	SRU_SORT
static String	SRU_START_RECORD
static String	SRU_STATUS
static String	SRU_VERSION

Fields inherited from interface edu.indiana.lib.twinpeaks.search.HttpTransactionQueryInterface

METHOD_GET, METHOD_POST, REDIRECT_AUTOMATIC, REDIRECT_MANAGED, REDIRECT_MANAGED_SINGLESTEP

Constructor Summary

Constructors

Constructor and Description
SruQueryBase()

Method Summary

Modifier and Type	Method and Description
protected String	addFirstParameter(String newParameter) Add the first parameter to a new parameter list
protected String	addParameter(String base, String newParameter) Add a parameter to the parameter list
protected String	appendItems(String... items) Trim and concatenate all arguments
protected String	formatParameter(String name, String value) Format a parameter (name=value)
protected String	normalizeParameter(String value) Normalize a query parameter value
protected String	sruExplain() Make an explain operation parameter
protected String	sruMaximumRecords(int maximum) Make a maximum record parameter
protected String	sruMaximumRecords(String maximum) Make a maximum record parameter
protected String	sruOperation(String operation) Make an SRU operation parameter
protected void	sruPostExplain() Make an explain operation parameter
protected void	sruPostMaximumRecords(int maximum) Make a maximum record parameter
protected void	sruPostMaximumRecords(String maximum) Make a maximum record parameter
protected void	sruPostOperation(String operation) Make an SRU operation parameter
protected void	sruPostQuery(String criteria) Make a query parameter
protected void	sruPostRecordPacking(String packing) Make a record packing parameter
protected void	sruPostRecordSchema(String schema) Make a record schema parameter
protected void	sruPostSearchRetrieve() Make a searchRetrieve operation parameter
protected void	sruPostSort(String key) Make a sort parameter
protected void	sruPostStartRecord(int start) Make a start record parameter
protected void	sruPostStartRecord(String start) Make a start record parameter
protected void	sruPostStatus() Make a status operation parameter
protected void	sruPostVersion(String version) Make a version parameter (this is the version of our SRU request)
protected String	sruQuery(String criteria) Make a query parameter
protected String	sruRecordPacking(String packing) Make a record packing parameter
protected String	sruRecordSchema(String schema) Make a record schema parameter
protected String	sruSearchRetrieve() Make a searchRetrieve operation parameter
protected String	sruSort(String key) Make a sort parameter
protected String	sruStartRecord(int start) Make a start record parameter
protected String	sruStartRecord(String start) Make a start record parameter
protected String	sruStatus() Make a status operation parameter
protected String	sruVersion(String version) Make a version parameter (this is the version of our SRU request)

Methods inherited from class edu.indiana.lib.twinpeaks.search.HttpTransactionQueryBase

clearParameters, getBody, getFollowRedirects, getFormElement, getParameter, getParameterName, getQueryDocument, getQueryMethod, getQueryUrl, getResponseBytes, getResponseCharacterSet, getResponseDocument, getResponseHeader, getResponseString, getSearchString, getSessionContext, getSessionParameter, getSessionValue, getUrl, initialize, newFullUrl, removeQueryUrl, removeSessionParameter, setDefaultCharacterSet, setParameter, setParametersFromFormInputs, setParametersFromInputNames, setParametersFromInputs, setParametersFromInputValues, setParametersFromNameList, setParametersFromValueList, setPreserveBaseUrlFile, setQueryDocument, setQueryMethod, setQueryUrl, setRedirectBehavior, setSearchString, setSessionParameter, setSessionValue, setUrl, setUrl, setUrlFromAnchor, setUrlFromForm, submit

Methods inherited from class edu.indiana.lib.twinpeaks.search.QueryBase

getIntegerRequestParameter, getRequestParameter, getRequestParameterMap, parseRequest, populateRequestParameters

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

Field Detail

SRU_VERSION

public static final String SRU_VERSION

See Also:

Constant Field Values

SRU_OPERATION

public static final String SRU_OPERATION

See Also:

Constant Field Values

SRU_EXPLAIN

public static final String SRU_EXPLAIN

See Also:

Constant Field Values

SRU_SEARCH_RETRIEVE

public static final String SRU_SEARCH_RETRIEVE

See Also:

Constant Field Values

SRU_STATUS

public static final String SRU_STATUS

See Also:

Constant Field Values

SRU_RECORD_PACKING

public static final String SRU_RECORD_PACKING

See Also:

Constant Field Values

SRU_RECORD_SCHEMA

public static final String SRU_RECORD_SCHEMA

See Also:

Constant Field Values

SRU_START_RECORD

public static final String SRU_START_RECORD

See Also:

Constant Field Values

SRU_MAX_RECORD

public static final String SRU_MAX_RECORD

See Also:

Constant Field Values

SRU_SORT

public static final String SRU_SORT

See Also:

Constant Field Values

SRU_QUERY

public static final String SRU_QUERY

See Also:

Constant Field Values

Constructor Detail

SruQueryBase

public SruQueryBase()

Method Detail

sruVersion

protected String sruVersion(String version)

Make a version parameter (this is the version of our SRU request)

Returns:

The fully formed version parameter

sruExplain

protected String sruExplain()

Make an explain operation parameter

Returns:

The fully formed operation

sruSearchRetrieve

protected String sruSearchRetrieve()

Make a searchRetrieve operation parameter

Returns:

The fully formed operation

sruOperation

protected String sruOperation(String operation)

Make an SRU operation parameter

Parameters:

The - desired operation (searchRetrieve, explain, etc)

Returns:

The fully formed operation

sruStatus

protected String sruStatus()

Make a status operation parameter

Returns:

The fully formed operation

sruRecordPacking

protected String sruRecordPacking(String packing)

Make a record packing parameter

Parameters:

packing - How to pack (escape) result records (typically xml)

Returns:

A fully formed record packing parameter

sruRecordSchema

protected String sruRecordSchema(String schema)

Make a record schema parameter

Parameters:

schema - Schema to use

Returns:

A fully formed schema parameter

sruStartRecord

protected String sruStartRecord(String start)

Make a start record parameter

Parameters:

start - The starting record number

Returns:

A fully formed start record parameter

sruStartRecord

protected String sruStartRecord(int start)

Make a start record parameter

Parameters:

start - The starting record number

Returns:

A fully formed start record parameter

sruMaximumRecords

protected String sruMaximumRecords(int maximum)

Make a maximum record parameter

Parameters:

maximum - The maximum record to return

Returns:

A fully formed maximum record parameter

sruMaximumRecords

protected String sruMaximumRecords(String maximum)

Make a maximum record parameter

Parameters:

maximum - The maximum record to return

Returns:

A fully formed maximum record parameter

sruSort

protected String sruSort(String key)

Make a sort parameter

Parameters:

key - The sort key

Returns:

A fully formed sort parameter

sruQuery

protected String sruQuery(String criteria)

Make a query parameter

Parameters:

criteria - The search criteria

Returns:

A fully formed query parameter

sruPostVersion

protected void sruPostVersion(String version)

Make a version parameter (this is the version of our SRU request)

sruPostExplain

protected void sruPostExplain()

Make an explain operation parameter

sruPostSearchRetrieve

protected void sruPostSearchRetrieve()

Make a searchRetrieve operation parameter

sruPostOperation

protected void sruPostOperation(String operation)

Make an SRU operation parameter

Parameters:

The - desired operation (searchRetrieve, explain, etc)

sruPostStatus

protected void sruPostStatus()

Make a status operation parameter

sruPostRecordPacking

protected void sruPostRecordPacking(String packing)

Make a record packing parameter

Parameters:

packing - How to pack (escape) result records (typically xml)

sruPostRecordSchema

protected void sruPostRecordSchema(String schema)

Make a record schema parameter

Parameters:

schema - Schema to use

sruPostStartRecord

protected void sruPostStartRecord(String start)

Make a start record parameter

Parameters:

start - The starting record number

sruPostStartRecord

protected void sruPostStartRecord(int start)

Make a start record parameter

Parameters:

start - The starting record number

sruPostMaximumRecords

protected void sruPostMaximumRecords(int maximum)

Make a maximum record parameter

Parameters:

maximum - The maximum record to return

sruPostMaximumRecords

protected void sruPostMaximumRecords(String maximum)

Make a maximum record parameter

Parameters:

maximum - The maximum record to return

sruPostSort

protected void sruPostSort(String key)

Make a sort parameter

Parameters:

key - The sort key

sruPostQuery

protected void sruPostQuery(String criteria)

Make a query parameter

Parameters:

criteria - The search criteria

appendItems

protected String appendItems(String... items)

Trim and concatenate all arguments

Parameters:

items - Items to append

Returns:

The concatenated items

formatParameter

protected String formatParameter(String name,
                                 String value)

Format a parameter (name=value)

Parameters:

name - Parameter name

value - Parameter value

Returns:

The name=value pair

addFirstParameter

protected String addFirstParameter(String newParameter)

Add the first parameter to a new parameter list

Parameters:

newParameter - Parmeter to add

Returns:

the updated list

addParameter

protected String addParameter(String base,
                              String newParameter)

Add a parameter to the parameter list

Parameters:

base - Base parameter list - we'll add to this

newParameter - Parmeter to add

Returns:

the updated list

normalizeParameter

protected String normalizeParameter(String value)

Normalize a query parameter value

Parameters:

value - Parameter value

Returns:

The [possibly] normalized value