net.sf.jasperreports.engine.util.xml.JRXPathExecuterUtils Maven / Gradle / Ivy
/*
* 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.util.xml;
import net.sf.jasperreports.annotations.properties.Property;
import net.sf.jasperreports.annotations.properties.PropertyScope;
import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JRPropertiesUtil;
import net.sf.jasperreports.engine.JasperReportsContext;
import net.sf.jasperreports.engine.util.JRSingletonCache;
import net.sf.jasperreports.properties.PropertyConstants;
/**
* Helper class used to instantiate {@link JRXPathExecuter XPath executers}.
*
* The {@link JRXPathExecuterFactory XPath executer factory} class name is given by the
* {@link #PROPERTY_XPATH_EXECUTER_FACTORY net.sf.jasperreports.xpath.executer.factory} property.
* The class should have a public default constructor so that it can be instantiated via reflection.
*
* By default, {@link XalanXPathExecuter XPath executers} based on Apache Xalan
* are used.
*
* @author Lucian Chirita ([email protected])
*/
public final class JRXPathExecuterUtils
{
public static final String EXCEPTION_MESSAGE_KEY_XPATH_EXECUTER_FACTORY_NOT_FOUND = "util.xml.xpath.executer.factory.property.not.found";
/**
* Property that holds the {@link JRXPathExecuterFactory XPath executer factory} class name.
*/
@Property(
category = PropertyConstants.CATEGORY_DATA_SOURCE,
defaultValue = "net.sf.jasperreports.engine.util.xml.XalanXPathExecuterFactory",
scopes = {PropertyScope.CONTEXT},
sinceVersion = PropertyConstants.VERSION_2_0_0
)
public static final String PROPERTY_XPATH_EXECUTER_FACTORY = JRPropertiesUtil.PROPERTY_PREFIX + "xpath.executer.factory";
private static final JRSingletonCache cache =
new JRSingletonCache(JRXPathExecuterFactory.class);
/**
* Return an {@link JRXPathExecuterFactory XPath executer factory} instance.
*
* @return a JRXPathExecuterFactory instance
* @throws JRException if the {@link #PROPERTY_XPATH_EXECUTER_FACTORY XPath factory property} is not defined
* or the factory cannot be instantiated.
*/
public static JRXPathExecuterFactory getXPathExecuterFactory(JasperReportsContext jasperReportsContext) throws JRException
{
String factoryClassName = JRPropertiesUtil.getInstance(jasperReportsContext).getProperty(PROPERTY_XPATH_EXECUTER_FACTORY);
if (factoryClassName == null)
{
throw
new JRException(
EXCEPTION_MESSAGE_KEY_XPATH_EXECUTER_FACTORY_NOT_FOUND,
new Object[]{PROPERTY_XPATH_EXECUTER_FACTORY});
}
return cache.getCachedInstance(factoryClassName);
}
/**
* Produces an {@link JRXPathExecuter XPath executer} instance by means of the factory
* returned by {@link #getXPathExecuterFactory(JasperReportsContext) getXPathExecuterFactory(JasperReportsContext)}.
*
* @return an JRXPathExecuter instance
* @throws JRException if the {@link #PROPERTY_XPATH_EXECUTER_FACTORY XPath factory property} is not defined
* or the factory cannot be instantiated.
*/
public static JRXPathExecuter getXPathExecuter(JasperReportsContext jasperReportsContext) throws JRException
{
JRXPathExecuterFactory executerFactory = getXPathExecuterFactory(jasperReportsContext);
return executerFactory.getXPathExecuter();
}
private JRXPathExecuterUtils()
{
}
}