net.sf.jasperreports.engine.JRAbstractScriptlet Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation
Show all versions of jasperreports Show documentation
Free Java Reporting Library
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2019 TIBCO Software Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JasperReports is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see parametersMap;
protected Map fieldsMap;
protected Map variablesMap;
protected JRFillGroup[] groups;
/**
*
*/
public JRAbstractScriptlet()
{
}
/**
*
*/
public void setData(JRFillDataset dataset)
{
this.dataset = dataset;
setData( // keep this deprecated method call here just in case it was overridden in scriptlet implementations
dataset.getParametersMap(),
dataset.getFieldsMap(),
dataset.getVariablesMap(),
(JRFillGroup[])dataset.getGroups()
);
}
/**
* @deprecated Replaced by {@link #setData(JRFillDataset)}.
*/
public void setData(
Map parsm,
Map fldsm,
Map varsm,
JRFillGroup[] grps
)
{
parametersMap = parsm;
fieldsMap = fldsm;
variablesMap = varsm;
groups = grps;
}
/**
*
*/
public Object getParameterValue(String parameterName) throws JRScriptletException
{
return getParameterValue(parameterName, true);
}
/**
*
*/
public Object getParameterValue(String parameterName, boolean mustBeDeclared) throws JRScriptletException
{
JRFillParameter parameter = this.parametersMap.get(parameterName);
if (parameter == null)
{
if (mustBeDeclared)
{
throw
new JRScriptletException(
EXCEPTION_MESSAGE_KEY_PARAMETER_NOT_FOUND,
new Object[]{parameterName});
}
return ((Map)this.parametersMap.get(JRParameter.REPORT_PARAMETERS_MAP).getValue()).get(parameterName);
}
return parameter.getValue();
}
/**
*
*/
public Object getFieldValue(String fieldName) throws JRScriptletException
{
JRFillField field = fieldsMap == null ? null : fieldsMap.get(fieldName);
if (field == null)
{
throw
new JRScriptletException(
EXCEPTION_MESSAGE_KEY_FIELD_NOT_FOUND,
new Object[]{fieldName});
}
return field.getValue();
}
/**
*
*/
public Object getVariableValue(String variableName) throws JRScriptletException
{
JRFillVariable variable = this.variablesMap.get(variableName);
if (variable == null)
{
throw
new JRScriptletException(
EXCEPTION_MESSAGE_KEY_VARIABLE_NOT_FOUND,
new Object[]{variableName});
}
return variable.getValue();
}
/**
*
*/
public void setVariableValue(String variableName, Object value) throws JRScriptletException
{
JRFillVariable variable = this.variablesMap.get(variableName);
if (variable == null)
{
throw
new JRScriptletException(
EXCEPTION_MESSAGE_KEY_VARIABLE_NOT_FOUND,
new Object[]{variableName});
}
if (value != null && !variable.getValueClass().isInstance(value) )
{
throw
new JRScriptletException(
EXCEPTION_MESSAGE_KEY_VARIABLE_VALUE_INCOMPATIBLE,
new Object[]{variableName, variable.getValueClassName()});
}
variable.setValue(value);
}
/**
*
*/
public void callBeforeReportInit() throws JRScriptletException
{
this.beforeReportInit();
this.beforePageInit();
this.beforeColumnInit();
if(groups != null && groups.length > 0)
{
for(int i = 0; i < groups.length; i++)
{
this.beforeGroupInit( groups[i].getName() );
}
}
}
/**
*
*/
public void callAfterReportInit() throws JRScriptletException
{
if(groups != null && groups.length > 0)
{
for(int i = groups.length - 1; i >= 0; i--)
{
this.afterGroupInit( groups[i].getName() );
}
}
this.afterColumnInit();
this.afterPageInit();
this.afterReportInit();
}
/**
*
*/
public void callBeforePageInit() throws JRScriptletException
{
this.beforePageInit();
this.beforeColumnInit();
}
/**
*
*/
public void callAfterPageInit() throws JRScriptletException
{
this.afterColumnInit();
this.afterPageInit();
}
/**
*
*/
public void callBeforeColumnInit() throws JRScriptletException
{
this.beforeColumnInit();
}
/**
*
*/
public void callAfterColumnInit() throws JRScriptletException
{
this.afterColumnInit();
}
/**
*
*/
public void callBeforeGroupInit() throws JRScriptletException
{
if(groups != null && groups.length > 0)
{
JRFillGroup group = null;
for(int i = 0; i < groups.length; i++)
{
group = groups[i];
if (group.hasChanged())
{
this.beforeGroupInit(group.getName());
}
}
}
}
/**
*
*/
public void callAfterGroupInit() throws JRScriptletException
{
if(groups != null && groups.length > 0)
{
JRFillGroup group = null;
for(int i = groups.length - 1; i >= 0; i--)
{
group = groups[i];
if (group.hasChanged())
{
this.afterGroupInit(group.getName());
}
}
}
}
/**
*
*/
public void callBeforeDetailEval() throws JRScriptletException
{
this.beforeDetailEval();
}
/**
*
*/
public void callAfterDetailEval() throws JRScriptletException
{
this.afterDetailEval();
}
/**
* Called before the report is initialized.
*/
public abstract void beforeReportInit() throws JRScriptletException;
/**
* Called after the report is initialized.
*/
public abstract void afterReportInit() throws JRScriptletException;
/**
* Called before each page is initialized.
*/
public abstract void beforePageInit() throws JRScriptletException;
/**
* Called after each page is initialized.
*/
public abstract void afterPageInit() throws JRScriptletException;
/**
* Called before each column is initialized.
*/
public abstract void beforeColumnInit() throws JRScriptletException;
/**
* Called after each column is initialized.
*/
public abstract void afterColumnInit() throws JRScriptletException;
/**
* Called before a group is initialized.
* @param groupName the group name
*/
public abstract void beforeGroupInit(String groupName) throws JRScriptletException;
/**
* Called after a group is initialized.
* @param groupName the group name
*/
public abstract void afterGroupInit(String groupName) throws JRScriptletException;
/**
* Called before evaluating each detail.
*/
public abstract void beforeDetailEval() throws JRScriptletException;
/**
* Called after evaluating each detail.
*/
public abstract void afterDetailEval() throws JRScriptletException;
}