Package net.sf.jasperreports.engine.base

Class JRBaseParameter

java.lang.Object

net.sf.jasperreports.engine.base.JRBaseParameter

All Implemented Interfaces:

Serializable, Cloneable, JRChangeEventsSupport, JRCloneable, JRParameter, JRPropertiesHolder

Direct Known Subclasses:

JRBaseCrosstabParameter, JRDesignParameter

public class JRBaseParameter
extends Object
implements JRParameter, Serializable, JRChangeEventsSupport

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected JRExpression	defaultValueExpression
protected String	description
protected ParameterEvaluationTimeEnum	evaluationTime
protected boolean	isForPrompting
protected boolean	isSystemDefined
protected String	name
protected Class<?>	nestedType
protected String	nestedTypeName
protected JRPropertiesMap	propertiesMap
static final String	PROPERTY_DESCRIPTION
protected Class<?>	valueClass
protected String	valueClassName
protected String	valueClassRealName

Fields inherited from interface net.sf.jasperreports.engine.JRParameter

FILTER, IS_IGNORE_PAGINATION, JASPER_REPORT, JASPER_REPORTS_CONTEXT, MAX_PAGE_HEIGHT, MAX_PAGE_WIDTH, REPORT_CLASS_LOADER, REPORT_CONNECTION, REPORT_CONTEXT, REPORT_DATA_SOURCE, REPORT_FORMAT_FACTORY, REPORT_LOCALE, REPORT_MAX_COUNT, REPORT_PARAMETERS_MAP, REPORT_RESOURCE_BUNDLE, REPORT_SCRIPTLET, REPORT_TEMPLATES, REPORT_TIME_ZONE, REPORT_VIRTUALIZER, REPOSITORY_CONTEXT, SORT_FIELDS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JRBaseParameter()
protected	JRBaseParameter(JRParameter parameter, JRBaseObjectFactory factory)

Method Summary

Modifier and Type	Method	Description
Object	clone()
JRExpression	getDefaultValueExpression()
String	getDescription()
ParameterEvaluationTimeEnum	getEvaluationTime()	Specifies when the default value expression of a parameter is evaluated.
JRPropertyChangeSupport	getEventSupport()	Returns the property change support object for this instance.
String	getName()
Class<?>	getNestedType()	Returns the parameter nested value type.
String	getNestedTypeName()	Returns the name of the parameter nested value type.
JRPropertiesHolder	getParentProperties()	Returns the parent properties holder, whose properties are used as defaults for this object.
JRPropertiesMap	getPropertiesMap()	Returns this object's properties map.
Class<?>	getValueClass()
String	getValueClassName()
boolean	hasProperties()	Checks whether the object has any properties.
boolean	isForPrompting()
boolean	isSystemDefined()
void	setDescription(String description)

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY_DESCRIPTION

public static final String PROPERTY_DESCRIPTION

See Also:

• Constant Field Values

name

protected String name

description

protected String description

valueClassName

protected String valueClassName

valueClassRealName

protected String valueClassRealName

nestedTypeName

protected String nestedTypeName

isSystemDefined

protected boolean isSystemDefined

isForPrompting

protected boolean isForPrompting

evaluationTime

protected ParameterEvaluationTimeEnum evaluationTime

valueClass

protected transient Class<?> valueClass

nestedType

protected transient Class<?> nestedType

defaultValueExpression

protected JRExpression defaultValueExpression

propertiesMap

protected JRPropertiesMap propertiesMap

Constructor Details

JRBaseParameter

protected JRBaseParameter()

JRBaseParameter

protected JRBaseParameter(JRParameter parameter,
 JRBaseObjectFactory factory)

Method Details

getName

public String getName()

Specified by:

getName in interface JRParameter

getDescription

public String getDescription()

Specified by:

getDescription in interface JRParameter

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface JRParameter

getValueClass

public Class<?> getValueClass()

Specified by:

getValueClass in interface JRParameter

getValueClassName

public String getValueClassName()

Specified by:

getValueClassName in interface JRParameter

getNestedType

public Class<?> getNestedType()

Description copied from interface: JRParameter

Returns the parameter nested value type.

The parameter nested value type is used when the parameter value class is not sufficient in determining the expected type of the parameter values. The most common such scenario is when the parameter value class is Collection or a derived class, in which case the nested type specifies the type of values which are to be placed inside the collection.

Specified by:

getNestedType in interface JRParameter

Returns:

the nested value type for this parameter, or null if none set

See Also:

• JRParameter.getValueClass()

getNestedTypeName

public String getNestedTypeName()

Description copied from interface: JRParameter

Returns the name of the parameter nested value type.

Specified by:

getNestedTypeName in interface JRParameter

Returns:

the name of the nested value type for this parameter, or null if none set

See Also:

• JRParameter.getNestedType()

isSystemDefined

public boolean isSystemDefined()

Specified by:

isSystemDefined in interface JRParameter

isForPrompting

public boolean isForPrompting()

Specified by:

isForPrompting in interface JRParameter

getEvaluationTime

public ParameterEvaluationTimeEnum getEvaluationTime()

Description copied from interface: JRParameter

Specifies when the default value expression of a parameter is evaluated.

Specified by:

getEvaluationTime in interface JRParameter

getDefaultValueExpression

public JRExpression getDefaultValueExpression()

Specified by:

getDefaultValueExpression in interface JRParameter

hasProperties

public boolean hasProperties()

Description copied from interface: JRPropertiesHolder

Checks whether the object has any properties.

Specified by:

hasProperties in interface JRPropertiesHolder

Returns:

whether the object has any properties

getPropertiesMap

public JRPropertiesMap getPropertiesMap()

Description copied from interface: JRPropertiesHolder

Returns this object's properties map.

Specified by:

getPropertiesMap in interface JRPropertiesHolder

Returns:

this object's properties map

getParentProperties

public JRPropertiesHolder getParentProperties()

Description copied from interface: JRPropertiesHolder

Returns the parent properties holder, whose properties are used as defaults for this object.

Specified by:

getParentProperties in interface JRPropertiesHolder

Returns:

the parent properties holder, or null if no parent

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class Object

getEventSupport

public JRPropertyChangeSupport getEventSupport()

Description copied from interface: JRChangeEventsSupport

Returns the property change support object for this instance.

Specified by:

getEventSupport in interface JRChangeEventsSupport

Returns:

the property change support object for this instance