org.eclipse.birt.report.context.ScalarParameterBean Maven / Gradle / Ivy
Show all versions of viewservlets Show documentation
/*************************************************************************************
* Copyright (c) 2004 Actuate Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Actuate Corporation - Initial implementation.
************************************************************************************/
package org.eclipse.birt.report.context;
import java.util.Collections;
import java.util.List;
import java.util.Vector;
import org.eclipse.birt.report.service.api.ParameterDefinition;
import org.eclipse.birt.report.utility.ParameterAccessor;
/**
* Parameter bean object used by parameter related jsp pages. It carries the
* data shared between front-end jsp page and back-end fragment class. In
* current implementation, ScalarParameterBean uses request scope.
*
*/
public class ScalarParameterBean extends ParameterAttributeBean
{
/**
* Parameter definition reference.
*/
private ParameterDefinition parameter = null;
/**
* Is parameter value required.
*/
private boolean isRequired = false;
/**
* Current parameter value.
*/
private String value = null;
/**
* Current parameter value list.
*/
private List valueList = null;
/**
* Display text for current parameter
*/
private String displayText;
/**
* Selection item list. Label is HTML encoded.
*/
private Vector selectionList = new Vector( );
/**
* Whether current value is in the selection list.
*/
private boolean valueInList = true;
/**
* Current parameter default value.
*/
private String defaultValue = null;
/**
* Default values, if multiple.
*/
private List defaultValues = null;
/**
* Display text of current default value.
*/
private String defaultDisplayText = null;
/**
* If it is cascade parameter.
*/
private boolean isCascade = false;
/**
* If default value is in the selection list
*/
private boolean defaultValueInList = false;
/**
* If display text is in request
*/
private boolean displayTextInReq = false;
/**
* If display text is in list
*/
private boolean displayTextInList = false;
/**
* Constructor.
*
* @param parameter
*/
public ScalarParameterBean( ParameterDefinition parameter )
{
this.parameter = parameter;
}
/**
* Adapt to IScalarParameterDefn's allowNull( ).
*
* @deprecated
* @return whether parameter value allows null.
*/
public boolean allowNull( )
{
if ( parameter == null )
{
return false;
}
return parameter.allowNull( );
}
/**
* Adapt to IScalarParameterDefn's allowBlank( ).
*
* @deprecated
* @return whether parameter value allows blank.
*/
public boolean allowBlank( )
{
if ( parameter == null )
{
return true;
}
return parameter.allowBlank( );
}
/**
* Adapt to IScalarParameterDefn's allowNewValues( ).
*
* @return whether parameter selection list allows new value.
*/
public boolean allowNewValues( )
{
if ( parameter == null )
{
return false;
}
return !parameter.mustMatch( );
}
/**
* Adapt to IScalarParameterDefn's isValueConcealed( ).
*
* @return whether parameter value is concealed.
*/
public boolean isValueConcealed( )
{
if ( parameter == null )
{
return false;
}
return parameter.concealValue( );
}
/**
* Adapt to IScalarParameterDefn's getName( ).
*
* @return parameter name.
*/
public String getName( )
{
if ( parameter == null )
{
return null;
}
return parameter.getName( );
}
/**
* Adapt to IScalarParameterDefn's getHelpText( ).
*
* @return parameter help text.
*/
public String getToolTip( )
{
String toolTip = ""; //$NON-NLS-1$
if ( parameter != null && parameter.getHelpText( ) != null )
{
toolTip = parameter.getHelpText( );
}
return ParameterAccessor.htmlEncode( toolTip );
}
/**
* @return Returns the isValueInList.
*/
public boolean isValueInList( )
{
return valueInList;
}
/**
* @param valueInList
* The isValueInList to set.
*/
public void setValueInList( boolean valueInList )
{
this.valueInList = valueInList;
}
/**
* @return Returns the parameter.
*/
public ParameterDefinition getParameter( )
{
return parameter;
}
/**
* @param parameter
* The parameter to set.
*/
public void setParameter( ParameterDefinition parameter )
{
this.parameter = parameter;
}
/**
* @return Returns the parameterValue.
*/
public String getValue( )
{
return value;
}
/**
* @param value
* The parameterValue to set.
*/
public void setValue( String value )
{
this.value = value;
}
/**
* @return the valueList
*/
public List getValueList( )
{
return valueList;
}
/**
* @param valueList
* the valueList to set
*/
public void setValueList( List valueList )
{
this.valueList = valueList;
}
/**
* @return the displayText
*/
public String getDisplayText( )
{
return displayText;
}
/**
* @param displayText
* the displayText to set
*/
public void setDisplayText( String displayText )
{
this.displayText = displayText;
}
/**
* @return Returns the selectionList.
*/
public Vector getSelectionList( )
{
return selectionList;
}
/**
* @param selectionList
* The selectionList to set.
*/
public void setSelectionList( Vector selectionList )
{
this.selectionList = selectionList;
}
/**
* @return Returns the isRequired.
*/
public boolean isRequired( )
{
return isRequired;
}
/**
* @param isRequired
* The isRequired to set.
*/
public void setRequired( boolean isRequired )
{
this.isRequired = isRequired;
}
/**
* @return the defaultValue
*/
public String getDefaultValue( )
{
return defaultValue;
}
/**
* @param defaultValue
* the defaultValue to set
*/
public void setDefaultValue( String defaultValue )
{
this.defaultValue = defaultValue;
}
/**
* @return the defaultValue
*/
public List getDefaultValues( )
{
return defaultValues;
}
/**
* @param defaultValue
* the defaultValue to set
*/
public void setDefaultValues( List defaultValues )
{
this.defaultValues = Collections.unmodifiableList( defaultValues );
}
/**
* @return the defaultDisplayText
*/
public String getDefaultDisplayText( )
{
return defaultDisplayText;
}
/**
* @param defaultDisplayText
* the defaultDisplayText to set
*/
public void setDefaultDisplayText( String defaultDisplayText )
{
this.defaultDisplayText = defaultDisplayText;
}
/**
* @return the isCascade
*/
public boolean isCascade( )
{
return isCascade;
}
/**
* @param isCascade
* the isCascade to set
*/
public void setCascade( boolean isCascade )
{
this.isCascade = isCascade;
}
/**
* @return the defaultValueInList
*/
public boolean isDefaultValueInList( )
{
return defaultValueInList;
}
/**
* @param defaultValueInList
* the defaultValueInList to set
*/
public void setDefaultValueInList( boolean defaultValueInList )
{
this.defaultValueInList = defaultValueInList;
}
/**
* @return the displayTextInReq
*/
public boolean isDisplayTextInReq( )
{
return displayTextInReq;
}
/**
* @param displayTextInReq
* the displayTextInReq to set
*/
public void setDisplayTextInReq( boolean displayTextInReq )
{
this.displayTextInReq = displayTextInReq;
}
/**
* @return the displayTextInList
*/
public boolean isDisplayTextInList( )
{
return displayTextInList;
}
/**
* @param displayTextInList
* the displayTextInList to set
*/
public void setDisplayTextInList( boolean displayTextInList )
{
this.displayTextInList = displayTextInList;
}
}