net.sf.jasperreports.customvisualization.fill.CVFillComponent Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jasperreports-custom-visualization Show documentation
Show all versions of jasperreports-custom-visualization Show documentation
JasperReports Custom Visualization Component
/*
* 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 itemProperties;
private List itemDataList = new ArrayList<>();
private List>> datasetsData = new ArrayList<>();
private Processor processor = null;
private JasperReportsContext context = null;
// private List fillLayers;
// private SVGMapFillDataset dataset;
// private List colorRanges;
public CVFillComponent(CVComponent component, JRFillObjectFactory factory)
{
this.component = component;
this.itemProperties = new ArrayList<>();
if (factory != null)
{
// factory.registerElementDataset(this.dataset);
for (ItemProperty itemProperty : component.getItemProperties())
{
this.itemProperties.add(new CVFillItemProperty(itemProperty, factory));
}
for (ItemData data : component.getItemData())
{
if (data != null)
{
itemDataList.add(new CVFillItemData(this, data, factory));
datasetsData.add(null);
}
}
this.context = factory.getFiller().getJasperReportsContext();
}
String processingClass = component.getProcessingClass();
if (processingClass != null && processingClass.length() > 0)
{
try
{
Class myClass = JRClassLoader.loadClassForName(processingClass);
processor = (Processor) myClass.getDeclaredConstructor().newInstance();
}
catch (ClassNotFoundException | InvocationTargetException | IllegalAccessException | InstantiationException | NoSuchMethodException e)
{
throw new JRRuntimeException("Could not create processor instance.", e);
}
}
}
protected boolean isEvaluateNow()
{
return getComponent().getEvaluationTime() == EvaluationTimeEnum.NOW;
}
protected CVComponent getComponent()
{
return component;
}
@Override
public void evaluate(byte evaluation) throws JRException
{
if (isEvaluateNow())
{
evaluateComponent(evaluation);
}
}
public void evaluateComponent(byte evaluation) throws JRException
{
if (fillContext != null)
{
for (CVFillItemProperty itemProperty : this.itemProperties)
{
itemProperty.evaluate(fillContext, evaluation);
}
for (int i = 0; i < this.itemDataList.size(); ++i)
{
CVFillItemData itemData = this.itemDataList.get(i);
if (itemData != null)
{
List> newSet = itemData.getEvaluateItems(evaluation);
List> reallyNewSet = new ArrayList<>();
for (Map m : newSet)
{
// System.out.println(m);
reallyNewSet.add(m);
}
datasetsData.set(i, reallyNewSet);
}
else
{
datasetsData.set(i, null);
}
}
}
}
@Override
public FillPrepareResult prepare(int availableHeight)
{
return FillPrepareResult.PRINT_NO_STRETCH;
}
protected JRTemplateGenericPrintElement createGenericPrintElement()
{
JRComponentElement element = fillContext.getComponentElement();
JRTemplateGenericElement template =
new JRTemplateGenericElement(
fillContext.getElementOrigin(),
fillContext.getDefaultStyleProvider(),
fillContext.getComponentElement(),
CVPrintElement.CV_ELEMENT_TYPE
);
template = deduplicate(template);
JRTemplateGenericPrintElement printElement =
new JRTemplateGenericPrintElement(
template,
printElementOriginator
);
printElement.setUUID(element.getUUID());
printElement.setX(element.getX());
printElement.setY(fillContext.getElementPrintY());
printElement.setWidth(element.getWidth());
printElement.setHeight(element.getHeight());
if (element.hasProperties() )
{
if (
element.getPropertiesMap().getProperty("cv.keepTemporaryFiles") != null
&& element.getPropertiesMap().getProperty("cv.keepTemporaryFiles").equals("true")
)
{
printElement.getPropertiesMap().setProperty("cv.keepTemporaryFiles", "true");
}
// We also want to transfer to the component all the properties starting with CV_PREFIX
//FIXME transfer standard print properties?
for (String ownPropName : element.getPropertiesMap().getOwnPropertyNames())
{
if (ownPropName.startsWith(CVConstants.CV_PREFIX ))
{
printElement.getPropertiesMap().setProperty(ownPropName, element.getPropertiesMap().getProperty(ownPropName));
}
}
}
String elementId = CVUtils.generateElementId();
printElement.setParameterValue(CVPrintElement.PARAMETER_ELEMENT_ID, elementId);
if (log.isDebugEnabled())
{
log.debug("generating element " + elementId);
}
return printElement;
}
@Override
public JRPrintElement fill()
{
JRTemplateGenericPrintElement printElement = createGenericPrintElement();
if (isEvaluateNow())
{
evaluationPerformed(printElement);
}
else
{
fillContext.registerDelayedEvaluation(
printElement,
getComponent().getEvaluationTime(),
getComponent().getEvaluationGroup()
);
}
return printElement;
}
@Override
public void evaluateDelayedElement(JRPrintElement element, byte evaluation) throws JRException
{
evaluateComponent(evaluation);
evaluationPerformed((JRTemplateGenericPrintElement) element);
}
/**
* The right place to perform fill objects processing after evaluation of
* all the expressions.
*
*/
protected void evaluationPerformed(JRTemplateGenericPrintElement element)
{
// Build the processor...
Map configuration = new HashMap<>();
// configuration.put(Processor.CONF_FILL_CONTEXT, this.fillContext);
configuration.put(Processor.CONF_PRINT_ELEMENT, element);
element.setParameterValue(CVPrintElement.PARAMETER_ON_ERROR_TYPE, this.component.getOnErrorType().getName());
List>> savedDatasetsData = new ArrayList<>();
for (int i = 0; i < datasetsData.size(); ++i)
{
savedDatasetsData.add(datasetsData.get(i));
datasetsData.set(i, null);
}
configuration.put(Processor.CONF_SERIES, savedDatasetsData);
Object scriptSource = null;
Object cssSource = null;
for (CVFillItemProperty p : itemProperties)
{
if (CVPrintElement.SCRIPT.equals(p.getName()))
{
scriptSource = p.getValue();
}
else if (CVPrintElement.CSS.equals(p.getName()))
{
cssSource = p.getValue();
}
else
{
configuration.put(p.getName(), p.getValue());
}
}
if (processor != null)
{
try
{
configuration = processor.processConfiguration(configuration);
}
catch (Throwable t)
{
throw new JRRuntimeException("Custom Visualization component processing failed.", t);
}
}
element.setParameterValue(CVPrintElement.CONFIGURATION, configuration);
element.setParameterValue(CVPrintElement.SCRIPT_URI, toPrintLocation((String) scriptSource));
if (cssSource != null && ((String) cssSource).trim().length() > 0) {
element.setParameterValue(CVPrintElement.CSS_URI, toPrintLocation((String) cssSource));
}
String moduleName =
(configuration.containsKey(CVPrintElement.MODULE))
? (String) configuration.get(CVPrintElement.MODULE) : null;
// We need a module name. If the module name has not been provided by
// the user
// by using the module property, the module name is guessed from the
// file name.
if (moduleName == null || moduleName.isEmpty())
{
String location = null;
// Use the base name as module name...
if (scriptSource instanceof File)
{
location = ((File) scriptSource).toURI().toString();
}
else if (scriptSource instanceof String)
{
location = (String) scriptSource;
}
if (location != null)
{
File f = new File(location);
String name = f.getName();
if (name.toLowerCase().endsWith(".min.js"))
{
name = name.substring(0, name.length() - 7);
}
else if (name.toLowerCase().endsWith(".js"))
{
name = name.substring(0, name.length() - 3);
}
// Get just the file name...
element.setParameterValue(CVPrintElement.MODULE, name);
}
}
else
{
element.setParameterValue(CVPrintElement.MODULE, moduleName);
}
// If a module name is still missing, we rise an expection...
if (element.getParameterValue(CVPrintElement.MODULE) == null)
{
throw new JRRuntimeException("No 'module' property defined for a Custom Visualization Component.");
}
}
protected String toPrintLocation(String location)
{
//resolve paths relative to the report
RepositoryContext repositoryContext = fillContext.getFiller().getRepositoryContext();
ResourceInfo resourceInfo = RepositoryUtil.getInstance(repositoryContext).getResourceInfo(location);
return resourceInfo == null ? location : resourceInfo.getRepositoryResourceLocation();
}
@Override
public FillContext getFillContext()
{
return fillContext;
}
/**
* Load a resource from a repository location, input stream, URL or File. If
* fromClasspathOnly is set to true, the source is used as a string pointing
* to a resource inside the classpath. Classpath access is restricted by
* PROPERTIES_WEB_RESOURCE_PATTERN_PREFIX properties inside JasperReports.
*
* @param source
* @param fromClasspathOnly
* @return
*/
protected String loadResource(Object source, boolean fromClasspathOnly)
{
try
{
byte[] scriptBytes = null;
if (!fromClasspathOnly)
{
if (source instanceof InputStream)
{
scriptBytes = JRLoader.loadBytes((InputStream) source);
}
else if (source instanceof URL)
{
scriptBytes = JRLoader.loadBytes((URL) source);
}
else if (source instanceof File)
{
scriptBytes = JRLoader.loadBytes((File) source);
}
else if (source instanceof String)
{
String location = (String) source;
scriptBytes = RepositoryUtil.getInstance(this.context).getBytesFromLocation(location);
}
}
if (scriptBytes == null && (source != null && source instanceof String && ((String) source).length() > 0))
{
String location = (String) source;
if (checkResourceName(this.context, location))
{
scriptBytes =
JRLoader.loadBytes(Thread.currentThread().getContextClassLoader().getResourceAsStream(location));
}
}
if (scriptBytes == null)
{
String message = "No script provided for the Custom Visualization component. ";
if (fromClasspathOnly)
{
message += "(Loading of this resource is restricted to the classpath)";
}
throw new JRRuntimeException(message);
}
return new String(scriptBytes, "UTF-8");
}
catch (Exception ex)
{
// Depending on the error type, use a fake image or rise an
// exception...
throw new JRRuntimeException("No script provided for the Custom Visualization component.", ex);
}
}
/**
* Function taken by the DefaultWebResourceHandler of JasperReports.
*
* It checks if a specific resource name inside the classpath can be loaded
* or no.
*
* @param jasperReportsContext
* @param resourceName
* @return
*/
protected boolean checkResourceName(JasperReportsContext jasperReportsContext, String resourceName)
{
boolean matched = false;
List patternProps =
JRPropertiesUtil.getInstance(jasperReportsContext)
.getProperties(PROPERTIES_WEB_RESOURCE_PATTERN_PREFIX);// FIXMESORT cache this
for (Iterator patternIt = patternProps.iterator(); patternIt.hasNext();)
{
JRPropertiesUtil.PropertySuffix patternProp = patternIt.next();
String patternStr = patternProp.getValue();
if (patternStr != null && patternStr.length() > 0)
{
Pattern resourcePattern = Pattern.compile(patternStr);
if (resourcePattern.matcher(resourceName).matches())
{
if (log.isDebugEnabled())
{
log.debug("resource " + resourceName + " matched pattern " + resourcePattern);
}
matched = true;
break;
}
}
}
if (!matched)
{
if (log.isDebugEnabled())
{
log.debug("Resource " + resourceName + " does not matched any allowed pattern");
}
}
return matched;
}
}