to.etc.domui.state

Class PageParameters

java.lang.Object

to.etc.domui.state.PageParameters

All Implemented Interfaces:

Serializable, IPageParameters

public class PageParameters
extends Object
implements IPageParameters, Serializable

Encapsulates parameters for a page. All parameters must be presentable in URL form, i.e. they must be renderable as part of a GET or POST. A page request formed by a Page class and a PageParameters class is bookmarkable. This is a mutable object. A PageParameters object can be rendered on an URL by using DomUtil#addUrlParameters(StringBuilder, PageParameters, boolean).

Author:

Frits Jalvingh Created on Jun 22, 2008

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PageParameters() Create an empty PageParameters.
PageParameters(Object... list) Create page parameters and fill with the initial set defined in the argument list.

Method Summary

Modifier and Type	Method and Description
void	addParameter(String name, Object value) Adds a parameter with the specified name.
void	addParameters(Object... plist) Add parameters.
static void	applyChanges(PageParameters source, PageParameters changes) Apply changes to source.
String	calculateHashString() EXPENSIVE Hash all parameter values into an MD5 hash.
static PageParameters	createFrom(IRequestContext ctx) Create this from an actual request.
static PageParameters	createFromEncodedUrlString(String paramsAsString) Create this from an string representation of params.
static PageParameters	decodeParameters(String query) Decode a http query string into a PageParameters instance.
boolean	equals(Object obj) Compare this with another instance.
boolean	getBoolean(String name) Gets the value for the specified parametername as a boolean (primitive).
boolean	getBoolean(String name, boolean df) Gets the value for the specified parametername as a boolean (primitive).
int	getDataLength() Return the number of characters that this would take on an url.
int	getInt(String name) Gets the value for the specified parametername as an int (primitive).
int	getInt(String name, int df) Gets the value for the specified parametername as an int (primitive).
long	getLong(String name) Gets the value for the specified parametername as a long (primitive).
long	getLong(String name, long df) Gets the value for the specified parametername as a long (primitive).
Long	getLongW(String name) Gets the value for the specified parametername as a Long object.
Long	getLongW(String name, long df) Gets the value for the specified parametername as a Long object.
Long	getLongW(String name, Long df) Gets the value for the specified parametername as a Long object.
Object	getObject(String name) Gets the value for the specified parameter name as untyped value.
String[]	getParameterNames() Gets all the names of the parameters this object is holding
String	getString(String name) Gets the value for the specified parametername as a String object.
String	getString(String name, String df) Gets the value for the specified parametername as a String object.
String[]	getStringArray(String name) Gets the value for the specified parametername as a String array.
String[]	getStringArray(String name, String[] deflt)
PageParameters	getUnlockedCopy() Creates copy of current PageParameters.
int	hashCode()
boolean	hasParameter(String name) Indicates whether a given parameter name exists in this PageParameters object.
boolean	isReadOnly()
void	putObject(String name, Object value)
void	removeParameter(String name) Removes the parameter with specified name entirely from the map.
void	setReadOnly()
int	size() Return the number of parameter (names) in this instance.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PageParameters

public PageParameters()

Create an empty PageParameters.

PageParameters

public PageParameters(Object... list)

Create page parameters and fill with the initial set defined in the argument list. For details of what can be passed see addParameters(Object...).

Parameters:

list -

Method Detail

getUnlockedCopy

@Nonnull
public PageParameters getUnlockedCopy()

Description copied from interface: IPageParameters

Creates copy of current PageParameters. Since modification of live page params is not allowed, in order to navigate to other page with similar set of params, use this method to get params template for new page navigation.

Specified by:

getUnlockedCopy in interface IPageParameters

Returns:

See Also:

IPageParameters.getUnlockedCopy()

setReadOnly

public void setReadOnly()

addParameters

public void addParameters(Object... plist)
                   throws Exception

Add parameters. This accepts multiple formats that can all be mixed. Each actual parameter always is a name, value pair. The simplest way to use this is to specify a list of strings in pairs where the first string in the pair is the key and the second one is the value. You can also substitute an object instance for the value; if this object instance represents some persistent entity or implements IIdentifyable the primary key for the object will be rendered as the value, otherwise it will be rendered as a tostring. You can also specify a single object in the location for the next key; in this case both key and value will be determined from this object; it must be some persistent object which knows it's key field.

Parameters:

plist -

Throws:

Exception

addParameter

public void addParameter(String name,
                         Object value)

Adds a parameter with the specified name. When a parameter with the same name already exists, the existing value will be overwritten with the specified value.

Parameters:

name, - the parameter name.

value, - the (new) value.

