org.apache.turbine.util.parser
Interface ParameterParser

All Superinterfaces:

ValueParser

All Known Implementing Classes:

DefaultParameterParser

public interface ParameterParser

extends ValueParser

ParameterParser is an interface to a utility to handle parsing and retrieving the data passed via the GET/POST/PATH_INFO arguments.

NOTE: The name= portion of a name=value pair may be converted to lowercase or uppercase when the object is initialized and when new data is added. This behaviour is determined by the url.case.folding property in TurbineResources.properties. Adding a name/value pair may overwrite existing name=value pairs if the names match:

 ParameterParser pp = data.getParameters();
 pp.add("ERROR",1);
 pp.add("eRrOr",2);
 int result = pp.getInt("ERROR");
 

In the above example, result is 2.

Version:

$Id: ParameterParser.java 534527 2007-05-02 16:10:59Z tv $

Author:

Ilkka Priha, Jon S. Stevens, Sean Legassick, Henning P. Schmiedehausen

Field Summary

Fields inherited from interface org.apache.turbine.util.parser.ValueParser

URL_CASE_FOLDING, URL_CASE_FOLDING_LOWER, URL_CASE_FOLDING_NONE, URL_CASE_FOLDING_UPPER

Method Summary

void	add(java.lang.String name, org.apache.commons.fileupload.FileItem item) Add a FileItem object as a parameters.
void	append(java.lang.String name, org.apache.commons.fileupload.FileItem item) Deprecated. Use add(String name, FileItem item) instead.
org.apache.commons.fileupload.FileItem	getFileItem(java.lang.String name) Return a FileItem object for the given name.
org.apache.commons.fileupload.FileItem[]	getFileItems(java.lang.String name) Return an array of FileItem objects for the given name.
javax.servlet.http.HttpServletRequest	getRequest() Gets the parsed servlet request.
byte[]	getUploadData() Gets the uploadData byte[]
void	setRequest(javax.servlet.http.HttpServletRequest req) Sets the servlet request to be parser.
void	setUploadData(byte[] uploadData) Sets the uploadData byte[]

Methods inherited from interface org.apache.turbine.util.parser.ValueParser

add, add, add, add, add, add, append, clear, containsDateSelectorKeys, containsKey, convert, get, getBigDecimal, getBigDecimal, getBigDecimals, getBool, getBool, getBoolean, getBoolean, getBooleanObject, getBooleanObject, getBooleanObjects, getBooleans, getByte, getByte, getByteObject, getByteObject, getBytes, getCharacterEncoding, getDate, getDate, getDate, getDateFormat, getDouble, getDouble, getDoubleObject, getDoubleObject, getDoubleObjects, getDoubles, getFloat, getFloat, getFloatObject, getFloatObject, getFloatObjects, getFloats, getInt, getInt, getInteger, getInteger, getInteger, getIntegers, getIntObject, getIntObject, getIntObjects, getInts, getKeys, getLocale, getLong, getLong, getLongObject, getLongObject, getLongObjects, getLongs, getNumberFormat, getNumberKey, getObject, getObjects, getString, getString, getStringKey, getStrings, getStrings, keys, keySet, remove, setCharacterEncoding, setDateFormat, setLocale, setNumberFormat, setProperties, setString, setStrings, toString

Method Detail

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Gets the parsed servlet request.

Returns:

the parsed servlet request or null.

setRequest

public void setRequest(javax.servlet.http.HttpServletRequest req)

Sets the servlet request to be parser. This requires a valid HttpServletRequest object. It will attempt to parse out the GET/POST/PATH_INFO data and store the data into a Map. There are convenience methods for retrieving the data as a number of different datatypes. The PATH_INFO data must be a URLEncoded() string.

To add name/value pairs to this set of parameters, use the add() methods.

Parameters:

req - An HttpServletRequest.

setUploadData

public void setUploadData(byte[] uploadData)

Sets the uploadData byte[]

Parameters:

uploadData - A byte[] with data.

getUploadData

public byte[] getUploadData()

Gets the uploadData byte[]

Returns:

uploadData A byte[] with data.

append

public void append(java.lang.String name,
                   org.apache.commons.fileupload.FileItem item)

Deprecated. Use add(String name, FileItem item) instead.

Add a FileItem object as a parameters. If there are any FileItems already associated with the name, append to the array. The reason for this is that RFC 1867 allows multiple files to be associated with single HTML input element.

Parameters:

name - A String with the name.

item - A FileItem with the value.

add

public void add(java.lang.String name,
                org.apache.commons.fileupload.FileItem item)

Add a FileItem object as a parameters. If there are any FileItems already associated with the name, append to the array. The reason for this is that RFC 1867 allows multiple files to be associated with single HTML input element.

Parameters:

name - A String with the name.

item - A FileItem with the value.

getFileItem

public org.apache.commons.fileupload.FileItem getFileItem(java.lang.String name)

Return a FileItem object for the given name. If the name does not exist or the object stored is not a FileItem, return null.

Parameters:

name - A String with the name.

Returns:

A FileItem.

getFileItems

public org.apache.commons.fileupload.FileItem[] getFileItems(java.lang.String name)

Return an array of FileItem objects for the given name. If the name does not exist or the object stored is not a FileItem array, return null.

Parameters:

name - A String with the name.

Returns:

A FileItem[].