/*
* This program is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
* Foundation.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
* or from the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* This program 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.
*
* Copyright (c) 2001 - 2009 Object Refinery Ltd, Pentaho Corporation and Contributors.. All rights reserved.
*/
package org.pentaho.reporting.engine.classic.core.modules.parser.bundle.layout;
import java.util.ArrayList;
import java.util.Map;
import org.pentaho.reporting.engine.classic.core.Element;
import org.pentaho.reporting.engine.classic.core.SubReport;
import org.pentaho.reporting.engine.classic.core.AttributeNames;
import org.pentaho.reporting.engine.classic.core.modules.parser.base.ReportParserUtil;
import org.pentaho.reporting.engine.classic.core.modules.parser.bundle.BundleNamespaces;
import org.pentaho.reporting.engine.classic.core.modules.parser.bundle.layout.elements.AbstractElementReadHandler;
import org.pentaho.reporting.libraries.resourceloader.FactoryParameterKey;
import org.pentaho.reporting.libraries.resourceloader.ResourceLoadingException;
import org.pentaho.reporting.libraries.xmlns.parser.ParseException;
import org.pentaho.reporting.libraries.xmlns.parser.XmlReadHandler;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
/**
* Todo: Document Me
*
* @author Thomas Morgner
*/
public class SubReportReadHandler extends AbstractElementReadHandler
{
private SubReport report;
private ArrayList outputParameters;
private ArrayList inputParameters;
public SubReportReadHandler()
{
outputParameters = new ArrayList();
inputParameters = new ArrayList();
}
/**
* Starts parsing.
*
* @param attrs the attributes.
* @throws org.xml.sax.SAXException if there is a parsing error.
*/
protected void startParsing(final Attributes attrs) throws SAXException
{
final String file = attrs.getValue(getUri(), "href");
if (file != null)
{
final Map parameters = deriveParseParameters();
parameters.put(new FactoryParameterKey(ReportParserUtil.HELPER_OBJ_REPORT_NAME), null);
parameters.put(new FactoryParameterKey
(ReportParserUtil.INCLUDE_PARSING_KEY), ReportParserUtil.INCLUDE_PARSING_VALUE);
try
{
report = (SubReport) performExternalParsing(file, SubReport.class, parameters);
}
catch (ResourceLoadingException e)
{
throw new ParseException("The specified subreport was not found or could not be loaded.", e);
}
}
else
{
throw new ParseException("Required attribute 'href' is missing.", getLocator());
}
initialize("sub-report");
super.startParsing(attrs);
// clear the href, this is used only for internal purposes ...
report.setAttribute(getUri(), "href", null);
}
protected Element createElement(final String elementType) throws ParseException
{
if (report == null)
{
throw new IllegalStateException();
}
return report;
}
/**
* Returns the handler for a child element.
*
* @param uri the URI of the namespace of the current element.
* @param tagName the tag name.
* @param atts the attributes.
* @return the handler or null, if the tagname is invalid.
* @throws SAXException if there is a parsing error.
*/
protected XmlReadHandler getHandlerForChild(final String uri,
final String tagName,
final Attributes atts) throws SAXException
{
if (BundleNamespaces.LAYOUT.equals(uri))
{
if ("output-parameter".equals(tagName))
{
final SubReportParameterReadHandler parameterReadHandler = new SubReportParameterReadHandler();
outputParameters.add(parameterReadHandler);
return parameterReadHandler;
}
if ("input-parameter".equals(tagName))
{
final SubReportParameterReadHandler parameterReadHandler = new SubReportParameterReadHandler();
inputParameters.add(parameterReadHandler);
return parameterReadHandler;
}
}
return super.getHandlerForChild(uri, tagName, atts);
}
public Element getElement()
{
return report;
}
/**
* Done parsing.
*
* @throws SAXException if there is a parsing error.
*/
protected void doneParsing() throws SAXException
{
super.doneParsing();
for (int i = 0; i < inputParameters.size(); i++)
{
final SubReportParameterReadHandler handler = (SubReportParameterReadHandler) inputParameters.get(i);
report.addInputParameter(handler.getMasterName(), handler.getDetailName());
}
for (int i = 0; i < outputParameters.size(); i++)
{
final SubReportParameterReadHandler handler = (SubReportParameterReadHandler) outputParameters.get(i);
report.addExportParameter(handler.getMasterName(), handler.getDetailName());
}
}
/**
* Returns the object for this element or null, if this element does not create an object.
*
* @return the object.
* @throws SAXException if an parser error occured.
*/
public Object getObject() throws SAXException
{
return report;
}
}