removeParameter

public void removeParameter(String name)

Removes the parameter with specified name entirely from the map.

Parameters:

name, - the name of the parameter to be removed.

hasParameter

public boolean hasParameter(String name)

Description copied from interface: IPageParameters

Indicates whether a given parameter name exists in this PageParameters object.

Specified by:

hasParameter in interface IPageParameters

Returns:

true when the parameter exists, false otherwise.

See Also:

IPageParameters.hasParameter(java.lang.String)

size

public int size()

Return the number of parameter (names) in this instance.

Specified by:

size in interface IPageParameters

Returns:

getInt

public int getInt(String name)

Description copied from interface: IPageParameters

Gets the value for the specified parametername as an int (primitive). If the parameter does not exists or the value cannot be converted to an int, a MissingParameterException is thrown.

Specified by:

getInt in interface IPageParameters

Returns:

the value as an int

See Also:

IPageParameters.getInt(java.lang.String)

getInt

public int getInt(String name,
                  int df)

Description copied from interface: IPageParameters

Gets the value for the specified parametername as an int (primitive). If the parameter does cannot be converted to an int, a MissingParameterException is thrown. When the parameter does not exist, the specified default value is returned.

Specified by:

getInt in interface IPageParameters

Returns:

the value as an int

See Also:

IPageParameters.getInt(java.lang.String, int)

getLong

public long getLong(String name)

Description copied from interface: IPageParameters

Gets the value for the specified parametername as a long (primitive). When multiple value exists for the specified parameter, the first element of the array is returned. If the parameter does not exists or the value cannot be converted to an long, a MissingParameterException is thrown.

Specified by:

getLong in interface IPageParameters

Returns:

the value as a long

See Also:

IPageParameters.getLong(java.lang.String)

getLong

public long getLong(String name,
                    long df)

Description copied from interface: IPageParameters

Gets the value for the specified parametername as a long (primitive). When multiple value exists for the specified parameter, the first element of the array is returned. If the parameter does cannot be converted to an long, a MissingParameterException is thrown. When the parameter does not exist, the specified default value is returned.

Specified by:

getLong in interface IPageParameters

Returns:

the value as a long

See Also:

IPageParameters.getLong(java.lang.String, long)

getBoolean

public boolean getBoolean(String name)

Description copied from interface: IPageParameters

Gets the value for the specified parametername as a boolean (primitive). When multiple value exists for the specified parameter, the first element of the array is returned. If the parameter does not exists or the value cannot be converted to an boolean, a MissingParameterException is thrown.

Specified by:

getBoolean in interface IPageParameters

Returns:

the value as a long

See Also:

IPageParameters.getBoolean(java.lang.String)

getBoolean

public boolean getBoolean(String name,
                          boolean df)

Description copied from interface: IPageParameters

Gets the value for the specified parametername as a boolean (primitive). When multiple value exists for the specified parameter, the first element of the array is returned. If the parameter does cannot be converted to an boolean, a MissingParameterException is thrown. When the parameter does not exist, the specified default value is returned.

Specified by:

getBoolean in interface IPageParameters

Returns:

the value as a boolean

See Also:

IPageParameters.getBoolean(java.lang.String, boolean)

getLongW

public Long getLongW(String name)

Description copied from interface: IPageParameters

Gets the value for the specified parametername as a Long object. When multiple value exists for the specified parameter, the first element of the array is returned. If the parameter does not exists or the value cannot be converted to an int, a MissingParameterException is thrown. This method uses decode() so hexadecimal and octal strings can be used as parameter values.

Specified by:

getLongW in interface IPageParameters

Returns:

the value as a Long

See Also:

IPageParameters.getLongW(java.lang.String)

getLongW

public Long getLongW(String name,
                     long df)

Description copied from interface: IPageParameters

Gets the value for the specified parametername as a Long object. When multiple value exists for the specified parameter, the first element of the array is returned. If the parameter does cannot be converted to an int, a MissingParameterException is thrown. When the parameter does not exist, the specified default value is returned. This method uses decode() so hexadecimal and octal strings can be used as parameter values.

Specified by:

getLongW in interface IPageParameters

Returns:

the value as a Long

See Also:

IPageParameters.getLongW(java.lang.String, long)

getLongW

public Long getLongW(String name,
                     Long df)

Description copied from interface: IPageParameters

Gets the value for the specified parametername as a Long object. When multiple value exists for the specified parameter, the first element of the array is returned. If the parameter does cannot be converted to an int, a MissingParameterException is thrown. When the parameter does not exist, the specified default value is returned. This method uses decode() so hexadecimal and octal strings can be used as parameter values.

