com.elasticpath.cmweb.reportservice.impl
Class ReportParameter

java.lang.Object
  com.elasticpath.cmweb.reportservice.impl.ReportParameter

All Implemented Interfaces:

java.io.Serializable

public class ReportParameter
extends java.lang.Object
implements java.io.Serializable

Class to deal w/ input box creation and validation of birt report parameters. Currently select list data is held in it's own Map since this whole class should be serializable to be stored in the session.

See Also:

Serialized Form

Constructor Summary

ReportParameter(org.eclipse.birt.report.engine.api.IScalarParameterDefn param, org.eclipse.birt.report.model.api.ScalarParameterHandle handle, java.util.Collection selections)
Constructor that takes a IScalarParameterDefn and ScalarParameterHandle.

Method Summary

void	appendDateInput(java.lang.StringBuffer buffer) Append date input if this parameter is a date.
java.lang.String	getDefaultValue() Return default string value.
java.lang.String	getHtmlInput() Returns html input for this input type.
java.lang.String	getName() Returns parameter name.
java.lang.String	getPrompt() Returns prompt + * if a it's a required param.
java.lang.String	getTypeDesc() Returns type desc and error message if parameter is invalid.
java.lang.Object	getValidValue() Returns a typed, validated object.
void	setStringValue(java.lang.String newValue) Sets string value from user input.
boolean	validate(java.util.List requiredList, java.util.List invalidList) Validates stringValue depending on parameter type.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportParameter

public ReportParameter(org.eclipse.birt.report.engine.api.IScalarParameterDefn param,
                       org.eclipse.birt.report.model.api.ScalarParameterHandle handle,
                       java.util.Collection selections)

Constructor that takes a IScalarParameterDefn and ScalarParameterHandle.

Parameters:

param - birt parameter.

handle - birt parameter handle.

selections - collection of select-list values.

Method Detail

appendDateInput

public void appendDateInput(java.lang.StringBuffer buffer)

Append date input if this parameter is a date.

Parameters:

buffer - buffer to append to.

getDefaultValue

public java.lang.String getDefaultValue()

Return default string value.

Returns:

default string value.

getHtmlInput

public java.lang.String getHtmlInput()

Returns html input for this input type.

Returns:

html input.

getName

public java.lang.String getName()

Returns parameter name.

Returns:

parameter name.

getPrompt

public java.lang.String getPrompt()

Returns prompt + * if a it's a required param.

Returns:

prompt.

getTypeDesc

public java.lang.String getTypeDesc()

Returns type desc and error message if parameter is invalid.

Returns:

type description.

getValidValue

public java.lang.Object getValidValue()

Returns a typed, validated object.

Returns:

validated object.

setStringValue

public final void setStringValue(java.lang.String newValue)

Sets string value from user input.

Parameters:

newValue - new string value.

validate

public boolean validate(java.util.List requiredList,
                        java.util.List invalidList)

Validates stringValue depending on parameter type. Boolean types must be declared optional in report designer.

Parameters:

requiredList - will add to list if this is a required parameter but value is empty

invalidList - will add to list if this is value is invalid

Returns:

true or false depending on value validity.