A B C D E F G H I L M N O P Q R S T U V W

A

addAll(Map<String, String>) - Method in class com.indexdata.mkjsf.config.Configuration
 
addAll(Map<String, String>, Map<String, String>) - Method in class com.indexdata.mkjsf.config.Configuration
 
addConfigurationError(ErrorInterface) - Method in class com.indexdata.mkjsf.errors.ErrorCentral
 
addElement(String, ResponseDataObject) - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
Used by the response XML parser to add child element objects to a parent element object
addExpression(Expression) - Method in class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
Adds an expression to the end of the list of current expressions (if any)
addExpression(String, Expression) - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
Adds an expression to an ordered list of expressions on a given parameter and notifies the state manager of the change
addFilter(String, String, String, String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Adds a filter expression with a label for display.
addLimit(String, String, String, String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Adds a limit expression with a label for display.
addQueryExpression(String, String, String, String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Adds an expression - for instance a facet criterion, with an optional label - to the query parameter
addStateListener(StateListener) - Method in class com.indexdata.mkjsf.pazpar2.state.StateManager
 
addTerm(TermResponse) - Method in class com.indexdata.mkjsf.pazpar2.data.TermListResponse
 
addTermList(TermListResponse) - Method in class com.indexdata.mkjsf.pazpar2.data.TermListsResponse
 
appendContent(String) - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
AUTH - Static variable in class com.indexdata.mkjsf.pazpar2.commands.sp.ServiceProxyCommands
 
AuthCommand - Class in com.indexdata.mkjsf.pazpar2.commands.sp
Represents a Service Proxy auth command, can be accessed by pzreq.sp.auth
AuthCommand() - Constructor for class com.indexdata.mkjsf.pazpar2.commands.sp.AuthCommand
 
authenticate() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Client
 
AuthResponse - Class in com.indexdata.mkjsf.pazpar2.data.sp
Data from the auth command, can be accessed by pzresp.sp.auth
AuthResponse() - Constructor for class com.indexdata.mkjsf.pazpar2.data.sp.AuthResponse
 

B

baseObjectName(Object) - Static method in class com.indexdata.mkjsf.utils.Utils
 
BYTARGET - Static variable in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
 
BytargetCommand - Class in com.indexdata.mkjsf.pazpar2.commands
Represents a Pazpar2 bytarget command, can be accessed by pzreq.bytarget
BytargetCommand() - Constructor for class com.indexdata.mkjsf.pazpar2.commands.BytargetCommand
 
BytargetCommandSp - Class in com.indexdata.mkjsf.pazpar2.commands.sp
 
BytargetCommandSp(BytargetCommand) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.sp.BytargetCommandSp
 
ByTargetResponse - Class in com.indexdata.mkjsf.pazpar2.data
Data from the bytarget command, can be accessed by pzresp.byTarget
ByTargetResponse() - Constructor for class com.indexdata.mkjsf.pazpar2.data.ByTargetResponse
 

C

CATEGORIES - Static variable in class com.indexdata.mkjsf.pazpar2.commands.sp.ServiceProxyCommands
 
CategoriesCommand - Class in com.indexdata.mkjsf.pazpar2.commands.sp
Represents a Service Proxy categories command, can be accessed by pzreq.sp.categories
CategoriesCommand() - Constructor for class com.indexdata.mkjsf.pazpar2.commands.sp.CategoriesCommand
 
CategoriesResponse - Class in com.indexdata.mkjsf.pazpar2.data.sp
Data from the categories command, can be accessed by pzresp.sp.categories
CategoriesResponse() - Constructor for class com.indexdata.mkjsf.pazpar2.data.sp.CategoriesResponse
 
characters(char[], int, int) - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseParser
 
checkIn(Pazpar2Command) - Method in class com.indexdata.mkjsf.pazpar2.state.StateManager
Registers a Pazpar2 command for execution.
checkInState(Pazpar2Command) - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
Notifies the state manager that this command changed a parameter
ClientCommandResponse - Class in com.indexdata.mkjsf.pazpar2
Contains one HTTP response to a command executed against a Pazpar2 service in such a way as to give the response parser a common interface to responses, whether they are from Pazpar2, from the Service Proxy, or are error messages created by the JSF application during processing.
ClientCommandResponse(Pazpar2HttpResponse, ByteArrayOutputStream) - Constructor for class com.indexdata.mkjsf.pazpar2.ClientCommandResponse
Used for storing Pazpar2 based response
ClientCommandResponse(int, String, String) - Constructor for class com.indexdata.mkjsf.pazpar2.ClientCommandResponse
Used for storing error response
ClientCommandResponse(int, byte[], String) - Constructor for class com.indexdata.mkjsf.pazpar2.ClientCommandResponse
Used for storing Service Proxy based response
cloneMe() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Client
 
cloneMe() - Method in interface com.indexdata.mkjsf.pazpar2.SearchClient
 
cloneMe() - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
 
com.indexdata.mkjsf.config - package com.indexdata.mkjsf.config
The library comes with two alternative mechanisms for configuration of an application, but it is possible to apply a custom scheme too or not use the configurations at all.
com.indexdata.mkjsf.controls - package com.indexdata.mkjsf.controls
UI controls - a configurable pager component for browsing through search results a page at a time
com.indexdata.mkjsf.errors - package com.indexdata.mkjsf.errors
Error reporting, error diagnostics, and exception classes
com.indexdata.mkjsf.pazpar2 - package com.indexdata.mkjsf.pazpar2
Overall control and execution of search logic.
com.indexdata.mkjsf.pazpar2.commands - package com.indexdata.mkjsf.pazpar2.commands
Each Pazpar2 command is represented by a class with methods for setting parameters and running the command against the selected Pazpar2 service.
com.indexdata.mkjsf.pazpar2.commands.sp - package com.indexdata.mkjsf.pazpar2.commands.sp
Each Service Proxy-only command and each Pazpar2 command with Service Proxy-only parameters is represented by a class with methods for setting parameters and ultimately running the command against the selected Service Proxy.
com.indexdata.mkjsf.pazpar2.data - package com.indexdata.mkjsf.pazpar2.data
Pazpar2 responses produced by Pazpar2 commands are parsed by the ResponseParser, which outputs response data objects that are accessible to the UI through the class Responses.
com.indexdata.mkjsf.pazpar2.data.sp - package com.indexdata.mkjsf.pazpar2.data.sp
Service Proxy responses produced by Service Proxy commands.
com.indexdata.mkjsf.pazpar2.state - package com.indexdata.mkjsf.pazpar2.state
Tracks the state of commands, parameter settings and command execution - primarily used for handling browser history navigation.
com.indexdata.mkjsf.utils - package com.indexdata.mkjsf.utils
Utility classes for file upload, string and list manipulation in UI, logging
CommandError - Class in com.indexdata.mkjsf.pazpar2.data
Holds an error encountered during the execution of a command.
CommandError() - Constructor for class com.indexdata.mkjsf.pazpar2.data.CommandError
 
CommandParameter - Class in com.indexdata.mkjsf.pazpar2.commands
Represents a Pazpar2 command parameter with a name, an operator, a simple value and/or one or more complex values (expressions).
CommandParameter(String) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
 
CommandParameter(String, String, String, Expression...) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
Instantiates a parameter with a simple value and one or more expressions
CommandParameter(String, String, Expression...) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
Instantiates a parameter with one or more expressions
CommandParameter(String, String, String) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
Instantiates a parameter with a simple value
CommandParameter(String, String, int) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
Instantiates a parameter with a numeric value
CommandThread - Class in com.indexdata.mkjsf.pazpar2
Helper class for running multiple concurrent Pazpar2 commands.
CommandThread(Pazpar2Command, SearchClient, Responses) - Constructor for class com.indexdata.mkjsf.pazpar2.CommandThread
 
concat(String...) - Static method in class com.indexdata.mkjsf.utils.UiUtils
Concatenates a list of strings
concatMaxLength(int, String...) - Static method in class com.indexdata.mkjsf.utils.UiUtils
 
Configurable - Interface in com.indexdata.mkjsf.config
Interface to be implemented by any part of an application that wish to use a ConfigurationReader for it's configuration.
Configuration - Class in com.indexdata.mkjsf.config
Represents a configuration as a set of key-value pairs
Configuration() - Constructor for class com.indexdata.mkjsf.config.Configuration
 
Configuration(Map<String, String>) - Constructor for class com.indexdata.mkjsf.config.Configuration
 
ConfigurationError - Class in com.indexdata.mkjsf.errors
 
ConfigurationError(String, String, String) - Constructor for class com.indexdata.mkjsf.errors.ConfigurationError
 
ConfigurationException - Exception in com.indexdata.mkjsf.errors
 
ConfigurationException() - Constructor for exception com.indexdata.mkjsf.errors.ConfigurationException
 
ConfigurationException(String) - Constructor for exception com.indexdata.mkjsf.errors.ConfigurationException
 
ConfigurationException(Throwable) - Constructor for exception com.indexdata.mkjsf.errors.ConfigurationException
 
ConfigurationException(String, Throwable) - Constructor for exception com.indexdata.mkjsf.errors.ConfigurationException
 
ConfigurationReader - Interface in com.indexdata.mkjsf.config
Interface to be implemented by classes that read configurations from a source - i.e.
configure(ConfigurationReader) - Method in interface com.indexdata.mkjsf.config.Configurable
Configures the Configurable using the configuration obtained by the provided configuration reader
configure(ConfigurationReader) - Method in class com.indexdata.mkjsf.pazpar2.Pz2Client
 
configure(ConfigurationReader) - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
configure(ConfigurationReader) - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
 
configureClient(SearchClient, ConfigurationReader) - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
Configures the selected search client using the selected configuration reader.
copy() - Method in class com.indexdata.mkjsf.pazpar2.commands.BytargetCommand
 
copy() - Method in class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
Clones the CommandParameter
copy() - Method in class com.indexdata.mkjsf.pazpar2.commands.Expression
Clones the expression
copy() - Method in class com.indexdata.mkjsf.pazpar2.commands.FilterParameter
 
copy() - Method in class com.indexdata.mkjsf.pazpar2.commands.InitCommand
 
copy() - Method in class com.indexdata.mkjsf.pazpar2.commands.LimitParameter
 
copy() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
Commands must implement this method to provide an completely detached, deep clone of themselves.
copy() - Method in class com.indexdata.mkjsf.pazpar2.commands.PingCommand
 
copy() - Method in class com.indexdata.mkjsf.pazpar2.commands.QueryParameter
 
copy() - Method in class com.indexdata.mkjsf.pazpar2.commands.RecordCommand
 
copy() - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
 
copy() - Method in class com.indexdata.mkjsf.pazpar2.commands.SettingsCommand
 
copy() - Method in class com.indexdata.mkjsf.pazpar2.commands.ShowCommand
 
copy() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.AuthCommand
 
copy() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.CategoriesCommand
 
copy() - Method in class com.indexdata.mkjsf.pazpar2.commands.StatCommand
 
copy() - Method in class com.indexdata.mkjsf.pazpar2.commands.TermlistCommand
 
createErrorXml(String, String, String, String, String) - Static method in class com.indexdata.mkjsf.pazpar2.data.CommandError
Creates an XML string error message, embedded in an XML string document named by the command This is the XML that ResponseParser will turn into a CommandError object.

D

dataObjects - Variable in class com.indexdata.mkjsf.pazpar2.data.Responses
 
DEFAULTS - Static variable in class com.indexdata.mkjsf.pazpar2.Pz2Client
 
docTypes - Static variable in class com.indexdata.mkjsf.pazpar2.data.ResponseParser
 
document() - Method in interface com.indexdata.mkjsf.config.ConfigurationReader
Returns documentation for the key-value pairs obtained by this reader
document() - Method in class com.indexdata.mkjsf.config.Mk2ConfigReader
 
document() - Method in class com.indexdata.mkjsf.config.WebXmlConfigReader
 
documentConfiguration() - Method in interface com.indexdata.mkjsf.config.Configurable
The components documentation of how it was configured.
documentConfiguration() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Client
Provides configuration documentation -- mostly for diagnosing problems
documentConfiguration() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
documentConfiguration() - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
 
download(String) - Method in class com.indexdata.mkjsf.pazpar2.data.Responses
 
downloadDoc() - Method in class com.indexdata.mkjsf.utils.FileUpload
 
downloadInitDoc() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.InitCommandSp
 

E

endElement(String, String, String) - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseParser
 
equals(Object) - Method in class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
 
equals(Object) - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
 
ErrorCentral - Class in com.indexdata.mkjsf.errors
 
ErrorCentral() - Constructor for class com.indexdata.mkjsf.errors.ErrorCentral
 
ErrorHelper - Class in com.indexdata.mkjsf.errors
 
ErrorHelper(ConfigurationReader) - Constructor for class com.indexdata.mkjsf.errors.ErrorHelper
 
errorHelper - Variable in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
ErrorHelper.ErrorCode - Enum in com.indexdata.mkjsf.errors
 
ErrorInterface - Interface in com.indexdata.mkjsf.errors
 
executeCommand(Pazpar2Command) - Method in class com.indexdata.mkjsf.pazpar2.Pz2Client
Runs the give Pazpar2 command and returns a response wrapper with either the received response or with some form of error message.
executeCommand(Pazpar2Command) - Method in interface com.indexdata.mkjsf.pazpar2.SearchClient
 
executeCommand(Pazpar2Command) - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
 
Expression - Class in com.indexdata.mkjsf.pazpar2.commands
Represents a complex command parameter value, in form of an expression with an equality operator
Expression(String, String, String, String) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.Expression
Instantiates an expression with a label
Expression(String) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.Expression
Instantiates an expression by parsing the provided expression string, which must be on the form {name}({=}or{~}){value}.

F

FileUpload - Class in com.indexdata.mkjsf.utils
Helper class for file uploads.
FileUpload() - Constructor for class com.indexdata.mkjsf.utils.FileUpload
 
FilterParameter - Class in com.indexdata.mkjsf.pazpar2.commands
Represents a filter parameter as it applies to the Pazpar2 search command
FilterParameter(String) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.FilterParameter
 
FilterParameter(Expression...) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.FilterParameter
 
frequency - Variable in class com.indexdata.mkjsf.pazpar2.data.TermResponse
 

G

get(String) - Method in class com.indexdata.mkjsf.config.Configuration
 
get(String, String) - Method in class com.indexdata.mkjsf.config.Configuration
 
get() - Static method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
getAcefilter() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.RecordCommandSp
Gets parameter value for acefilter
getAction() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.AuthCommand
Gets parameter value for action
getActiveClients() - Method in class com.indexdata.mkjsf.pazpar2.data.RecordResponse
 
getActiveClients() - Method in class com.indexdata.mkjsf.pazpar2.data.Responses
 
getActiveClients() - Method in class com.indexdata.mkjsf.pazpar2.data.ShowResponse
 
getActiveClients() - Method in class com.indexdata.mkjsf.pazpar2.data.StatResponse
 
getActiveClients() - Method in class com.indexdata.mkjsf.pazpar2.data.TermListsResponse
 
getApplicationError() - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
getApplicationErrorCode() - Method in class com.indexdata.mkjsf.errors.ConfigurationError
 
getApplicationErrorCode() - Method in interface com.indexdata.mkjsf.errors.ErrorInterface
 
getApplicationErrorCode() - Method in class com.indexdata.mkjsf.pazpar2.data.CommandError
 
getApproximation() - Method in class com.indexdata.mkjsf.pazpar2.data.TermXTargetResponse
 
getAttribute(String) - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
getAuth() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.ServiceProxyCommands
auth command - referenced from UI as pzreq.sp.auth
getAuth() - Method in class com.indexdata.mkjsf.pazpar2.data.sp.SpResponses
 
getAuthenticationRequired() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
getAuthenticationType() - Method in class com.indexdata.mkjsf.pazpar2.data.sp.AuthResponse
 
getAuthor(String) - Method in class com.indexdata.mkjsf.pazpar2.data.Hit
 
getAuthor() - Method in class com.indexdata.mkjsf.pazpar2.data.Hit
 
getAuthor() - Method in class com.indexdata.mkjsf.pazpar2.data.Location
 
getAuthor() - Method in class com.indexdata.mkjsf.pazpar2.data.RecordResponse
 
getAuthors() - Method in class com.indexdata.mkjsf.pazpar2.data.Location
 
getBinary() - Method in class com.indexdata.mkjsf.pazpar2.commands.RecordCommand
Returns the binary parameter value.
getBinary() - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
getBlock() - Method in class com.indexdata.mkjsf.pazpar2.commands.ShowCommand
Get the parameter value for block
getBytarget() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
 
getByTarget() - Method in class com.indexdata.mkjsf.pazpar2.data.Responses
 
getBytes() - Method in class com.indexdata.mkjsf.pazpar2.ClientCommandResponse
 
getBytes() - Method in interface com.indexdata.mkjsf.pazpar2.HttpResponseWrapper
 
getCategories() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.ServiceProxyCommands
categories command - referenced from UI as pzreq.sp.categories
getCategories() - Method in class com.indexdata.mkjsf.pazpar2.data.sp.SpResponses
 
getCategoryId() - Method in class com.indexdata.mkjsf.pazpar2.data.sp.TargetCategory
 
getCategoryName() - Method in class com.indexdata.mkjsf.pazpar2.data.sp.TargetCategory
 
getCheckHistory() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
getChecksum() - Method in class com.indexdata.mkjsf.pazpar2.commands.RecordCommand
Returns the checksum parameter value.
getChecksum() - Method in class com.indexdata.mkjsf.pazpar2.data.Location
 
getClear() - Method in class com.indexdata.mkjsf.pazpar2.commands.InitCommand
Returns the clear parameter value.
getClients() - Method in class com.indexdata.mkjsf.pazpar2.data.StatResponse
 
getCode() - Method in class com.indexdata.mkjsf.pazpar2.data.ServiceError
 
getCommand(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
Generically retrieves any command
getCommand() - Method in class com.indexdata.mkjsf.pazpar2.CommandThread
 
getCommand(String) - Method in class com.indexdata.mkjsf.pazpar2.state.Pazpar2State
Returns a command from this state
getCommand(String) - Method in class com.indexdata.mkjsf.pazpar2.state.StateManager
 
getCommandError() - Method in class com.indexdata.mkjsf.errors.ErrorCentral
 
getCommandError() - Method in class com.indexdata.mkjsf.pazpar2.data.Responses
Returns a search command error, if any, otherwise the first error found for an arbitrary command, if any, otherwise an empty dummy error.
getCommandName() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
 
getCommandResponse() - Method in class com.indexdata.mkjsf.pazpar2.CommandThread
 
getConfigFilePath() - Method in class com.indexdata.mkjsf.config.Configuration
 
getConfigMap() - Method in class com.indexdata.mkjsf.config.Configuration
 
getConfiguration(Configurable) - Method in interface com.indexdata.mkjsf.config.ConfigurationReader
Returns a Configuration to be used by the given Configurable
getConfiguration(Configurable) - Method in class com.indexdata.mkjsf.config.Mk2ConfigReader
 
getConfiguration(Configurable) - Method in class com.indexdata.mkjsf.config.WebXmlConfigReader
 
getConfiguration() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Client
 
getConfiguration() - Method in interface com.indexdata.mkjsf.pazpar2.SearchClient
 
getConfiguration() - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
 
getConfigurationErrors() - Method in class com.indexdata.mkjsf.errors.ErrorCentral
 
getConnecting() - Method in class com.indexdata.mkjsf.pazpar2.data.StatResponse
 
getContentType() - Method in class com.indexdata.mkjsf.pazpar2.ClientCommandResponse
 
getContentType() - Method in interface com.indexdata.mkjsf.pazpar2.HttpResponseWrapper
 
getContentType() - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient.ProxyPz2ResponseHandler
 
getCurrentPage() - Method in class com.indexdata.mkjsf.controls.ResultsPager
 
getCurrentPageNum() - Method in class com.indexdata.mkjsf.controls.ResultsPager
 
getCurrentState() - Method in class com.indexdata.mkjsf.pazpar2.state.StateManager
 
getCurrentStateKey() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
Returns the current hash key, used for internal session state tracking and potentially for browser history entries A UI author would not normally be concerned with retrieving this.
getDataObject(ClientCommandResponse) - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseParser
Parses a Pazpar2 XML response -- or an error response as XML -- and produces a ResponseDataObject object, i.e.
getDate() - Method in class com.indexdata.mkjsf.pazpar2.data.Hit
 
getDate() - Method in class com.indexdata.mkjsf.pazpar2.data.RecordResponse
 
getDefaults() - Method in interface com.indexdata.mkjsf.config.Configurable
Returns the default parameters that the configurable has defined for itself Should be invoked by the configuration reader before it possibly overrides some parameters obtained from the external configuration source
getDefaults() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Client
Returns default configuration parameters for the client.
getDefaults() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
getDefaults() - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
Returns default configuration parameters for the client.
getDescription() - Method in class com.indexdata.mkjsf.pazpar2.data.Hit
 
getDiagnostic() - Method in class com.indexdata.mkjsf.pazpar2.data.Target
 
getDiagnostic() - Method in class com.indexdata.mkjsf.pazpar2.data.TermXTargetResponse
 
getDisplayName() - Method in class com.indexdata.mkjsf.pazpar2.data.sp.AuthResponse
 
getElements(String) - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
getEncodedQueryString() - Method in class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
Returns a URL encoded string of this parameter with name, operator, simple value and/or expressions
getEncodedQueryString() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
 
getError() - Method in class com.indexdata.mkjsf.pazpar2.data.StatResponse
 
getErrorCode(ErrorInterface) - Method in class com.indexdata.mkjsf.errors.ErrorHelper
 
getErrors() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
getEsn() - Method in class com.indexdata.mkjsf.pazpar2.commands.RecordCommand
Returns the esn parameter value.
getException() - Method in class com.indexdata.mkjsf.errors.ConfigurationError
 
getException() - Method in interface com.indexdata.mkjsf.errors.ErrorInterface
 
getException() - Method in class com.indexdata.mkjsf.pazpar2.data.CommandError
 
getExpressions() - Method in class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
Returns a list of all current expressions
getExpressions(String...) - Method in class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
Returns expressions selected by their left-hand keys - as in 'expressionField=value'.
getExtendedQuery() - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Returns the complete query parameter value, including expressions.
getFacetTerms(String, int) - Method in class com.indexdata.mkjsf.pazpar2.data.Responses
 
getFacetTerms(String) - Method in class com.indexdata.mkjsf.pazpar2.data.Responses
 
getFailed() - Method in class com.indexdata.mkjsf.pazpar2.data.StatResponse
 
getField() - Method in class com.indexdata.mkjsf.pazpar2.commands.Expression
Returns the left-of-operator field (or name or key).
getFilter() - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Returns the filter parameter value.
getFiltered() - Method in class com.indexdata.mkjsf.pazpar2.data.TermXTargetResponse
 
getFilterExpressions() - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Returns list of all filter expressions
getFilterExpressions(String...) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
 
getFirstDisplayedPageNum() - Method in class com.indexdata.mkjsf.controls.ResultsPager
 
getFirstLocation() - Method in class com.indexdata.mkjsf.pazpar2.data.RecordResponse
 
getFrequency() - Method in class com.indexdata.mkjsf.pazpar2.data.TermResponse
 
getHasResults() - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
getHelper() - Method in class com.indexdata.mkjsf.errors.ErrorCentral
 
getHits() - Method in class com.indexdata.mkjsf.pazpar2.data.ShowResponse
 
getHits() - Method in class com.indexdata.mkjsf.pazpar2.data.StatResponse
 
getHits() - Method in class com.indexdata.mkjsf.pazpar2.data.Target
 
getId() - Method in class com.indexdata.mkjsf.pazpar2.commands.RecordCommand
Returns the id parameter value.
getId() - Method in class com.indexdata.mkjsf.pazpar2.data.Location
 
getId() - Method in class com.indexdata.mkjsf.pazpar2.data.Target
 
getId() - Method in class com.indexdata.mkjsf.pazpar2.data.TermXTargetResponse
 
getIdle() - Method in class com.indexdata.mkjsf.pazpar2.data.StatResponse
 
getIncludeDebug() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.InitCommandSp
 
getInit() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
init command - referenced from UI as pzreq.init
getInit() - Method in class com.indexdata.mkjsf.pazpar2.data.Responses
 
getInitDocPaths() - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
 
getIntValue(String) - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
getIsBinary() - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
getKey() - Method in class com.indexdata.mkjsf.pazpar2.state.Pazpar2State
Generates a state key that can be used by the browser to pick up this state again at a later point in time.
getLabel() - Method in class com.indexdata.mkjsf.errors.ConfigurationError
 
getLabel() - Method in interface com.indexdata.mkjsf.errors.ErrorInterface
 
getLabel() - Method in class com.indexdata.mkjsf.pazpar2.commands.Expression
Returns the label describing the value of the expression or, if no label was provided, the value itself.
getLabel() - Method in class com.indexdata.mkjsf.pazpar2.data.CommandError
 
getLastDisplayedPageNum() - Method in class com.indexdata.mkjsf.controls.ResultsPager
 
getLastPageNum() - Method in class com.indexdata.mkjsf.controls.ResultsPager
 
getLimit() - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Returns the limit parameter value.
getLimitExpressions() - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Return a list of all current limit expressions
getLimitExpressions(String...) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Returns a list of limit expressions with fields that matches on of expressionFields
getLocations() - Method in class com.indexdata.mkjsf.pazpar2.data.Hit
 
getLocations() - Method in class com.indexdata.mkjsf.pazpar2.data.RecordResponse
 
getMandatory(String) - Method in class com.indexdata.mkjsf.config.Configuration
 
getMaxElements(ResponseDataObject, String, int, int, boolean) - Method in class com.indexdata.mkjsf.utils.UiUtils
Gets at most maxElements data objects, up to a total string length of maxTotalValueLength
getMaxNumElements(ResponseDataObject, String, int) - Static method in class com.indexdata.mkjsf.utils.UiUtils
Gets at most maxElements elements of the given elementName
getMaxrecs() - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Returns the maxrecs parameter value.
getMerged() - Method in class com.indexdata.mkjsf.pazpar2.data.ShowResponse
 
getMergekey() - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Returns the mergekey parameter value.
getMergekey() - Method in class com.indexdata.mkjsf.pazpar2.commands.ShowCommand
Get the parameter value for mergekey
getMessage() - Method in class com.indexdata.mkjsf.errors.ConfigurationError
 
getMessage() - Method in interface com.indexdata.mkjsf.errors.ErrorInterface
 
getMessage() - Method in class com.indexdata.mkjsf.pazpar2.data.CommandError
 
getModuleName() - Method in interface com.indexdata.mkjsf.config.Configurable
Returns the name of the module, can be used by a configuration reader that distinguishes between sets of configuration properties by component name, a name space of sorts.
getModuleName() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Client
Returns the configuration name of the client
getModuleName() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
getModuleName() - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
Returns the configuration name of the client
getMsg() - Method in class com.indexdata.mkjsf.pazpar2.data.ServiceError
 
getMultiProperty(String, String) - Method in class com.indexdata.mkjsf.config.Configuration
 
getName() - Method in class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
Returns the name (left of operator) of this parameter
getName() - Method in class com.indexdata.mkjsf.pazpar2.commands.TermlistCommand
Gets parameter value for name
getName() - Method in class com.indexdata.mkjsf.pazpar2.data.Location
 
getName() - Method in class com.indexdata.mkjsf.pazpar2.data.Target
 
getName() - Method in class com.indexdata.mkjsf.pazpar2.data.TermListResponse
 
getName() - Method in class com.indexdata.mkjsf.pazpar2.data.TermResponse
 
getNativesyntax() - Method in class com.indexdata.mkjsf.pazpar2.commands.RecordCommand
Returns the nativesyntax parameter value.
getNextPageLink(String) - Method in class com.indexdata.mkjsf.controls.ResultsPager
 
getNum() - Method in class com.indexdata.mkjsf.pazpar2.commands.ShowCommand
Get the parameter value for num
getNum() - Method in class com.indexdata.mkjsf.pazpar2.commands.TermlistCommand
Gets parameter value for num
getNum() - Method in class com.indexdata.mkjsf.pazpar2.data.ShowResponse
 
getOffset() - Method in class com.indexdata.mkjsf.pazpar2.commands.RecordCommand
Returns the offset parameter value.
getOneElement(String) - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
getOneFilterExpression(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Returns the first filter expression of the given type
getOneLimitExpression(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Returns the first limit expression of the given type
getOneValue(String) - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
Returns the text content of the first element found with the given name
getOperator() - Method in class com.indexdata.mkjsf.pazpar2.commands.Expression
Returns the operator
getPage() - Method in class com.indexdata.mkjsf.controls.PageLink
 
getPageLinks() - Method in class com.indexdata.mkjsf.controls.ResultsPager
 
getPager() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
Returns a component for drawing a pager to navigate by.
getPageSize() - Method in class com.indexdata.mkjsf.controls.ResultsPager
 
getPageSize() - Method in class com.indexdata.mkjsf.pazpar2.commands.ShowCommand
Retrieves the currently defined number of items to show at a time
getParameter(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
Retrieves a command parameter by parameter name
getParameterValue(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
 
getParser() - Static method in class com.indexdata.mkjsf.pazpar2.data.ResponseParser
 
getPassword() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.AuthCommand
Gets parameter value for password
getPazpar2Url() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
Returns the Pazpar2 URL currently defined for servicing requests
getPazpar2Urls() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
getPing() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
ping command - referenced from UI as pzreq.ping
getPreviousPageLink(String) - Method in class com.indexdata.mkjsf.controls.ResultsPager
 
getProgress() - Method in class com.indexdata.mkjsf.pazpar2.data.StatResponse
 
getProperty(String) - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
getPzreq() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
getPzresp() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
getQuery() - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Returns the simple part of the query parameter value, excluding parts that were added as expressions (that is, not set with setQuery()).
getRank() - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Returns the rank parameter value.
getRank() - Method in class com.indexdata.mkjsf.pazpar2.commands.ShowCommand
Get the parameter value for rank
getRealm() - Method in class com.indexdata.mkjsf.pazpar2.data.sp.AuthResponse
 
getReasonPhrase() - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
 
getReasonPhrase() - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient.ProxyPz2ResponseHandler
 
getRecId() - Method in class com.indexdata.mkjsf.pazpar2.data.Hit
 
getRecId() - Method in class com.indexdata.mkjsf.pazpar2.data.RecordResponse
 
getRecord() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
 
getRecord() - Method in class com.indexdata.mkjsf.pazpar2.data.Responses
 
getRecordquery() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.RecordCommandSp
Gets parameter value for recordquery
getRecords() - Method in class com.indexdata.mkjsf.pazpar2.data.StatResponse
 
getRecords() - Method in class com.indexdata.mkjsf.pazpar2.data.Target
 
getRecords() - Method in class com.indexdata.mkjsf.pazpar2.data.TermXTargetResponse
 
getResponseObject(String) - Method in class com.indexdata.mkjsf.pazpar2.data.Responses
 
getResponseString() - Method in class com.indexdata.mkjsf.pazpar2.ClientCommandResponse
Gets the response as a String - unless the response is marked as binary
getResponseString() - Method in interface com.indexdata.mkjsf.pazpar2.HttpResponseWrapper
 
getResponseToParse() - Method in class com.indexdata.mkjsf.pazpar2.ClientCommandResponse
Used by the parser to get the response for further processing.
getSearch() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
 
getSearch() - Method in class com.indexdata.mkjsf.pazpar2.data.Responses
 
getSearchClient() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
getSequenceNumber() - Method in class com.indexdata.mkjsf.pazpar2.data.Location
 
getService() - Method in class com.indexdata.mkjsf.pazpar2.commands.InitCommand
Returns the service parameter value.
getServiceError() - Method in class com.indexdata.mkjsf.errors.ConfigurationError
 
getServiceError() - Method in interface com.indexdata.mkjsf.errors.ErrorInterface
 
getServiceError() - Method in class com.indexdata.mkjsf.pazpar2.data.CommandError
 
getServiceError() - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
getServiceId() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Client
Returns the Pazpar2 Service ID
getServiceId() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
getServiceProxyUrl() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
Returns the Service Proxy URL currently defined for servicing requests
getServiceProxyUrls() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
getServiceType() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
getServiceUrl() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Client
Returns the currently configured Papzar2 URL.
getServiceUrl() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
Gets the currently selected URL used for executing requests.
getServiceUrl() - Method in interface com.indexdata.mkjsf.pazpar2.SearchClient
 
getServiceUrl() - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
 
getServiceUrlIsDefined() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
getSession() - Method in class com.indexdata.mkjsf.pazpar2.commands.InitCommand
Disabled, not supported for init
getSession() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
 
getSettings() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
settings command - referenced from UI as pzreq.settings
getShow() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
 
getShow() - Method in class com.indexdata.mkjsf.pazpar2.data.Responses
 
getSimpleValue() - Method in class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
Returns the simple parameter value or null if no simple value was set for this parameter
getSort() - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Returns the sort parameter value.
getSort() - Method in class com.indexdata.mkjsf.pazpar2.commands.ShowCommand
Gets parameter value for sort
getSp() - Method in class com.indexdata.mkjsf.pazpar2.commands.BytargetCommand
 
getSp() - Method in class com.indexdata.mkjsf.pazpar2.commands.InitCommand
 
getSp() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
Implementing classes must provide their Service Proxy extension command if any extension parameters exists, or -- just to be polite -- 'this' if there is no Service Proxy extension to the given command.
getSp() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
Gets the object holding references to Service Proxy-only commands.
getSp() - Method in class com.indexdata.mkjsf.pazpar2.commands.PingCommand
 
getSp() - Method in class com.indexdata.mkjsf.pazpar2.commands.RecordCommand
Returns a record command object with Service Proxy extension parameters
getSp() - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
 
getSp() - Method in class com.indexdata.mkjsf.pazpar2.commands.SettingsCommand
 
getSp() - Method in class com.indexdata.mkjsf.pazpar2.commands.ShowCommand
 
getSp() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.AuthCommand
 
getSp() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.CategoriesCommand
 
getSp() - Method in class com.indexdata.mkjsf.pazpar2.commands.StatCommand
 
getSp() - Method in class com.indexdata.mkjsf.pazpar2.commands.TermlistCommand
 
getSp() - Method in class com.indexdata.mkjsf.pazpar2.data.Responses
 
getSpClient() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
getStart() - Method in class com.indexdata.mkjsf.controls.PageLink
 
getStart() - Method in class com.indexdata.mkjsf.pazpar2.commands.ShowCommand
Retrieves the sequence number of the record that pazpaz2 will return as the first record in 'show'
getStart() - Method in class com.indexdata.mkjsf.pazpar2.data.ShowResponse
 
getStartrecs() - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Returns the startrecs parameter value.
getStat() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
 
getStat() - Method in class com.indexdata.mkjsf.pazpar2.data.Responses
 
getState() - Method in class com.indexdata.mkjsf.pazpar2.data.Target
 
getState() - Method in class com.indexdata.mkjsf.pazpar2.data.TermXTargetResponse
 
getStateMgr() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
getStatus() - Method in class com.indexdata.mkjsf.pazpar2.data.InitResponse
 
getStatus() - Method in class com.indexdata.mkjsf.pazpar2.data.SearchResponse
 
getStatus() - Method in class com.indexdata.mkjsf.pazpar2.data.ShowResponse
 
getStatus() - Method in class com.indexdata.mkjsf.pazpar2.data.sp.AuthResponse
 
getStatusCode() - Method in class com.indexdata.mkjsf.pazpar2.ClientCommandResponse
 
getStatusCode() - Method in interface com.indexdata.mkjsf.pazpar2.HttpResponseWrapper
 
getStatusCode() - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
 
getStatusCode() - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient.ProxyPz2ResponseHandler
 
getSubject() - Method in class com.indexdata.mkjsf.pazpar2.data.Location
 
getSubject() - Method in class com.indexdata.mkjsf.pazpar2.data.RecordResponse
 
getSubjects() - Method in class com.indexdata.mkjsf.pazpar2.data.Location
 
getSubjects() - Method in class com.indexdata.mkjsf.pazpar2.data.RecordResponse
 
getSuggestions() - Method in class com.indexdata.mkjsf.errors.ConfigurationError
 
getSuggestions(ErrorInterface) - Method in class com.indexdata.mkjsf.errors.ErrorHelper
 
getSuggestions() - Method in interface com.indexdata.mkjsf.errors.ErrorInterface
 
getSuggestions() - Method in class com.indexdata.mkjsf.pazpar2.data.CommandError
 
getSyntax() - Method in class com.indexdata.mkjsf.pazpar2.commands.RecordCommand
Returns the syntax parameter value.
getTargetCategories() - Method in class com.indexdata.mkjsf.pazpar2.data.sp.CategoriesResponse
 
getTargets() - Method in class com.indexdata.mkjsf.pazpar2.data.ByTargetResponse
 
getTermlist() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
 
getTermList(String) - Method in class com.indexdata.mkjsf.pazpar2.data.TermListsResponse
 
getTermLists() - Method in class com.indexdata.mkjsf.pazpar2.data.Responses
 
getTerms() - Method in class com.indexdata.mkjsf.pazpar2.data.TermListResponse
 
getTerms(int) - Method in class com.indexdata.mkjsf.pazpar2.data.TermListResponse
 
getText() - Method in class com.indexdata.mkjsf.controls.PageLink
 
getTitle() - Method in class com.indexdata.mkjsf.pazpar2.data.Hit
 
getTitle() - Method in class com.indexdata.mkjsf.pazpar2.data.RecordResponse
 
getTitleComplete() - Method in class com.indexdata.mkjsf.pazpar2.data.Hit
 
getTitleRemainder() - Method in class com.indexdata.mkjsf.pazpar2.data.Hit
 
getTitleResponsibility() - Method in class com.indexdata.mkjsf.pazpar2.data.Hit
 
getTotal() - Method in class com.indexdata.mkjsf.pazpar2.data.ShowResponse
 
getType() - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
getUnconnected() - Method in class com.indexdata.mkjsf.pazpar2.data.StatResponse
 
getUploadedFile() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.InitDocUpload
 
getUploadedFile() - Method in class com.indexdata.mkjsf.utils.FileUpload
 
getUploadedInitDoc() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.InitCommandSp
 
getUsername() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.AuthCommand
Gets parameter value for username
getValue() - Method in class com.indexdata.mkjsf.pazpar2.commands.Expression
Returns the right-of-operator value of the expression
getValue() - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
getValueArray(String) - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
Returns string array with the values of the named element(s)
getValueWithExpressions() - Method in class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
Returns the simple parameter value and/or any expressions, separated by 'AND'
getValueWithExpressions() - Method in class com.indexdata.mkjsf.pazpar2.commands.FilterParameter
 
getValueWithExpressions() - Method in class com.indexdata.mkjsf.pazpar2.commands.LimitParameter
 
getValueWithExpressions() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
 
getValueWithExpressions() - Method in class com.indexdata.mkjsf.pazpar2.commands.QueryParameter
 
getWatchActiveclients() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
getWatchActiveclientsRecord() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
getWindowid() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.BytargetCommandSp
Returns the windowid parameter value.
getWindowid() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.InitCommandSp
Returns the windowid parameter value.
getWindowid() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.RecordCommandSp
Returns the windowid parameter value.
getWindowid() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.SearchCommandSp
Returns the windowid parameter value.
getWindowid() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.ShowCommandSp
Returns the windowid parameter value.
getWindowid() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.StatCommandSp
Returns the windowid parameter value.
getWindowid() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.TermlistCommandSp
Returns the windowid parameter value.
getWorking() - Method in class com.indexdata.mkjsf.pazpar2.data.StatResponse
 
getXml() - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
goToNextPage() - Method in class com.indexdata.mkjsf.controls.ResultsPager
 
goToPage(int) - Method in class com.indexdata.mkjsf.controls.ResultsPager
 
goToPreviousPage() - Method in class com.indexdata.mkjsf.controls.ResultsPager
 

H

handleQueryStateChanges(String) - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
This methods main purpose is to support browser history.
handleResponse(HttpResponse) - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient.ProxyPz2ResponseHandler
 
hasApplicationError() - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
hasApplicationError() - Method in class com.indexdata.mkjsf.pazpar2.data.Responses
 
hasCommandErrors() - Method in class com.indexdata.mkjsf.errors.ErrorCentral
 
hasConfigurationErrors() - Method in class com.indexdata.mkjsf.errors.ErrorCentral
 
hasErrors() - Method in class com.indexdata.mkjsf.errors.ErrorCentral
Returns true if application error found in any response data objects
hasExpressions() - Method in class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
Returns true if this parameter has expressions (complex values)
hasExpressions(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
Returns true if this parameter has expressions of the given type, that is, expressions where the left-of-operator key equals 'expressionField'
hasFilter() - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
 
hasFilterExpression(String...) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Checks if there are any filter expressions matching any of the given expressionFields
hashCode() - Method in class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
 
hashCode() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
 
hasLimitExpression(String...) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Checks if there are any limit expressions matching any of the given expressionFields
hasNextPage() - Method in class com.indexdata.mkjsf.controls.ResultsPager
 
hasOperator() - Method in class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
 
hasPageAfterLastDisplayed() - Method in class com.indexdata.mkjsf.controls.ResultsPager
 
hasParameters() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
 
hasParameterValue(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
 
hasPendingStateChange(String, boolean) - Method in class com.indexdata.mkjsf.pazpar2.state.StateManager
Sets a pending-state-change flag for the given command and notifies registered listeners.
hasPendingStateChange(String) - Method in class com.indexdata.mkjsf.pazpar2.state.StateManager
 
hasPreviousPage() - Method in class com.indexdata.mkjsf.controls.ResultsPager
 
hasQuery() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
hasRecord(String) - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
Resolves whether the back-end has a record with the given recid in memory
hasRecords() - Method in class com.indexdata.mkjsf.pazpar2.data.Responses
 
hasServiceError() - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
hasServiceUrl() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Client
Returns true if a Papzar2 URL was defined yet.
hasServiceUrl() - Method in interface com.indexdata.mkjsf.pazpar2.SearchClient
 
hasServiceUrl() - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
Returns true if a Service Proxy URL was defined yet.
hasUploadedFile() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.InitDocUpload
 
hasValue() - Method in class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
Returns true if this parameter has a simple value
Hit - Class in com.indexdata.mkjsf.pazpar2.data
Data from the show command, child object of ShowResponse, can be accessed by pzresp.show.hits
Hit() - Constructor for class com.indexdata.mkjsf.pazpar2.data.Hit
 
HttpResponseWrapper - Interface in com.indexdata.mkjsf.pazpar2
 

I

INIT - Static variable in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
 
InitCommand - Class in com.indexdata.mkjsf.pazpar2.commands
Represents a Pazpar2 init command, can be accessed by pzreq.init
InitCommand() - Constructor for class com.indexdata.mkjsf.pazpar2.commands.InitCommand
 
InitCommandSp - Class in com.indexdata.mkjsf.pazpar2.commands.sp
Service Proxy extensions to the Pazpar2 init command - specifically support for POSTing to the Service Proxy an init doc containing Pazpar2 definitions and settings.
InitCommandSp(InitCommand) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.sp.InitCommandSp
 
InitDocUpload - Class in com.indexdata.mkjsf.pazpar2.commands.sp
Helper class for file upload of an Service Proxy init doc.
InitDocUpload() - Constructor for class com.indexdata.mkjsf.pazpar2.commands.sp.InitDocUpload
 
InitResponse - Class in com.indexdata.mkjsf.pazpar2.data
Data from the init command, can be accessed by pzresp.init
InitResponse() - Constructor for class com.indexdata.mkjsf.pazpar2.data.InitResponse
 
insertErrorXml(String, String, String, String) - Static method in class com.indexdata.mkjsf.pazpar2.data.CommandError
Embeds a Pazpar2 (or Pazpar2 client) error response document as a child element of a command response document (like 'search' or 'show').
isAuthenticated() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Client
 
isAuthenticatingClient() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Client
 
isAuthenticatingClient() - Method in interface com.indexdata.mkjsf.pazpar2.SearchClient
 
isAuthenticatingClient() - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
 
isAuthenticationOk() - Method in class com.indexdata.mkjsf.pazpar2.data.sp.AuthResponse
 
isBinary() - Method in class com.indexdata.mkjsf.pazpar2.ClientCommandResponse
 
isBinary() - Method in interface com.indexdata.mkjsf.pazpar2.HttpResponseWrapper
 
isCurrent() - Method in class com.indexdata.mkjsf.controls.PageLink
 
isLink() - Method in class com.indexdata.mkjsf.controls.PageLink
 
isNew() - Method in class com.indexdata.mkjsf.pazpar2.data.SearchResponse
 
isPazpar2Error() - Method in class com.indexdata.mkjsf.pazpar2.data.CommandError
 
isPazpar2Error() - Method in class com.indexdata.mkjsf.pazpar2.data.ServiceError
 
isPazpar2Service() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
isServiceError() - Method in class com.indexdata.mkjsf.errors.ConfigurationError
 
isServiceError() - Method in interface com.indexdata.mkjsf.errors.ErrorInterface
 
isServiceError() - Method in class com.indexdata.mkjsf.pazpar2.data.CommandError
 
isServiceProxyError() - Method in class com.indexdata.mkjsf.pazpar2.data.CommandError
 
isServiceProxyError() - Method in class com.indexdata.mkjsf.pazpar2.data.ServiceError
 
isServiceProxyService() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 

L

LimitParameter - Class in com.indexdata.mkjsf.pazpar2.commands
Represents a limit parameter as it applies to the Pazpar2 search command
LimitParameter(String) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.LimitParameter
 
LimitParameter(Expression...) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.LimitParameter
 
Location - Class in com.indexdata.mkjsf.pazpar2.data
Data from the show command, child object of Hit
Location() - Constructor for class com.indexdata.mkjsf.pazpar2.data.Location
 

M

maxLength(String, int) - Static method in class com.indexdata.mkjsf.utils.UiUtils
 
maxLengthMoreLabel(String, int, String) - Static method in class com.indexdata.mkjsf.utils.UiUtils
 
MissingConfigurationContextException - Exception in com.indexdata.mkjsf.errors
 
MissingConfigurationContextException() - Constructor for exception com.indexdata.mkjsf.errors.MissingConfigurationContextException
 
MissingConfigurationContextException(String) - Constructor for exception com.indexdata.mkjsf.errors.MissingConfigurationContextException
 
MissingConfigurationContextException(Throwable) - Constructor for exception com.indexdata.mkjsf.errors.MissingConfigurationContextException
 
MissingConfigurationContextException(String, Throwable) - Constructor for exception com.indexdata.mkjsf.errors.MissingConfigurationContextException
 
Mk2ConfigReader - Class in com.indexdata.mkjsf.config
Reads configuration from a MasterKey configuration scheme
Mk2ConfigReader() - Constructor for class com.indexdata.mkjsf.config.Mk2ConfigReader
 
MODULENAME - Static variable in class com.indexdata.mkjsf.pazpar2.Pz2Client
 
MODULENAME - Static variable in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
 

N

name - Variable in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
 
nl - Static variable in class com.indexdata.mkjsf.utils.Utils
 

O

objectId(Object) - Static method in class com.indexdata.mkjsf.utils.Utils
 
onSuccess(String) - Method in class com.indexdata.mkjsf.pazpar2.data.sp.AuthResponse
 

P

PageLink - Class in com.indexdata.mkjsf.controls
 
PageLink(String, int, ResultsPager) - Constructor for class com.indexdata.mkjsf.controls.PageLink
 
pager - Variable in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
parameters - Variable in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
 
PAZPAR2_URL_LIST - Static variable in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
Pazpar2Command - Class in com.indexdata.mkjsf.pazpar2.commands
Represents a generic Pazpar2 or Service Proxy command with all its current parameters, and has methods for executing the command against the currently selected Pazpar2 service
Pazpar2Command() - Constructor for class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
 
Pazpar2Command(String) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
 
Pazpar2Commands - Class in com.indexdata.mkjsf.pazpar2.commands
Pazpar2Commands holds references to all Pazpar2 commands.
Pazpar2Commands() - Constructor for class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
 
Pazpar2State - Class in com.indexdata.mkjsf.pazpar2.state
Holds a 'pazpar2 state', understood as a full set of pazpar2 commands and all their parameter settings at a given point in time.
Pazpar2State() - Constructor for class com.indexdata.mkjsf.pazpar2.state.Pazpar2State
 
Pazpar2State(Pazpar2State, Pazpar2Command) - Constructor for class com.indexdata.mkjsf.pazpar2.state.Pazpar2State
Creates new state by cloning all commands of the provided state and then overriding one of them with the provided state changing command.
PING - Static variable in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
 
PingCommand - Class in com.indexdata.mkjsf.pazpar2.commands
Represents a Pazpar2 ping command, , can be accessed by pzreq.init
PingCommand() - Constructor for class com.indexdata.mkjsf.pazpar2.commands.PingCommand
 
postConstruct() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
postInitDoc(String) - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
 
postInitDoc(byte[], Pazpar2Command) - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
 
put(String, ResponseDataObject) - Method in class com.indexdata.mkjsf.pazpar2.data.Responses
 
Pz2Client - Class in com.indexdata.mkjsf.pazpar2
Search client handling straight Pazpar2 requests.
Pz2Client() - Constructor for class com.indexdata.mkjsf.pazpar2.Pz2Client
 
pz2Client - Variable in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
Pz2Service - Class in com.indexdata.mkjsf.pazpar2
Pz2Service is the main controller of the search logic, used for selecting the service type (which can be done by configuration and/or run-time), selecting which search client to use, and performing high-level control of request cycles and state management.
Pz2Service() - Constructor for class com.indexdata.mkjsf.pazpar2.Pz2Service
 
Pz2Service.Preferred - Annotation Type in com.indexdata.mkjsf.pazpar2
 

Q

QueryParameter - Class in com.indexdata.mkjsf.pazpar2.commands
Represents a query parameter as it applies to the Pazpar2 search command
QueryParameter(String) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.QueryParameter
 
QueryParameter(String, String, String, Expression...) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.QueryParameter
 
QueryParameter(String, String, Expression...) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.QueryParameter
 
QueryParameter(String, String, String) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.QueryParameter
 
QueryParameter(String, String, int) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.QueryParameter
 
quote(String) - Static method in class com.indexdata.mkjsf.utils.UiUtils
Encloses a string with quotation marks

R

RECORD - Static variable in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
 
RecordCommand - Class in com.indexdata.mkjsf.pazpar2.commands
Represents a Pazpar2 record command, can be accessed by pzreq.record
RecordCommand() - Constructor for class com.indexdata.mkjsf.pazpar2.commands.RecordCommand
 
RecordCommandSp - Class in com.indexdata.mkjsf.pazpar2.commands.sp
Service Proxy extensions to the Papzar2 record command, these parameters being accessible by pzreq.record.sp.[parameter]
RecordCommandSp(RecordCommand) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.sp.RecordCommandSp
 
RecordResponse - Class in com.indexdata.mkjsf.pazpar2.data
Data from the record command, can be accessed by pzresp.record
RecordResponse() - Constructor for class com.indexdata.mkjsf.pazpar2.data.RecordResponse
 
removeExpression(Expression) - Method in class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
Removes a single expression identified by all its characteristics
removeExpression(String, Expression) - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
 
removeExpressions(String...) - Method in class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
Removes expressions selected by their left-of-operator fields/keys - as in 'expressionField=value'.
removeExpressions(String, String...) - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
 
removeExpressionsAfter(Expression, String...) - Method in class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
Removes all expressions that appear after the provided expression and that have the given keys to the left of their operators - as in 'expressionField=value'.
removeExpressionsAfter(String, Expression, String...) - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
 
removeFacet(String, String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Removes a facet set by setFacet(...) Will not remove facets set by setFacetOnQuery(...)
removeFilter(String, String, String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Removes a filter expression by exact attributes
removeFilters() - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Clears the filter parameter
removeFilters(String...) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Removes all filter expressions matching a field listed in fieldsToRemove
removeFiltersAfter(String, String, String, String...) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Removes filter expressions coming after the expression matching the provided filter expression, if they have a field listed in fieldsToRemove.
removeLimit(String, String, String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Removes a limit expression by exact attributes
removeLimits() - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Clears the limit parameter
removeLimits(String...) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Removes all limit expressions that have fields as listed in fieldsToRemove
removeLimitsAfter(String, String, String, String...) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Removes limit expressions coming after the provided limit expression, if they have a field listed in fieldsToRemove.
removeParameter(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
Removes a parameter completely and notifies the state manager about the change
removeParameters() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
Removes multiple parameters completely and notifies the state manager -- once -- about the change
removeParametersInState() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
Removes all parameters without notifying the state manager.
removeQueryExpression(String, String, String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Removes a query expression - for instance a facet criterion - by its exact attributes
removeStateListener(StateListener) - Method in class com.indexdata.mkjsf.pazpar2.state.StateManager
 
resetAuthAndBeyond(boolean) - Method in class com.indexdata.mkjsf.pazpar2.data.sp.SpResponses
Resets all responses from the authentication request to any request that can follow authentication.
resetInitAndBeyond() - Method in class com.indexdata.mkjsf.pazpar2.data.Responses
Empties all data objects populated after a service was initialized, including the init response itself but excluding a possible auth response
resetInitAndBeyond(boolean) - Method in class com.indexdata.mkjsf.pazpar2.data.sp.SpResponses
Resets all responses from the init request to any request that can follow init (i.e.
resetSearchAndBeyond() - Method in class com.indexdata.mkjsf.pazpar2.data.Responses
Empties all data objects populated after a search (including the search response itself)
resetSearchAndBeyond(boolean) - Method in class com.indexdata.mkjsf.pazpar2.data.sp.SpResponses
Resets all responses from the search request to any request that can follow search (i.e.
resetSearchAndRecordCommands() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
ResponseDataObject - Class in com.indexdata.mkjsf.pazpar2.data
Parent class of all response data objects, with generic methods for retrieving data elements
ResponseDataObject() - Constructor for class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
ResponseParser - Class in com.indexdata.mkjsf.pazpar2.data
Parses the XML stored in ClientCommandResponses and builds ResponseDataObjects from it.
ResponseParser() - Constructor for class com.indexdata.mkjsf.pazpar2.data.ResponseParser
 
Responses - Class in com.indexdata.mkjsf.pazpar2.data
Provides references to all current data objects and has general methods for clearing certain response data.
Responses() - Constructor for class com.indexdata.mkjsf.pazpar2.data.Responses
 
ResultsPager - Class in com.indexdata.mkjsf.controls
 
ResultsPager(Responses) - Constructor for class com.indexdata.mkjsf.controls.ResultsPager
 
ResultsPager(Responses, int, Pazpar2Commands) - Constructor for class com.indexdata.mkjsf.controls.ResultsPager
 
run() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
Executes the command with the currently selected parameters against the currently selected Pazpar2 service
run(SearchClient, Responses) - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
Executes the command in a thread.
run() - Method in class com.indexdata.mkjsf.pazpar2.commands.RecordCommand
Special handling of record responses since they come in three distinctly different ways As a regular <record> document In arbitrary XML format, in case of an offset request to get the native format In binary (non XML) format
run() - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
 
run() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.AuthCommand
 
run() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.CategoriesCommand
 
run() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.InitCommandSp
 
run() - Method in class com.indexdata.mkjsf.pazpar2.CommandThread
Executes the specified command using the specified Pazpar2 client
runWith(String...) - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
Executes the commands with the currently selected parameters, while adding the parameters provided

S

SEARCH - Static variable in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
 
searchClient - Variable in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
SearchClient - Interface in com.indexdata.mkjsf.pazpar2
 
SearchCommand - Class in com.indexdata.mkjsf.pazpar2.commands
Represents a Pazpar2 search command, can be accessed by pzreq.search
SearchCommand() - Constructor for class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
 
SearchCommandSp - Class in com.indexdata.mkjsf.pazpar2.commands.sp
 
SearchCommandSp(SearchCommand) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.sp.SearchCommandSp
 
SearchResponse - Class in com.indexdata.mkjsf.pazpar2.data
Data from the search command (a status message), can be accessed by pzresp.search
SearchResponse() - Constructor for class com.indexdata.mkjsf.pazpar2.data.SearchResponse
 
send(Pazpar2Command) - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
Makes the request
SERVICE_PROXY_URL_LIST - Static variable in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
ServiceError - Class in com.indexdata.mkjsf.pazpar2.data
 
ServiceError() - Constructor for class com.indexdata.mkjsf.pazpar2.data.ServiceError
 
serviceIsToBeDecided() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
ServiceProxyClient - Class in com.indexdata.mkjsf.pazpar2
Search client handling Service Proxy requests.
ServiceProxyClient() - Constructor for class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
 
ServiceProxyClient.ProxyPz2ResponseHandler - Class in com.indexdata.mkjsf.pazpar2
 
ServiceProxyClient.ProxyPz2ResponseHandler() - Constructor for class com.indexdata.mkjsf.pazpar2.ServiceProxyClient.ProxyPz2ResponseHandler
 
ServiceProxyCommand - Interface in com.indexdata.mkjsf.pazpar2.commands.sp
 
ServiceProxyCommands - Class in com.indexdata.mkjsf.pazpar2.commands.sp
ServiceProxyCommands holds references to all commands that are Service Proxy-only, those that are NOT supported by straight Pazpar2, that is.
ServiceProxyCommands(StateManager) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.sp.ServiceProxyCommands
 
set(String, String) - Method in class com.indexdata.mkjsf.config.Configuration
 
setAcefilter(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.RecordCommandSp
Sets Service Proxy command parameter acefilter.
setAction(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.AuthCommand
Sets Service Proxy command parameter action.
setActiveClients(int) - Method in class com.indexdata.mkjsf.pazpar2.data.TermListsResponse
 
setApplicationErrorCode(ErrorHelper.ErrorCode) - Method in class com.indexdata.mkjsf.errors.ConfigurationError
 
setApplicationErrorCode(ErrorHelper.ErrorCode) - Method in interface com.indexdata.mkjsf.errors.ErrorInterface
 
setApplicationErrorCode(ErrorHelper.ErrorCode) - Method in class com.indexdata.mkjsf.pazpar2.data.CommandError
 
setAttribute(String, String) - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
setBinary(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.RecordCommand
Sets the binary parameter.
setBinary(byte[]) - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
setBlock(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.ShowCommand
Sets Pazpar2 parameter block.
setBooleanOperator(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.QueryParameter
 
setBooleanOperatorForQuery(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
 
setChecksum(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.RecordCommand
Sets the checksum parameter.
setClear(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.InitCommand
Sets the clear parameter.
setCommandName(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
 
setCurrentStateKey(String) - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
Sets the current state key, i.e.
setCurrentStateKey(String) - Method in class com.indexdata.mkjsf.pazpar2.state.StateManager
Changes the current state key.
setErrorHelper(ErrorHelper) - Method in class com.indexdata.mkjsf.errors.ConfigurationError
 
setErrorHelper(ErrorHelper) - Method in interface com.indexdata.mkjsf.errors.ErrorInterface
 
setErrorHelper(ErrorHelper) - Method in class com.indexdata.mkjsf.pazpar2.data.CommandError
Sets the object that should be used to analyze the error
setErrorHelper(ErrorHelper) - Method in class com.indexdata.mkjsf.pazpar2.data.Responses
 
setEsn(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.RecordCommand
Sets the esn parameter.
setFacetOnQuery(String, String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Sets a facet to limit the current query by.
setFilter(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Sets the filter parameter.
setFilter(String, String, String, String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Sets the filter parameter.
setId(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.RecordCommand
Sets the id parameter.
setIncludeDebug(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.InitCommandSp
Sets Service Proxy command parameter includeDebug.
setIsNew(boolean) - Method in class com.indexdata.mkjsf.pazpar2.data.SearchResponse
 
setLimit(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Sets the limit parameter.
setLimit(String, String, String, String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Sets the limit parameter including a label.
setMaxrecs(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Sets the maxrecs parameter.
setMergekey(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Sets the mergekey parameter.
setMergekey(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.ShowCommand
Sets Pazpar2 parameter mergekey.
setName(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.TermlistCommand
Sets Pazpar2 parameter name.
setName(String) - Method in class com.indexdata.mkjsf.pazpar2.data.TermListResponse
 
setNativesyntax(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.RecordCommand
Sets the nativesyntax parameter.
setNum(int) - Method in class com.indexdata.mkjsf.pazpar2.commands.ShowCommand
Sets Pazpar2 parameter num.
setNum(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.TermlistCommand
Sets Pazpar2 parameter num.
setOffset(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.RecordCommand
Sets the offset parameter.
setPageLinks(int) - Method in class com.indexdata.mkjsf.controls.ResultsPager
 
setPager(int) - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
Initiates a pager object, a component holding the data to draw a sequence of page numbers to navigate by and mechanisms to navigate with
setPageSize(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.ShowCommand
Sets the number of records that pazpar2 should show at a time.
setParameter(CommandParameter) - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
Sets a parameter on this command and notifies the state manager about the change
setParameterInState(CommandParameter) - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
Sets a parameter on this command without notifying the state manager.
setParameters(CommandParameter...) - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
Sets multiple parameters on the command and notifies the state manager -- once -- about the change
setParametersInState(CommandParameter...) - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
Sets multiple parameters on this command without notifying the state manager.
setPassword(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.AuthCommand
Sets Service Proxy command parameter password.
setPazpar2Url(String) - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
Sets the URL of the Pazpar2 to use for requests
setQuery(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Sets the query parameter.
setRank(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Sets the rank parameter.
setRank(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.ShowCommand
Sets Pazpar2 parameter rank.
setRecordquery(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.RecordCommandSp
Sets Service Proxy command parameter recordquery.
setResponseToParse(String) - Method in class com.indexdata.mkjsf.pazpar2.ClientCommandResponse
Overrides the original response with a modified response.
setSearchCommand(Pazpar2Command) - Method in class com.indexdata.mkjsf.pazpar2.Pz2Client
 
setSearchCommand(Pazpar2Command) - Method in interface com.indexdata.mkjsf.pazpar2.SearchClient
 
setSearchCommand(Pazpar2Command) - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
Does nothing in Service Proxy context
setSequenceNumber(int) - Method in class com.indexdata.mkjsf.pazpar2.data.Location
 
setService(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.InitCommand
Sets the service parameter.
setServiceId(String) - Method in class com.indexdata.mkjsf.pazpar2.Pz2Client
Sets the service ID that Pazpar2 should use when servicing requests
setServiceId() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
setServiceProxyUrl(String) - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
Sets the URL of the Service Proxy to use for requests
setServiceTypePZ2() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
setServiceTypeSP() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
setServiceTypeTBD() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
setServiceUrl(String) - Method in class com.indexdata.mkjsf.pazpar2.Pz2Client
Sets the Pazpar2 URL to use for requests.
setServiceUrl(String) - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
Sets the URL to be used by the currently selected search client when running requests.
setServiceUrl(String) - Method in interface com.indexdata.mkjsf.pazpar2.SearchClient
 
setServiceUrl(String) - Method in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
Sets the URL of the Service Proxy that should service requests.
setSession(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.InitCommand
Disabled, not supported for init
setSession(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
 
setSort(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Sets the sort parameter.
setSort(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.ShowCommand
Sets Pazpar2 parameter sort.
setStart(int) - Method in class com.indexdata.mkjsf.pazpar2.commands.ShowCommand
Sets Pazpar2 parameter start.
setStartrecs(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
Sets the startrecs parameter.
setSyntax(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.RecordCommand
Sets the syntax parameter.
setTerms(List<TermResponse>) - Method in class com.indexdata.mkjsf.pazpar2.data.TermListResponse
 
SETTINGS - Static variable in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
 
SettingsCommand - Class in com.indexdata.mkjsf.pazpar2.commands
Represents a Pazpar2 settings command, can be accessed by pzreq.settings
SettingsCommand() - Constructor for class com.indexdata.mkjsf.pazpar2.commands.SettingsCommand
 
setType(String) - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
setUploadedFile(UploadedFile) - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.InitDocUpload
 
setUploadedFile(UploadedFile) - Method in class com.indexdata.mkjsf.utils.FileUpload
 
setUploadedInitDoc(UploadedFile) - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.InitCommandSp
 
setUsername(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.AuthCommand
Sets Service Proxy command parameter username.
setWindowid(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.BytargetCommandSp
Sets the windowid parameter.
setWindowid(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.InitCommandSp
Sets the windowid parameter.
setWindowid(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.RecordCommandSp
Sets the windowid parameter.
setWindowid(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.SearchCommandSp
Sets the windowid parameter.
setWindowid(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.ShowCommandSp
Sets the windowid parameter.
setWindowid(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.StatCommandSp
Sets the windowid parameter.
setWindowid(String) - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.TermlistCommandSp
Sets the windowid parameter.
setXml(String) - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject
 
SHOW - Static variable in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
 
ShowCommand - Class in com.indexdata.mkjsf.pazpar2.commands
Represents a Pazpar2 show command, can be accessed by pzreq.show
ShowCommand() - Constructor for class com.indexdata.mkjsf.pazpar2.commands.ShowCommand
 
ShowCommandSp - Class in com.indexdata.mkjsf.pazpar2.commands.sp
 
ShowCommandSp(ShowCommand) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.sp.ShowCommandSp
 
ShowResponse - Class in com.indexdata.mkjsf.pazpar2.data
Data from the show command, can be accessed by pzresp.show
ShowResponse() - Constructor for class com.indexdata.mkjsf.pazpar2.data.ShowResponse
 
SP_INIT_DOC_PATHS - Static variable in class com.indexdata.mkjsf.pazpar2.ServiceProxyClient
 
spClient - Variable in class com.indexdata.mkjsf.pazpar2.Pz2Service
 
spOnly() - Method in class com.indexdata.mkjsf.pazpar2.commands.BytargetCommand
 
spOnly() - Method in class com.indexdata.mkjsf.pazpar2.commands.InitCommand
 
spOnly() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
Here implementing commands publish whether they only apply to the Service Proxy or can be executed against straight Pazpar2 as well.
spOnly() - Method in class com.indexdata.mkjsf.pazpar2.commands.PingCommand
 
spOnly() - Method in class com.indexdata.mkjsf.pazpar2.commands.RecordCommand
 
spOnly() - Method in class com.indexdata.mkjsf.pazpar2.commands.SearchCommand
 
spOnly() - Method in class com.indexdata.mkjsf.pazpar2.commands.SettingsCommand
 
spOnly() - Method in class com.indexdata.mkjsf.pazpar2.commands.ShowCommand
 
spOnly() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.AuthCommand
 
spOnly() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.BytargetCommandSp
 
spOnly() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.CategoriesCommand
 
spOnly() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.InitCommandSp
 
spOnly() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.RecordCommandSp
 
spOnly() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.SearchCommandSp
 
spOnly() - Method in interface com.indexdata.mkjsf.pazpar2.commands.sp.ServiceProxyCommand
 
spOnly() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.ShowCommandSp
 
spOnly() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.StatCommandSp
 
spOnly() - Method in class com.indexdata.mkjsf.pazpar2.commands.sp.TermlistCommandSp
 
spOnly() - Method in class com.indexdata.mkjsf.pazpar2.commands.StatCommand
 
spOnly() - Method in class com.indexdata.mkjsf.pazpar2.commands.TermlistCommand
 
SpResponseDataObject - Class in com.indexdata.mkjsf.pazpar2.data.sp
Base class for Service Proxy-only response data
SpResponseDataObject() - Constructor for class com.indexdata.mkjsf.pazpar2.data.sp.SpResponseDataObject
 
SpResponses - Class in com.indexdata.mkjsf.pazpar2.data.sp
Provides references to all current Service Proxy-only data objects.
SpResponses(Responses) - Constructor for class com.indexdata.mkjsf.pazpar2.data.sp.SpResponses
 
startElement(String, String, String, Attributes) - Method in class com.indexdata.mkjsf.pazpar2.data.ResponseParser
Receive notification at the start of element
STAT - Static variable in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
 
StatCommand - Class in com.indexdata.mkjsf.pazpar2.commands
Represents a Pazpar2 stat command, can be accessed by pzreq.state
StatCommand() - Constructor for class com.indexdata.mkjsf.pazpar2.commands.StatCommand
 
StatCommandSp - Class in com.indexdata.mkjsf.pazpar2.commands.sp
 
StatCommandSp(StatCommand) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.sp.StatCommandSp
 
StateListener - Interface in com.indexdata.mkjsf.pazpar2.state
 
StateManager - Class in com.indexdata.mkjsf.pazpar2.state
 
StateManager() - Constructor for class com.indexdata.mkjsf.pazpar2.state.StateManager
 
stateMutating(Pazpar2Command) - Method in class com.indexdata.mkjsf.pazpar2.state.Pazpar2State
Checks if a command represents a change of this state
stateUpdated(String) - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
Used by the state manager to notify Pz2Service about state changes
stateUpdated(String) - Method in interface com.indexdata.mkjsf.pazpar2.state.StateListener
 
StatResponse - Class in com.indexdata.mkjsf.pazpar2.data
Data from the stat command, can be accessed by pzresp.stat
StatResponse() - Constructor for class com.indexdata.mkjsf.pazpar2.data.StatResponse
 

T

Target - Class in com.indexdata.mkjsf.pazpar2.data
Data from the bytarget command, child object of ByTargetResponse
Target() - Constructor for class com.indexdata.mkjsf.pazpar2.data.Target
 
TargetCategory - Class in com.indexdata.mkjsf.pazpar2.data.sp
Data from the categories command, can be accessed by pzresp.sp.categories.targetCategories
TargetCategory() - Constructor for class com.indexdata.mkjsf.pazpar2.data.sp.TargetCategory
 
TERMLIST - Static variable in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands
 
TermlistCommand - Class in com.indexdata.mkjsf.pazpar2.commands
Represents a Pazpar2 termlist command, can be accessed by pzreq.termlist
TermlistCommand() - Constructor for class com.indexdata.mkjsf.pazpar2.commands.TermlistCommand
 
TermlistCommandSp - Class in com.indexdata.mkjsf.pazpar2.commands.sp
 
TermlistCommandSp(TermlistCommand) - Constructor for class com.indexdata.mkjsf.pazpar2.commands.sp.TermlistCommandSp
 
TermListResponse - Class in com.indexdata.mkjsf.pazpar2.data
Data from the termlist command, child object of TermListsResponse
TermListResponse() - Constructor for class com.indexdata.mkjsf.pazpar2.data.TermListResponse
 
TermListsResponse - Class in com.indexdata.mkjsf.pazpar2.data
Data from the termlist command, can be accessed by pzresp.termLists
TermListsResponse() - Constructor for class com.indexdata.mkjsf.pazpar2.data.TermListsResponse
 
TermResponse - Class in com.indexdata.mkjsf.pazpar2.data
Data from the termlist command, child object of TermListResponse
TermResponse() - Constructor for class com.indexdata.mkjsf.pazpar2.data.TermResponse
 
TermXTargetResponse - Class in com.indexdata.mkjsf.pazpar2.data
Data from the termlist command, child object of TermListResponse
TermXTargetResponse() - Constructor for class com.indexdata.mkjsf.pazpar2.data.TermXTargetResponse
 
toggleRecord(String) - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
Will retrieve -- or alternatively remove -- the record with the given recid from memory.
toString() - Method in class com.indexdata.mkjsf.pazpar2.commands.CommandParameter
 
toString() - Method in class com.indexdata.mkjsf.pazpar2.commands.Expression
 
toString() - Method in class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
 
toString() - Method in class com.indexdata.mkjsf.pazpar2.data.TermListResponse
 
toString() - Method in class com.indexdata.mkjsf.pazpar2.data.TermResponse
 

U

UiUtils - Class in com.indexdata.mkjsf.utils
UI utilities
UiUtils() - Constructor for class com.indexdata.mkjsf.utils.UiUtils
 
unsupportedCommand() - Method in class com.indexdata.mkjsf.pazpar2.data.sp.SpResponseDataObject
Returns true if the command was not recognized by the Service Proxy, passed on to Pazpar2, and then also not recognized by Pazpar2.
update() - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
Updates display data objects by simultaneously issuing the following Pazpar2 commands: 'show', 'stat', 'termlist' and 'bytarget'.
update(String) - Method in class com.indexdata.mkjsf.pazpar2.Pz2Service
Simultaneously refreshes the data objects listed in 'commands' from pazpar2, potentially running a search or a record command first if any of these two commands have outstanding parameter changes.
Utils - Class in com.indexdata.mkjsf.utils
A few utilities, mostly for logging
Utils() - Constructor for class com.indexdata.mkjsf.utils.Utils
 

V

valueOf(String) - Static method in enum com.indexdata.mkjsf.errors.ErrorHelper.ErrorCode
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.indexdata.mkjsf.errors.ErrorHelper.ErrorCode
Returns an array containing the constants of this enum type, in the order they are declared.

W

WebXmlConfigReader - Class in com.indexdata.mkjsf.config
Reads a configuration from the context parameters of the deployment descriptor (web.xml)
WebXmlConfigReader() - Constructor for class com.indexdata.mkjsf.config.WebXmlConfigReader
 

A B C D E F G H I L M N O P Q R S T U V W

Copyright © 2013. All Rights Reserved.