net.sf.jasperreports.properties.PropertiesMetadataUtil 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 loadedProperties;
protected PropertiesMetadataUtil(JasperReportsContext context, Locale locale)
{
this.context = context;
this.locale = locale;
}
protected Collection allProperties()
{
Map allProperties = loadedProperties;
if (allProperties == null)
{
loadedProperties = allProperties = ResourcePropertiesMetadataReader.instance().readProperties(context, locale);
}
return allProperties.values();
}
public List getProperties()
{
Collection allProperties = allProperties();
return new ArrayList<>(allProperties);
}
public List getProperties(PropertyScope scope)
{
return allProperties().stream().filter(primaryScopePredicate(scope)).collect(Collectors.toList());
}
public List getQueryExecuterFieldProperties(String queryLanguage) throws JRException
{
String qualification = queryExecuterQualification(queryLanguage);
if (qualification == null)
{
return Collections.emptyList();
}
List properties = filterQualifiedProperties(PropertyScope.FIELD, qualification);
return properties;
}
protected String queryExecuterQualification(String queryLanguage) throws JRException
{
QueryExecuterFactory queryExecuterFactory = JRQueryExecuterUtils.getInstance(context).getExecuterFactory(queryLanguage);
if (!(queryExecuterFactory instanceof Designated))
{
return null;
}
String queryExecuterName = ((Designated) queryExecuterFactory).getDesignation();
return queryExecuterName;
}
protected List filterQualifiedProperties(PropertyScope primaryScope, String... qualifications)
{
return qualifiedProperties(primaryScope, qualifications).collect(Collectors.toList());
}
protected Stream qualifiedProperties(PropertyScope primaryScope, String... qualifications)
{
return allProperties().stream().filter(scopeQualificationsPredicate(primaryScope, qualifications));
}
protected Predicate primaryScopePredicate(PropertyScope scope)
{
return property -> property.getScopes().contains(scope);
}
protected Predicate scopeQualificationsPredicate(PropertyScope scope, String... qualifications)
{
Set qualificationSet = Stream.of(qualifications).filter(v -> v != null).collect(Collectors.toSet());
return primaryScopePredicate(scope).and(property ->
{
List propertyQualifications = property.getScopeQualifications();
return propertyQualifications == null || propertyQualifications.isEmpty()
|| !Collections.disjoint(propertyQualifications, qualificationSet);
});
}
public List getParameterProperties(DataAdapter dataAdapter)
{
String qualification = dataFileQualification(dataAdapter);
if (qualification == null)
{
return Collections.emptyList();
}
List properties = filterQualifiedProperties(PropertyScope.PARAMETER, qualification);
return properties;
}
@SuppressWarnings("unchecked")
protected String dataFileQualification(DataAdapter dataAdapter)
{
if (!(dataAdapter instanceof FileDataAdapter))
{
return null;
}
DataFile dataFile = ((FileDataAdapter) dataAdapter).getDataFile();
String name = null;
List factories = context.getExtensions(DataFileServiceFactory.class);
if (factories != null)
{
for (DataFileServiceFactory factory : factories)
{
if (factory instanceof Designator)
{
name = ((Designator) factory).getName(dataFile);
if (name != null)
{
break;
}
}
}
}
return name;
}
public List getElementProperties(JRElement element)
{
Collection allProperties = allProperties();
List elementProperties = new ArrayList<>();
for (PropertyMetadata propertyMetadata : allProperties)
{
if (inScope(propertyMetadata, element))
{
elementProperties.add(propertyMetadata);
}
}
return elementProperties;
}
protected boolean inScope(PropertyMetadata property, JRElement element)
{
List scopes = property.getScopes();
if (scopes.contains(PropertyScope.ELEMENT))
{
return true;
}
if (element instanceof JRTextElement && scopes.contains(PropertyScope.TEXT_ELEMENT))
{
return true;
}
if (element instanceof JRImage && scopes.contains(PropertyScope.IMAGE_ELEMENT))
{
return true;
}
if (element instanceof JRChart && scopes.contains(PropertyScope.CHART_ELEMENT))
{
return true;
}
if (element instanceof JRCrosstab && scopes.contains(PropertyScope.CROSSTAB))
{
return true;
}
if (element instanceof JRFrame && scopes.contains(PropertyScope.FRAME))
{
return true;
}
if (element instanceof JRSubreport && scopes.contains(PropertyScope.SUBREPORT))
{
return true;
}
//TODO lucianc generic element
if (element instanceof JRComponentElement && scopes.contains(PropertyScope.COMPONENT))
{
List qualifications = property.getScopeQualifications();
if (qualifications == null || qualifications.isEmpty())
{
//assuming all components
return true;
}
JRComponentElement componentElement = (JRComponentElement) element;
String qualification;
if (componentElement.getComponent() instanceof Designated)
{
qualification = ((Designated) componentElement.getComponent()).getDesignation();
}
else
{
ComponentKey key = componentElement.getComponentKey();
if (key == null || key.getNamespace() == null || key.getName() == null)
{
//key is missing
qualification = null;
}
else
{
qualification = key.getNamespace()
+ PropertyConstants.COMPONENT_KEY_QUALIFICATION_SEPARATOR
+ key.getName();
}
}
return qualification != null && qualifications.contains(qualification);
}
return false;
}
public List getReportProperties(JRReport report)
{
return getProperties(PropertyScope.REPORT);
}
protected String datasetQueryQualification(JRDataset dataset) throws JRException
{
String queryLanguage = dataset.getQuery() == null ? null : dataset.getQuery().getLanguage();
String queryQualification = queryLanguage == null ? null : queryExecuterQualification(queryLanguage);
return queryQualification;
}
@SuppressWarnings("unchecked")
protected String dataAdapterQualification(JRDataset dataset, DataAdapter dataAdapter)
{
ParameterContributorContext contributorContext = new ParameterContributorContext(context,
dataset, Collections.emptyMap());
DataAdapterServiceUtil serviceUtil = DataAdapterServiceUtil.getInstance(contributorContext);
DataAdapterService service = serviceUtil.getService(dataAdapter);
if (service instanceof Designated)
{
return ((Designated) service).getDesignation();
}
if (service instanceof Designator)
{
return ((Designator) service).getName(dataAdapter);
}
return null;
}
public List getDatasetProperties(JRDataset dataset, DataAdapter dataAdapter) throws JRException
{
String queryQualification = datasetQueryQualification(dataset);
String dataAdapterQualification = dataAdapter == null ? null : dataAdapterQualification(dataset, dataAdapter);
String dataFileQualification = dataAdapter == null ? null : dataFileQualification(dataAdapter);
return filterQualifiedProperties(PropertyScope.DATASET, queryQualification, dataAdapterQualification, dataFileQualification);
}
public List getFieldProperties(JRDataset dataset, DataAdapter dataAdapter) throws JRException
{
String queryQualification = datasetQueryQualification(dataset);
String dataAdapterQualification = dataAdapter == null ? null : dataAdapterQualification(dataset, dataAdapter);
return filterQualifiedProperties(PropertyScope.FIELD, queryQualification, dataAdapterQualification);
}
public List getContainerProperties(JRElementGroup container)
{
Collection allProperties = allProperties();
List containerProperties = new ArrayList<>();
for (PropertyMetadata propertyMetadata : allProperties)
{
if (inScope(propertyMetadata, container))
{
containerProperties.add(propertyMetadata);
}
}
return containerProperties;
}
protected boolean inScope(PropertyMetadata propertyMetadata, JRElementGroup container)
{
if (container instanceof JRFrame)
{
return inScope(propertyMetadata, (JRElement) container);
}
List scopes = propertyMetadata.getScopes();
if (container instanceof JRBand)
{
return scopes.contains(PropertyScope.BAND);
}
if (container instanceof Cell)
{
return scopes.contains(PropertyScope.TABLE_CELL);
}
if (container instanceof JRCellContents)
{
return scopes.contains(PropertyScope.CROSSTAB_CELL);
}
return false;
}
public List getScriptletProperties(String scriptletClassName) throws JRException
{
Class scriptletClass;
try
{
scriptletClass = JRClassLoader.loadClassForName(scriptletClassName);
}
catch (ClassNotFoundException e)
{
throw new JRException("Could not load scriptlet class " + scriptletClassName, e);
}
Stream properties = Stream.empty();
do
{
String qualification = scriptletClass.getName();
Stream qualifiedProperties = qualifiedProperties(PropertyScope.SCRIPTLET, qualification);
properties = Stream.concat(properties, qualifiedProperties);
scriptletClass = scriptletClass.getSuperclass();
}
while (scriptletClass != null && JRAbstractScriptlet.class.isAssignableFrom(scriptletClass));
return properties.collect(Collectors.toList());
}
}