net.sf.jasperreports.engine.query.XalanXPathQueryExecuter 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 .
*/
package net.sf.jasperreports.engine.query;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.TimeZone;
import javax.xml.parsers.DocumentBuilderFactory;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.w3c.dom.Document;
import net.sf.jasperreports.engine.JRDataSource;
import net.sf.jasperreports.engine.JRDataset;
import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JRPropertiesUtil;
import net.sf.jasperreports.engine.JRPropertiesUtil.PropertySuffix;
import net.sf.jasperreports.engine.JRValueParameter;
import net.sf.jasperreports.engine.JasperReportsContext;
import net.sf.jasperreports.engine.data.XalanXmlDataSource;
/**
* Xalan XPath query executer implementation.
*
* The XPath query of the report is executed against the document specified by the
* {@link net.sf.jasperreports.engine.query.XalanXPathQueryExecuterFactory#PARAMETER_XML_DATA_DOCUMENT PARAMETER_XML_DATA_DOCUMENT}
* parameter.
*
* All the parameters in the XPath query are replaced by calling String.valueOf(Object)
* on the parameter value.
*
* @author Narcis Marcu ([email protected])
*/
public class XalanXPathQueryExecuter extends JRAbstractQueryExecuter
{
private static final Log log = LogFactory.getLog(XalanXPathQueryExecuter.class);
private final Document document;
private final DocumentBuilderFactory documentBuilderFactory;
private Map namespacesMap;
/**
*
*/
public XalanXPathQueryExecuter(
JasperReportsContext jasperReportsContext,
JRDataset dataset,
Map parametersMap
)
{
this(SimpleQueryExecutionContext.of(jasperReportsContext), dataset, parametersMap);
}
/**
*
*/
public XalanXPathQueryExecuter(
QueryExecutionContext context,
JRDataset dataset,
Map parametersMap
)
{
super(context, dataset, parametersMap);
document = (Document) getParameterValue(XalanXPathQueryExecuterFactory.PARAMETER_XML_DATA_DOCUMENT);
documentBuilderFactory = (DocumentBuilderFactory) getParameterValue(
XalanXPathQueryExecuterFactory.PARAMETER_DOCUMENT_BUILDER_FACTORY, true);
namespacesMap = (Map) getParameterValue(
XalanXPathQueryExecuterFactory.PARAMETER_XML_NAMESPACE_MAP, true);
if (document == null)
{
log.warn("The supplied org.w3c.dom.Document object is null.");
}
parseQuery();
}
@Override
protected String getCanonicalQueryLanguage()
{
return JRXPathQueryExecuter.CANONICAL_LANGUAGE;
}
@Override
protected String getParameterReplacement(String parameterName)
{
return String.valueOf(getParameterValue(parameterName));
}
@Override
public JRDataSource createDatasource() throws JRException
{
XalanXmlDataSource datasource = null;
String xPath = getQueryString();
if (log.isDebugEnabled())
{
log.debug("XPath query: " + xPath);
}
if (document != null && xPath != null)
{
if (namespacesMap == null)
{
namespacesMap = extractXmlNamespacesFromProperties();
}
datasource = new XalanXmlDataSource(document, xPath);
datasource.setXmlNamespaceMap(namespacesMap);
datasource.setDetectXmlNamespaces(getBooleanParameterOrProperty(XalanXPathQueryExecuterFactory.XML_DETECT_NAMESPACES, false));
datasource.setDocumentBuilderFactory(documentBuilderFactory);
datasource.setLocale((Locale)getParameterValue(XalanXPathQueryExecuterFactory.XML_LOCALE, true));
datasource.setDatePattern(getStringParameter(XalanXPathQueryExecuterFactory.XML_DATE_PATTERN, XalanXPathQueryExecuterFactory.PROPERTY_XML_DATE_PATTERN));
datasource.setNumberPattern(getStringParameter(XalanXPathQueryExecuterFactory.XML_NUMBER_PATTERN, XalanXPathQueryExecuterFactory.PROPERTY_XML_NUMBER_PATTERN));
datasource.setTimeZone((TimeZone)getParameterValue(XalanXPathQueryExecuterFactory.XML_TIME_ZONE, true));
}
return datasource;
}
@Override
public void close()
{
//nothing to do
}
@Override
public boolean cancelQuery() throws JRException
{
//nothing to cancel
return false;
}
private Map extractXmlNamespacesFromProperties() throws JRException
{
Map namespaces = new HashMap();
String xmlnsPrefix = XalanXPathQueryExecuterFactory.XML_NAMESPACE_PREFIX;
List nsProperties = JRPropertiesUtil.getProperties(dataset, xmlnsPrefix);
for (int i=0; i < nsProperties.size(); ++i)
{
PropertySuffix prop = nsProperties.get(i);
String nsPrefix = prop.getKey().substring(xmlnsPrefix.length());
if (nsPrefix.length() > 0)
{
namespaces.put(nsPrefix, prop.getValue());
}
}
return namespaces.size()>0 ? namespaces : null;
}
}