com.arsdigita.search.ui.filters
Class DateRangeParameter
java.lang.Object
com.arsdigita.bebop.parameters.ParameterModel
com.arsdigita.search.ui.filters.DateRangeParameter
- All Implemented Interfaces:
- Lockable
- public class DateRangeParameter
- extends ParameterModel
Method Summary |
protected Calendar |
getCalendar(javax.servlet.http.HttpServletRequest request)
This method returns a new Calendar object that is manipulated
within transformValue to create a Date Object. |
Class |
getValueClass()
Return the class that all values produced by the model will
have. |
protected Date |
transformOneDate(javax.servlet.http.HttpServletRequest request,
String prefix)
|
Object |
transformValue(javax.servlet.http.HttpServletRequest request)
Computes a date object from multiple parameters in the
request. |
Object |
unmarshal(String encoded)
Reconstruct the parameter value from an encoded string produced by
marshal . |
Methods inherited from class com.arsdigita.bebop.parameters.ParameterModel |
addParameterListener, createParameterData, createParameterData, createParameterData, getDefaultOverridesNull, getDefaultValue, getName, isLocked, isPassIn, lock, marshal, setDefaultOverridesNull, setDefaultValue, setName, setPassIn, transformSingleValue, validate |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DateRangeParameter
public DateRangeParameter(String name)
getCalendar
protected Calendar getCalendar(javax.servlet.http.HttpServletRequest request)
- This method returns a new Calendar object that is manipulated
within transformValue to create a Date Object. This method should
be overridden if you wish to use a Calendar other than the
lenient GregorianCalendar.
- Parameters:
request
- the servlet request from which Locale can be
extracted if needed
- Returns:
- a new Calendar object
transformValue
public Object transformValue(javax.servlet.http.HttpServletRequest request)
throws IllegalArgumentException
- Computes a date object from multiple parameters in the
request. This method searches for parameters named
getName() + ".year", getName() +
".month" and getName() + ".day". It sets the
fields HOUR
, MINUTE
and
SECOND
to 0, since they are by default the current
time.
- Specified by:
transformValue
in class ParameterModel
- Parameters:
request
- The HttpServletRequest of the form submission.
- Throws:
IllegalArgumentException
- if there is an
error transforming form/URL variables to an object.
transformOneDate
protected Date transformOneDate(javax.servlet.http.HttpServletRequest request,
String prefix)
throws IllegalArgumentException
- Throws:
IllegalArgumentException
unmarshal
public Object unmarshal(String encoded)
- Description copied from class:
ParameterModel
- Reconstruct the parameter value from an encoded string produced by
marshal
. This is an optional operation, which needs
to be implemented by specific subclasses; this implementation just
throws an UnsupportedOperationException
.
The contract between marshal
and
unmarshal
is that for any possible object
obj
this parameter model can produce
obj.equals(unmarshal(marshal(obj))
.
- Overrides:
unmarshal
in class ParameterModel
- Parameters:
encoded
- a string produced by marshal
- Returns:
- the object represented by
encoded
getValueClass
public Class getValueClass()
- Description copied from class:
ParameterModel
- Return the class that all values produced by the model will
have. This should be the most specific common base class of all
classes of which the model will ever produce values. This
implementation returns
Object.class
- Overrides:
getValueClass
in class ParameterModel
- Returns:
- the class that all values produced by the model will
have.
Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 21 2004:2337 UTC