Specified by:

getLongW in interface IPageParameters

Returns:

the value as a Long

See Also:

IPageParameters.getLongW(java.lang.String, java.lang.Long)

getString

@Nonnull
public String getString(String name)

Description copied from interface: IPageParameters

Gets the value for the specified parametername as a String object. When multiple value exists for the specified parameter, a MultipleParameterException is thrown. When the parameter does not exist, a MissingParameterException is thrown.

Specified by:

getString in interface IPageParameters

Returns:

the value as a String

See Also:

IPageParameters.getString(java.lang.String)

getString

@Nullable
public String getString(String name,
                                  String df)

Description copied from interface: IPageParameters

Gets the value for the specified parametername as a String object. When multiple value exists for the specified parameter, a MultipleParameterException is thrown. When the parameter does not exist, the specified default value is returned.

Specified by:

getString in interface IPageParameters

Returns:

the value as a String

See Also:

IPageParameters.getString(java.lang.String, java.lang.String)

getStringArray

@Nonnull
public String[] getStringArray(@Nonnull
                                        String name)

Description copied from interface: IPageParameters

Gets the value for the specified parametername as a String array. When the parameter does not exist, a MissingParameterException is thrown. This method is provided for legacy reasons only. The domui framework discourages uses of parameter arrays.

Specified by:

getStringArray in interface IPageParameters

Returns:

the value as a String

See Also:

IPageParameters.getStringArray(java.lang.String)

getStringArray

@Nullable
public String[] getStringArray(@Nonnull
                                         String name,
                                         @Nullable
                                         String[] deflt)

Specified by:

getStringArray in interface IPageParameters

See Also:

IPageParameters.getStringArray(java.lang.String, java.lang.String[])

getObject

@Nullable
public Object getObject(String name)

Gets the value for the specified parameter name as untyped value. It is used internally for generic copying of params form one PageParameter to another.

Parameters:

name -

Returns:

putObject

public void putObject(@Nonnull
                      String name,
                      @Nullable
                      Object value)

createFrom

@Nonnull
public static PageParameters createFrom(IRequestContext ctx)

Create this from an actual request. This does not add any parameter that starts with _ or $.

Parameters:

c -

Returns:

createFromEncodedUrlString

@Nonnull
public static PageParameters createFromEncodedUrlString(@Nonnull
                                                                 String paramsAsString)

Create this from an string representation of params. This is used as utility for manipulation of data that stores params as strings.

Parameters:

paramsAsString -

Returns:

toString

public String toString()

Overrides:

toString in class Object

getParameterNames

@Nonnull
public String[] getParameterNames()

Description copied from interface: IPageParameters

Gets all the names of the parameters this object is holding

Specified by:

getParameterNames in interface IPageParameters

Returns:

the parameter names in an array

See Also:

IPageParameters.getParameterNames()

equals

public boolean equals(Object obj)

Description copied from interface: IPageParameters

Compare this with another instance. Used to see that a new request has different parameters than an earlier request.

remark

We check the size of the maps; if they are equal we ONLY have to check that each key-value pair in SOURCE exists in TARGET AND is the same. We don't need to check for "thingies in SRC that do not occur in TGT" because that cannot happen if the map sizes are equal.

Specified by:

equals in interface IPageParameters

Overrides:

equals in class Object

See Also:

IPageParameters.equals(java.lang.Object)

hashCode

public int hashCode()

Specified by:

hashCode in interface IPageParameters

Overrides:

hashCode in class Object

See Also:

IPageParameters.hashCode()

applyChanges

public static void applyChanges(PageParameters source,
                                PageParameters changes)

Apply changes to source. New values found in changes would be added to source, changed values found in changes would replace values in source. Params that are not found in changes would remian unchanged in source. So, this utility can not be used to remove items from source.

Parameters:

source -

changes -

calculateHashString

@Nonnull
public String calculateHashString()

Description copied from interface: IPageParameters

EXPENSIVE Hash all parameter values into an MD5 hash. This must be repeatable so same parameters get the same hash code.

Specified by:

calculateHashString in interface IPageParameters

Returns:

See Also:

IPageParameters.calculateHashString()

getDataLength

public int getDataLength()

Description copied from interface: IPageParameters

Return the number of characters that this would take on an url.

Specified by:

getDataLength in interface IPageParameters

Returns:

See Also:

IPageParameters.getDataLength()

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface IPageParameters

decodeParameters

@Nonnull
public static PageParameters decodeParameters(@Nullable
                                                       String query)

Decode a http query string into a PageParameters instance.

Parameters:

query -

Returns: