velosurf.web
Class HttpQueryTool

java.lang.Object
  org.apache.velocity.tools.generic.SafeConfig
      org.apache.velocity.tools.generic.LocaleConfig
          org.apache.velocity.tools.generic.ConversionTool
              org.apache.velocity.tools.generic.ValueParser
                  org.apache.velocity.tools.view.ParameterTool
                      org.apache.velocity.tools.view.tools.ParameterParser
                          velosurf.web.HttpQueryTool

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.Object>

Deprecated.

@Deprecated
public class HttpQueryTool
extends org.apache.velocity.tools.view.tools.ParameterParser

(Deprecated - please use org.apache.velocity.tools.view.ParameterTool)

This class extends the tool org.apache.velocity.tools.view.tools.ParameterParser, adding a generic setter. Values that are set manually hide any previous values that are present in the query under the same key. It is meant for the query scope.

Author:

Claude Brisson

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

private java.util.Map<java.lang.String,java.lang.Object>

extraValues Deprecated. extra values map.

Fields inherited from class org.apache.velocity.tools.generic.ValueParser

ALLOWSUBKEYS_KEY, READONLY_KEY

Fields inherited from class org.apache.velocity.tools.generic.ConversionTool

DATE_FORMAT_KEY, DEFAULT_DATE_FORMAT, DEFAULT_NUMBER_FORMAT, DEFAULT_STRINGS_DELIMITER, DEFAULT_STRINGS_TRIM, NUMBER_FORMAT_KEY, STRINGS_DELIMITER_FORMAT_KEY, STRINGS_TRIM_KEY

Fields inherited from class org.apache.velocity.tools.generic.LocaleConfig

DEFAULT_LOCALE

Fields inherited from class org.apache.velocity.tools.generic.SafeConfig

LOCK_CONFIG_KEY, OLD_LOCK_CONFIG_KEY, SAFE_MODE_KEY

Constructor Summary

HttpQueryTool()
Deprecated. Constructor.

Method Summary

void	clear() Deprecated. Clear extra parameters.
boolean	containsKey(java.lang.Object key) Deprecated. Check for the presence of a parameter.
boolean	containsValue(java.lang.Object value) Deprecated. Check for the presence of a value.
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>>	entrySet() Deprecated.
java.lang.Object	get(java.lang.Object key) Deprecated. Generic getter.
java.lang.Object	get(java.lang.String key) Deprecated. Generic getter with String argument (necessary to properly overload super getter).
java.util.Set<java.lang.String>	getExtraKeys() Deprecated.
java.lang.Integer	getInteger(java.lang.String key) Deprecated.
java.lang.String	getQueryString() Deprecated. Debugging method: returns a query string corresponding to query parameters Warning: it also includes POST parameters (so strictly speaking it's not the real query string)
void	init(java.lang.Object viewContext) Deprecated. Initialize this tool.
boolean	isEmpty() Deprecated. Check for the presence of parameters.
java.util.Set	keySet() Deprecated. Get the set of parameter names.
java.lang.Object	put(java.lang.String key, java.lang.Object value) Deprecated. Generic setter.
void	putAll(java.util.Map map) Deprecated. Put all key/values from a map.
java.lang.Object	remove(java.lang.Object key) Deprecated. Remove a parameter (from extra values).
int	size() Deprecated. Get the number of parameters.
java.lang.String	toString() Deprecated.
java.util.Collection	values() Deprecated. Get the collection of values

Methods inherited from class org.apache.velocity.tools.view.ParameterTool

configure, getAll, getRequest, getSource, getValue, getValues, setRequest, setSource

Methods inherited from class org.apache.velocity.tools.generic.ValueParser

exists, getAllowSubkeys, getBoolean, getBoolean, getBoolean, getBooleans, getDouble, getDouble, getDouble, getDoubles, getInt, getInteger, getInts, getLocale, getLocale, getLocales, getNumber, getNumber, getNumbers, getReadOnly, getString, getString, getStrings, getSubkey, getValue, hasSubkeys, setAllowSubkeys, setReadOnly

Methods inherited from class org.apache.velocity.tools.generic.ConversionTool

getDateFormat, getNumberFormat, getStringsDelimiter, getStringsTrim, parseBoolean, parseDate, parseDate, parseDate, parseDate, parseDate, parseLocale, parseNumber, parseNumber, parseNumber, parseNumber, parseStringList, setDateFormat, setNumberFormat, setStringsDelimiter, setStringsTrim, toBoolean, toBooleans, toBooleans, toCalendar, toCalendars, toCalendars, toDate, toDates, toDates, toDouble, toDoubles, toInteger, toIntegers, toInts, toLocale, toLocales, toLocales, toNumber, toNumbers, toNumbers, toString, toStrings

Methods inherited from class org.apache.velocity.tools.generic.LocaleConfig

getLocale, setLocale

Methods inherited from class org.apache.velocity.tools.generic.SafeConfig

configure, isConfigLocked, isSafeMode, setLockConfig, setSafeMode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

extraValues

private java.util.Map<java.lang.String,java.lang.Object> extraValues

Deprecated.

extra values map.

Constructor Detail

HttpQueryTool

public HttpQueryTool()

Deprecated.

Constructor.

Method Detail

init

public void init(java.lang.Object viewContext)

Deprecated.

Initialize this tool.

Overrides:

init in class org.apache.velocity.tools.view.tools.ParameterParser

Parameters:

viewContext - view context

get

public java.lang.Object get(java.lang.Object key)

Deprecated.

Generic getter.

Specified by:

get in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

get in class org.apache.velocity.tools.generic.ValueParser

Parameters:

key - key

Returns:

value or null

get

public java.lang.Object get(java.lang.String key)

Deprecated.

Generic getter with String argument (necessary to properly overload super getter).

Overrides:

get in class org.apache.velocity.tools.generic.ValueParser

Parameters:

key - key

Returns:

value or null

put

public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)

