core.tut.pori.http.parameters

Class QueryParameter

java.lang.Object

core.tut.pori.http.parameters.HTTPParameter

core.tut.pori.http.parameters.QueryParameter

public class QueryParameter
extends HTTPParameter

The default parser for query parameters, the syntax being: ?query=VALUE It is also possible to provide query for a specific type with ?query=TYPE:VALUE The two variations can be combined: ?query=TYPE;VALUE,VALUE The order of parameter values is preserved. Note that in all cases the order cannot be strictly preserved. For example, ?query=VALUE,TYPE:VALUE2,VALUE3, in this case the non-typed VALUE and VALUE3 will be grouped, and thus, both terms will appear before TYPE:VALUE2.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAMETER_DEFAULT_NAME Recommended name for the Query parameter

Constructor Summary

Constructors

Constructor and Description
QueryParameter()
QueryParameter(java.lang.String queryString)

Method Summary

Modifier and Type	Method and Description
void	addQueryParameter(java.lang.String type, java.lang.String value)
java.util.Set<java.lang.String>	getValue()
static java.util.Set<java.lang.String>	getValues(QueryParameter param, java.lang.String typeName)
boolean	hasValues()
void	initialize(java.io.InputStream parameterValue) Initialize this parameter based on input stream Override this method if you want to accept HTTP Body data.
void	initialize(java.util.List<java.lang.String> parameterValues) Initialize this parameter based on the given parameter values
void	initialize(java.lang.String parameterValue) Initialize this parameter based on the given parameter value
void	initializeRaw(java.util.List<java.lang.String> parameterValues) Initialize the parameter by raw URL encoded string list.
void	initializeRaw(java.lang.String parameterValue) Initialize the parameter by raw URL encoded string.

Methods inherited from class core.tut.pori.http.parameters.HTTPParameter

getParameterName, setParameterName

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_DEFAULT_NAME

public static final java.lang.String PARAMETER_DEFAULT_NAME

Recommended name for the Query parameter

See Also:

Constant Field Values

Constructor Detail

QueryParameter

public QueryParameter()

QueryParameter

public QueryParameter(java.lang.String queryString)

Parameters:

queryString - URL decoded query string

Method Detail

initializeRaw

public void initializeRaw(java.lang.String parameterValue)
                   throws java.lang.IllegalArgumentException

Description copied from class: HTTPParameter

Initialize the parameter by raw URL encoded string. This can be overridden to intercept the URL encoded parameter, the default implementation decodes the string and calls initialize()

Overrides:

initializeRaw in class HTTPParameter

Throws:

java.lang.IllegalArgumentException

initializeRaw

public void initializeRaw(java.util.List<java.lang.String> parameterValues)
                   throws java.lang.IllegalArgumentException

Description copied from class: HTTPParameter

Initialize the parameter by raw URL encoded string list. This can be overridden to intercept the URL encoded parameter, the default implementation decodes the string and calls initialize()

Overrides:

initializeRaw in class HTTPParameter

Throws:

java.lang.IllegalArgumentException

initialize

public void initialize(java.util.List<java.lang.String> parameterValues)
                throws java.lang.IllegalArgumentException

Description copied from class: HTTPParameter

Initialize this parameter based on the given parameter values

Specified by:

initialize in class HTTPParameter

Parameters:

parameterValues - list of URL decoded values, this will assume the whole string to be a single search term, WITHOUT type

Throws:

java.lang.IllegalArgumentException - on bad input data

initialize

public void initialize(java.lang.String parameterValue)
                throws java.lang.IllegalArgumentException

Description copied from class: HTTPParameter

Initialize this parameter based on the given parameter value

Specified by:

initialize in class HTTPParameter

Parameters:

parameterValue - an URL decoded value, this will assume the whole string to be a single search term, WITHOUT type

Throws:

java.lang.IllegalArgumentException - on bad input data

addQueryParameter

public void addQueryParameter(java.lang.String type,
                              java.lang.String value)

Parameters:

type - type of the query term

value - the query term

hasValues

public boolean hasValues()

Specified by:

hasValues in class HTTPParameter

Returns:

true if this parameter has one or more values

getValue

public java.util.Set<java.lang.String> getValue()

Specified by:

getValue in class HTTPParameter

Returns:

the non-typed search string, or null if none available

getValues

public static java.util.Set<java.lang.String> getValues(QueryParameter param,
                                                        java.lang.String typeName)

Parameters:

param -

typeName -

Returns:

set for the type name or null if none

initialize

public void initialize(java.io.InputStream parameterValue)
                throws java.lang.IllegalArgumentException

Description copied from class: HTTPParameter

Initialize this parameter based on input stream Override this method if you want to accept HTTP Body data. The default implementation only throws an exception.

Overrides:

initialize in class HTTPParameter

Parameters:

parameterValue - can be null

Throws:

java.lang.IllegalArgumentException - on bad input data