net.sf.jasperreports.engine.query.JRXPathQueryExecuterFactory Maven / Gradle / Ivy
The newest version!
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2023 Cloud Software Group, 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.annotations.properties.Property;
import net.sf.jasperreports.annotations.properties.PropertyScope;
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;
import net.sf.jasperreports.engine.util.Designated;
import net.sf.jasperreports.properties.PropertyConstants;
/**
* XPath query executer factory.
*
* The factory creates {@link net.sf.jasperreports.engine.query.JRXPathQueryExecuter JRXPathQueryExecuter}
* query executers.
*
* @author Lucian Chirita ([email protected])
*/
public class JRXPathQueryExecuterFactory extends AbstractQueryExecuterFactory implements Designated
{
/**
* Built-in parameter holding 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.
*
*/
@Property(
name="net.sf.jasperreports.xml.namespace.{arbitrary_prefix}",
category = PropertyConstants.CATEGORY_DATA_SOURCE,
scopes = {PropertyScope.CONTEXT, PropertyScope.DATASET},
scopeQualifications = {JRXPathQueryExecuterFactory.QUERY_EXECUTER_NAME},
sinceVersion = PropertyConstants.VERSION_4_6_0
)
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
*/
@Property(
category = PropertyConstants.CATEGORY_DATA_SOURCE,
defaultValue = PropertyConstants.BOOLEAN_FALSE,
scopes = {PropertyScope.CONTEXT, PropertyScope.DATASET},
scopeQualifications = {JRXPathQueryExecuterFactory.QUERY_EXECUTER_NAME},
sinceVersion = PropertyConstants.VERSION_4_6_0,
valueType = Boolean.class
)
public final static String XML_DETECT_NAMESPACES = JRPropertiesUtil.PROPERTY_PREFIX + "xml.detect.namespaces";
public static final String QUERY_EXECUTER_NAME = "net.sf.jasperreports.query.executer:XPATH";
/**
* Built-in parameter holding the value of the org.w3c.dom.Document used to run the XPath query.
*/
public final static String PARAMETER_XML_DATA_DOCUMENT = "XML_DATA_DOCUMENT";
/**
* Built-in parameter holding the value of the java.io.InputStream
to be used for obtaining the XML data.
*/
public static final String XML_INPUT_STREAM = "XML_INPUT_STREAM";
/**
* Built-in parameter holding the value of the java.io.File
to be used for obtaining the XML data.
*/
public static final String XML_FILE = "XML_FILE";
/**
* Built-in parameter/property holding the value of the java.lang.String
source to be used for obtaining the XML data.
*/
@Property(
category = PropertyConstants.CATEGORY_DATA_SOURCE,
scopes = {PropertyScope.CONTEXT, PropertyScope.DATASET},
scopeQualifications = {QUERY_EXECUTER_NAME},
sinceVersion = PropertyConstants.VERSION_4_7_1
)
public static final String XML_SOURCE = JRPropertiesUtil.PROPERTY_PREFIX + "xml.source";
/**
* Parameter holding the format pattern used to instantiate java.util.Date instances.
*/
public final static String XML_DATE_PATTERN = "XML_DATE_PATTERN";
/**
* Property holding the value of the date format pattern to be used when parsing the XML data.
*/
@Property(
category = PropertyConstants.CATEGORY_DATA_SOURCE,
scopes = {PropertyScope.CONTEXT, PropertyScope.DATASET},
scopeQualifications = {QUERY_EXECUTER_NAME},
sinceVersion = PropertyConstants.VERSION_4_6_0
)
public static final String PROPERTY_XML_DATE_PATTERN = JRPropertiesUtil.PROPERTY_PREFIX + "xml.date.pattern";
/**
* Parameter holding the format pattern used to instantiate java.lang.Number instances.
*/
public final static String XML_NUMBER_PATTERN = "XML_NUMBER_PATTERN";
/**
* Property holding the value of the number format pattern to be used when parsing the XLS data.
*/
@Property(
category = PropertyConstants.CATEGORY_DATA_SOURCE,
scopes = {PropertyScope.CONTEXT, PropertyScope.DATASET},
scopeQualifications = {QUERY_EXECUTER_NAME},
sinceVersion = PropertyConstants.VERSION_4_6_0
)
public static final String PROPERTY_XML_NUMBER_PATTERN = JRPropertiesUtil.PROPERTY_PREFIX + "xml.number.pattern";
/**
* Parameter holding the value of the datasource Locale
*/
public final static String XML_LOCALE = "XML_LOCALE";//FIXME make properties for locale and timezone too; just like in csv
/**
* Parameter holding the value of the datasource Timezone
*/
public final static String XML_TIME_ZONE = "XML_TIME_ZONE";
private final static Object[] XPATH_BUILTIN_PARAMETERS = {
PARAMETER_XML_DATA_DOCUMENT, "org.w3c.dom.Document",
XML_INPUT_STREAM, "java.io.InputStream",
XML_FILE, "java.io.File",
XML_SOURCE, "java.lang.String",
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 XPATH_BUILTIN_PARAMETERS;
}
@Override
public JRQueryExecuter createQueryExecuter(
JasperReportsContext jasperReportsContext,
JRDataset dataset,
Map parameters
) throws JRException
{
return createQueryExecuter(SimpleQueryExecutionContext.of(jasperReportsContext),
dataset, parameters);
}
@Override
public JRQueryExecuter createQueryExecuter(
QueryExecutionContext context,
JRDataset dataset,
Map parameters
) throws JRException
{
return new JRXPathQueryExecuter(context, dataset, parameters);
}
@Override
public boolean supportsQueryParameterType(String className)
{
return true;
}
@Override
public String getDesignation()
{
return QUERY_EXECUTER_NAME;
}
}