net.sf.jasperreports.engine.design.JRDesignSubreport 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 - 2022 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 = new LinkedHashMap<>();
/**
* Values to be copied from the subreport into the master report.
*/
protected List returnValues = new ArrayList<>();
/**
*
*/
protected JRExpression parametersMapExpression;
protected JRExpression connectionExpression;
protected JRExpression dataSourceExpression;
protected JRExpression expression;
/**
*
*/
public JRDesignSubreport(JRDefaultStyleProvider defaultStyleProvider)
{
super(defaultStyleProvider);
}
@Override
public ModeEnum getModeValue()
{
return getStyleResolver().getMode(this, ModeEnum.TRANSPARENT);
}
@Override
public JRExpression getParametersMapExpression()
{
return this.parametersMapExpression;
}
/**
*
*/
public void setParametersMapExpression(JRExpression parametersMapExpression)
{
Object old = this.parametersMapExpression;
this.parametersMapExpression = parametersMapExpression;
getEventSupport().firePropertyChange(PROPERTY_PARAMETERS_MAP_EXPRESSION, old, this.parametersMapExpression);
}
@Override
public JRSubreportParameter[] getParameters()
{
JRSubreportParameter[] parametersArray = new JRSubreportParameter[parametersMap.size()];
parametersMap.values().toArray(parametersArray);
return parametersArray;
}
/**
*
*/
public Map getParametersMap()
{
return this.parametersMap;
}
/**
*
*/
public void addParameter(JRSubreportParameter subreportParameter) throws JRException
{
if (this.parametersMap.containsKey(subreportParameter.getName()))
{
throw
new JRException(
EXCEPTION_MESSAGE_KEY_DUPLICATE_PARAMETER,
new Object[]{subreportParameter.getName()});
}
this.parametersMap.put(subreportParameter.getName(), subreportParameter);
getEventSupport().fireCollectionElementAddedEvent(PROPERTY_PARAMETERS,
subreportParameter, parametersMap.size() - 1);
}
/**
*
*/
public JRSubreportParameter removeParameter(String name)
{
JRSubreportParameter removed = this.parametersMap.remove(name);
if (removed != null)
{
getEventSupport().fireCollectionElementRemovedEvent(PROPERTY_PARAMETERS, removed, -1);
}
return removed;
}
@Override
public JRExpression getConnectionExpression()
{
return this.connectionExpression;
}
/**
*
*/
public void setConnectionExpression(JRExpression connectionExpression)
{
Object old = this.connectionExpression;
this.connectionExpression = connectionExpression;
if (this.connectionExpression != null)
{
setDataSourceExpression(null);
}
getEventSupport().firePropertyChange(PROPERTY_CONNECTION_EXPRESSION, old, this.connectionExpression);
}
@Override
public JRExpression getDataSourceExpression()
{
return this.dataSourceExpression;
}
/**
*
*/
public void setDataSourceExpression(JRExpression dataSourceExpression)
{
Object old = this.dataSourceExpression;
this.dataSourceExpression = dataSourceExpression;
if (this.dataSourceExpression != null)
{
setConnectionExpression(null);
}
getEventSupport().firePropertyChange(PROPERTY_DATASOURCE_EXPRESSION, old, this.dataSourceExpression);
}
@Override
public JRExpression getExpression()
{
return this.expression;
}
/**
*
*/
public void setExpression(JRExpression expression)
{
Object old = this.expression;
this.expression = expression;
getEventSupport().firePropertyChange(PROPERTY_EXPRESSION, old, this.expression);
}
@Override
public void collectExpressions(JRExpressionCollector collector)
{
collector.collect(this);
}
@Override
public void visit(JRVisitor visitor)
{
visitor.visitSubreport(this);
}
/**
* Adds a return value to the subreport.
*
* @param returnValue the return value to be added.
*/
public void addReturnValue(JRSubreportReturnValue returnValue)
{
this.returnValues.add(returnValue);
getEventSupport().fireCollectionElementAddedEvent(PROPERTY_RETURN_VALUES,
returnValue, returnValues.size() - 1);
}
/**
* Returns the list of values to be copied from the subreport into the master.
*
* @return the list of values to be copied from the subreport into the master.
*/
@Override
public JRSubreportReturnValue[] getReturnValues()
{
JRSubreportReturnValue[] returnValuesArray = new JRSubreportReturnValue[returnValues.size()];
returnValues.toArray(returnValuesArray);
return returnValuesArray;
}
/**
* Returns the list of values to be copied from the subreport into the master.
*
* @return list of {@link JRSubreportReturnValue JRSubreportReturnValue} objects
*/
public List getReturnValuesList()
{
return returnValues;
}
/**
* Removes a return value from the subreport.
*
* @param returnValue the return value to be removed
* @return true if the return value was found and removed
*/
public boolean removeReturnValue(JRSubreportReturnValue returnValue)
{
int idx = this.returnValues.indexOf(returnValue);
if (idx >= 0)
{
this.returnValues.remove(idx);
getEventSupport().fireCollectionElementRemovedEvent(PROPERTY_RETURN_VALUES, returnValue, idx);
return true;
}
return false;
}
@Override
public Boolean getUsingCache()
{
return isUsingCache;
}
@Override
public void setUsingCache(Boolean isUsingCache)
{
Object old = this.isUsingCache;
this.isUsingCache = isUsingCache;
getEventSupport().firePropertyChange(JRBaseSubreport.PROPERTY_USING_CACHE, old, this.isUsingCache);
}
@Override
public Boolean isRunToBottom()
{
return runToBottom;
}
@Override
public void setRunToBottom(Boolean runToBottom)
{
Object old = this.runToBottom;
this.runToBottom = runToBottom;
getEventSupport().firePropertyChange(JRBaseSubreport.PROPERTY_RUN_TO_BOTTOM, old, this.runToBottom);
}
@Override
public OverflowType getOverflowType()
{
return overflowType;
}
@Override
public void setOverflowType(OverflowType overflowType)
{
Object old = this.overflowType;
this.overflowType = overflowType;
getEventSupport().firePropertyChange(JRBaseSubreport.PROPERTY_OVERFLOW_TYPE, old, this.overflowType);
}
@Override
public Object clone()
{
JRDesignSubreport clone = (JRDesignSubreport)super.clone();
if (parametersMap != null)
{
clone.parametersMap = new LinkedHashMap<>();
for(Iterator it = parametersMap.keySet().iterator(); it.hasNext();)
{
String name = it.next();
clone.parametersMap.put(name, JRCloneUtils.nullSafeClone(parametersMap.get(name)));
}
}
clone.returnValues = JRCloneUtils.cloneList(returnValues);
clone.parametersMapExpression = JRCloneUtils.nullSafeClone(parametersMapExpression);
clone.connectionExpression = JRCloneUtils.nullSafeClone(connectionExpression);
clone.dataSourceExpression = JRCloneUtils.nullSafeClone(dataSourceExpression);
clone.expression = JRCloneUtils.nullSafeClone(expression);
return clone;
}
}