Deprecated.

Generic setter.

Specified by:

put in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

put in class org.apache.velocity.tools.generic.ValueParser

Parameters:

key - key

value - value

Returns:

previous value

size

public int size()

Deprecated.

Get the number of parameters.

Specified by:

size in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

size in class org.apache.velocity.tools.generic.ValueParser

Returns:

number of parameters

isEmpty

public boolean isEmpty()

Deprecated.

Check for the presence of parameters.

Specified by:

isEmpty in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

isEmpty in class org.apache.velocity.tools.generic.ValueParser

Returns:

true if empty

containsKey

public boolean containsKey(java.lang.Object key)

Deprecated.

Check for the presence of a parameter.

Specified by:

containsKey in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

containsKey in class org.apache.velocity.tools.generic.ValueParser

Parameters:

key - parameter name

Returns:

true if present

containsValue

public boolean containsValue(java.lang.Object value)

Deprecated.

Check for the presence of a value.

Specified by:

containsValue in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

containsValue in class org.apache.velocity.tools.generic.ValueParser

Parameters:

value - value to find

Returns:

true if present

remove

public java.lang.Object remove(java.lang.Object key)

Deprecated.

Remove a parameter (from extra values).

Specified by:

remove in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

remove in class org.apache.velocity.tools.generic.ValueParser

Parameters:

key - parameter name

Returns:

value or null

putAll

public void putAll(java.util.Map map)

Deprecated.

Put all key/values from a map.

Specified by:

putAll in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

putAll in class org.apache.velocity.tools.generic.ValueParser

Parameters:

map - source map

clear

public void clear()

Deprecated.

Clear extra parameters.

Specified by:

clear in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

clear in class org.apache.velocity.tools.generic.ValueParser

keySet

public java.util.Set keySet()

Deprecated.

Get the set of parameter names.

Specified by:

keySet in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

keySet in class org.apache.velocity.tools.generic.ValueParser

Returns:

set of names

values

public java.util.Collection values()

Deprecated.

Get the collection of values

Specified by:

values in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

values in class org.apache.velocity.tools.generic.ValueParser

Returns:

collection of values

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()

Deprecated.

Specified by:

entrySet in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

entrySet in class org.apache.velocity.tools.generic.ValueParser

toString

public java.lang.String toString()

Deprecated.

Overrides:

toString in class org.apache.velocity.tools.generic.ValueParser

getExtraKeys

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

Deprecated.

getQueryString

public java.lang.String getQueryString()

Deprecated.

Debugging method: returns a query string corresponding to query parameters Warning: it also includes POST parameters (so strictly speaking it's not the real query string)

Returns:

reconstitued query string

getInteger

public java.lang.Integer getInteger(java.lang.String key)

Deprecated.

Overrides:

getInteger in class org.apache.velocity.tools.generic.ValueParser