net.sf.jasperreports.engine.query.JaxenXPathQueryExecuterFactory Maven / Gradle / Ivy
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2014 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.Map;
import net.sf.jasperreports.engine.JRDataset;
import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JRPropertiesUtil;
import net.sf.jasperreports.engine.JRValueParameter;
import net.sf.jasperreports.engine.JasperReportsContext;
/**
* Jaxen XPath query executer factory.
*
* The factory creates {@link net.sf.jasperreports.engine.query.JaxenXPathQueryExecuter JaxenXPathQueryExecuter}
* query executers.
*
* @author Narcis Marcu ([email protected])
*/
public class JaxenXPathQueryExecuterFactory extends JRXPathQueryExecuterFactory
{
/**
* Built-in parameter holdin the value of the javax.xml.parsers.DocumentBuilderFactor
used to create
* documents of type org.w3c.dom.Document
*/
public final static String PARAMETER_DOCUMENT_BUILDER_FACTORY = "DOCUMENT_BUILDER_FACTORY";
/**
* Parameter that holds the java.util.Map<String,String>
with XML namespace information in the
* <prefix, uri> format
*/
public final static String PARAMETER_XML_NAMESPACE_MAP = "XML_NAMESPACE_MAP";
/**
* Prefix for properties holding the namespace prefix and uri:
* e.g. net.sf.jasperreports.xml.namespace.{prefix} = uri
*
* This property has a lower priority than {@link #PARAMETER_XML_NAMESPACE_MAP}, which if it is specified it will cause
* the prefixed properties not to be searched for.
*
*/
public final static String XML_NAMESPACE_PREFIX = JRPropertiesUtil.PROPERTY_PREFIX + "xml.namespace.";
/**
* Boolean parameter/property that specifies whether the XML document should be parsed for namespaces or not.
*
* This parameter is meaningful only when:
*
* -
* the {@link #PARAMETER_XML_NAMESPACE_MAP} parameter is not provided or provided with a
null
value
*
* -
* there are no properties prefixed with {@link #XML_NAMESPACE_PREFIX};
*
* -
* the xpath query expression that is provided contains XML namespace prefixes
*
*
*
* It defaults to false
*/
public final static String XML_DETECT_NAMESPACES = JRPropertiesUtil.PROPERTY_PREFIX + "xml.detect.namespaces";
private final static Object[] JAXEN_XPATH_BUILTIN_PARAMETERS = {
PARAMETER_XML_DATA_DOCUMENT, "org.w3c.dom.Document",
PARAMETER_DOCUMENT_BUILDER_FACTORY, "javax.xml.parsers.DocumentBuilderFactory",
PARAMETER_XML_NAMESPACE_MAP, "java.util.Map",
XML_DATE_PATTERN, "java.lang.String",
XML_NUMBER_PATTERN, "java.lang.String",
XML_LOCALE, "java.util.Locale",
XML_TIME_ZONE, "java.util.TimeZone",
};
@Override
public Object[] getBuiltinParameters()
{
return JAXEN_XPATH_BUILTIN_PARAMETERS;
}
@Override
public JRQueryExecuter createQueryExecuter(
JasperReportsContext jasperReportsContext,
JRDataset dataset,
Map parameters
) throws JRException
{
return new JaxenXPathQueryExecuter(jasperReportsContext, dataset, parameters);
}
}