com.indexdata.masterkey.pazpar2.client
Class ClientCommand

java.lang.Object
  extended by com.indexdata.masterkey.pazpar2.client.ClientCommand

public class ClientCommand
extends Object

Wraps the query string of a request to the Service Proxy.

Author:
Niels Erik Nielsen

Field Summary
static String BASE_RECORD_PARAMETER
           
static String CLIENT_WINDOW_ID_PARAMETER
           
static String COMMAND_PARAMETER
           
static String RECORD_FILTER_PARAMETER
           
static String RECORD_QUERY_PARAMETER
           
static String TARGET_FILTER_PARAMETER
           
static String TORUS_QUERY_PARAMETER
           
 
Constructor Summary
ClientCommand(Map<String,String[]> params, String queryString)
          Create an instance of pazpar2 search command.
ClientCommand(String command, String queryString)
           
 
Method Summary
 boolean bytarget()
          Is this a 'bytarget' command
 String getCommand()
           
 String getPz2queryString()
           
 String getQueryString()
           
 String getRecordFilter()
           
 String getRecordFilterTargetCriteria()
           
 String getRecordQuery()
           
 String getTargetFilter()
           
 String getTorusParams()
           
 boolean hasRecordFilter()
          Does the SP request contain a record filter
 boolean hasRecordFilterTargetCriteria()
           
 boolean hasRecordQuery()
           
 boolean hasTorusParams()
          Does the SP request contain a torus query
 boolean isSameAs(ClientCommand anotherCommand)
          Compares queryStrings
 boolean ping()
           
 boolean record()
           
 boolean search()
          Is this a 'search' command
 void setRecordQuery(String recordQueryParam)
           
 boolean show()
          Is this a 'show' command
 boolean stat()
           
 boolean termlist()
          Is this a 'termlist' command
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLIENT_WINDOW_ID_PARAMETER

public static final String CLIENT_WINDOW_ID_PARAMETER
See Also:
Constant Field Values

RECORD_FILTER_PARAMETER

public static final String RECORD_FILTER_PARAMETER
See Also:
Constant Field Values

RECORD_QUERY_PARAMETER

public static final String RECORD_QUERY_PARAMETER
See Also:
Constant Field Values

BASE_RECORD_PARAMETER

public static final String BASE_RECORD_PARAMETER
See Also:
Constant Field Values

TORUS_QUERY_PARAMETER

public static final String TORUS_QUERY_PARAMETER
See Also:
Constant Field Values

COMMAND_PARAMETER

public static final String COMMAND_PARAMETER
See Also:
Constant Field Values

TARGET_FILTER_PARAMETER

public static final String TARGET_FILTER_PARAMETER
See Also:
Constant Field Values
Constructor Detail

ClientCommand

public ClientCommand(Map<String,String[]> params,
                     String queryString)
Create an instance of pazpar2 search command.

Parameters:
params - decoded HTTP params (e.g as returned by the Servlet#getParametersMap)
queryString - original, encoded query string
nonPz2Params - additional names of non-pz2 params

ClientCommand

public ClientCommand(String command,
                     String queryString)
Method Detail

search

public boolean search()
Is this a 'search' command

Returns:

record

public boolean record()

getRecordQuery

public String getRecordQuery()

hasRecordQuery

public boolean hasRecordQuery()

setRecordQuery

public void setRecordQuery(String recordQueryParam)

isSameAs

public boolean isSameAs(ClientCommand anotherCommand)
Compares queryStrings

Parameters:
anotherCommand -
Returns:

hasRecordFilter

public boolean hasRecordFilter()
Does the SP request contain a record filter

Returns:

hasRecordFilterTargetCriteria

public boolean hasRecordFilterTargetCriteria()

hasTorusParams

public boolean hasTorusParams()
Does the SP request contain a torus query

Returns:

bytarget

public boolean bytarget()
Is this a 'bytarget' command

Returns:

show

public boolean show()
Is this a 'show' command

Returns:

termlist

public boolean termlist()
Is this a 'termlist' command

Returns:
true if this is a termlist command

stat

public boolean stat()

ping

public boolean ping()

getCommand

public String getCommand()

getRecordFilter

public String getRecordFilter()

getRecordFilterTargetCriteria

public String getRecordFilterTargetCriteria()

getTorusParams

public String getTorusParams()

getTargetFilter

public String getTargetFilter()

getQueryString

public String getQueryString()

getPz2queryString

public String getPz2queryString()


Copyright © 2012. All Rights Reserved.