Class JRDesignDatasetRun
java.lang.Object
net.sf.jasperreports.engine.base.JRBaseDatasetRun
net.sf.jasperreports.engine.design.JRDesignDatasetRun
- All Implemented Interfaces:
Serializable,Cloneable,JRChangeEventsSupport,JRCloneable,JRDatasetRun,JRIdentifiable,JRPropertiesHolder
Implementation of
JRDatasetRun to be used for report design.- Author:
- Lucian Chirita (lucianc@users.sourceforge.net)
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringFields inherited from class net.sf.jasperreports.engine.base.JRBaseDatasetRun
connectionExpression, datasetName, dataSourceExpression, parameters, parametersMapExpression, propertiesMap, returnValues, uuid -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddParameter(JRDatasetParameter parameter) Adds a parameter value.voidaddReturnValue(ReturnValue returnValue) Adds a return value to the subdataset run.clone()Returns the property change support object for this instance.Returns the list of parameter values.Returns the list of values to be copied from the subdataset run into the main dataset.removeParameter(String parameterName) Removes a parameter value.removeParameter(JRDatasetParameter parameter) Removes a parameter value.booleanremoveReturnValue(ReturnValue returnValue) Removes a return value from the subdataset run.voidsetConnectionExpression(JRExpression connectionExpression) Sets the connection expression.voidsetDatasetName(String datasetName) Sets the sub dataset name.voidsetDataSourceExpression(JRExpression dataSourceExpression) Sets the data source expression.voidsetParametersMapExpression(JRExpression parametersMapExpression) Sets the parameters map expression.voidMethods inherited from class net.sf.jasperreports.engine.base.JRBaseDatasetRun
getConnectionExpression, getDatasetName, getDataSourceExpression, getParametersMapExpression, getParentProperties, getPropertiesMap, getReturnValues, getUUID, hasProperties
-
Field Details
-
EXCEPTION_MESSAGE_KEY_DUPLICATE_PARAMETER
- See Also:
-
PROPERTY_CONNECTION_EXPRESSION
- See Also:
-
PROPERTY_DATASET_NAME
- See Also:
-
PROPERTY_DATA_SOURCE_EXPRESSION
- See Also:
-
PROPERTY_PARAMETERS_MAP_EXPRESSION
- See Also:
-
PROPERTY_PARAMETERS
- See Also:
-
PROPERTY_RETURN_VALUES
- See Also:
-
-
Constructor Details
-
JRDesignDatasetRun
public JRDesignDatasetRun()Creates an empty dataset instantiation.
-
-
Method Details
-
addParameter
Adds a parameter value.- Parameters:
parameter- the parameter value- Throws:
JRException- See Also:
-
removeParameter
Removes a parameter value.- Parameters:
parameterName- the parameter name- Returns:
- the removed parameter value
-
removeParameter
Removes a parameter value.- Parameters:
parameter- the parameter value- Returns:
- the parameter value
-
setConnectionExpression
Sets the connection expression.- Parameters:
connectionExpression- the connection expression- See Also:
-
setDatasetName
Sets the sub dataset name.- Parameters:
datasetName- the sub dataset name- See Also:
-
setDataSourceExpression
Sets the data source expression.- Parameters:
dataSourceExpression- the data source expression- See Also:
-
setParametersMapExpression
Sets the parameters map expression.- Parameters:
parametersMapExpression- the parameters map expression- See Also:
-
getParameters
Description copied from interface:JRDatasetRunReturns the list of parameter values.- Specified by:
getParametersin interfaceJRDatasetRun- Overrides:
getParametersin classJRBaseDatasetRun- Returns:
- the list of parameter values
-
setUUID
-
addReturnValue
Adds a return value to the subdataset run.- Parameters:
returnValue- the return value to be added.
-
getReturnValuesList
Returns the list of values to be copied from the subdataset run into the main dataset.- Returns:
- list of
ReturnValueobjects
-
removeReturnValue
Removes a return value from the subdataset run.- Parameters:
returnValue- the return value to be removed- Returns:
trueif the return value was found and removed
-
clone
- Specified by:
clonein interfaceJRCloneable- Overrides:
clonein classJRBaseDatasetRun
-
getEventSupport
Description copied from interface:JRChangeEventsSupportReturns the property change support object for this instance.- Specified by:
getEventSupportin interfaceJRChangeEventsSupport- Returns:
- the property change support object for this instance
-