net.sf.jasperreports.engine.export.GenericElementHandlerEnviroment 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.export;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.apache.commons.collections.map.ReferenceMap;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import net.sf.jasperreports.engine.JRGenericElementType;
import net.sf.jasperreports.engine.JRRuntimeException;
import net.sf.jasperreports.engine.JasperReportsContext;
import net.sf.jasperreports.extensions.ExtensionsEnvironment;
/**
* A class that provides access to
* {@link GenericElementHandler generic element handlers}.
*
*
* Generic element handler bundles are registered as JasperReports extensions
* of type {@link GenericElementHandlerBundle} via the central extension
* framework (see {@link ExtensionsEnvironment}).
*
* @author Lucian Chirita ([email protected])
*/
public final class GenericElementHandlerEnviroment
{
private static final Log log = LogFactory.getLog(
GenericElementHandlerEnviroment.class);
public static final String EXCEPTION_MESSAGE_KEY_HANDLERS_NOT_FOUND_FOR_NAMESPACE =
"export.common.handlers.not.found.for.namespace";
private final ReferenceMap handlersCache = new ReferenceMap(
ReferenceMap.WEAK, ReferenceMap.HARD);
private JasperReportsContext jasperReportsContext;
/**
*
*/
private GenericElementHandlerEnviroment(JasperReportsContext jasperReportsContext)
{
this.jasperReportsContext = jasperReportsContext;
}
/**
*
*/
public static GenericElementHandlerEnviroment getInstance(JasperReportsContext jasperReportsContext)
{
return new GenericElementHandlerEnviroment(jasperReportsContext);
}
/**
* Returns a handler for a generic print element type and an exporter
* key.
*
*
* The method first locates a
* {@link GenericElementHandlerBundle handler bundle} that matches the type
* namespace, and then uses
* {@link GenericElementHandlerBundle#getHandler(String, String)} to
* resolve an export handler.
*
* @param type the generic element type
* @param exporterKey the exporter key
* @return a generic print element handler
* @throws JRRuntimeException if a handler does not exist for the
* combination of element type and exporter key
*/
public GenericElementHandler getElementHandler(JRGenericElementType type,
String exporterKey)
{
Map handlerBundles = getBundles();
GenericElementHandlerBundle bundle = handlerBundles.get(type.getNamespace());
if (bundle == null)
{
throw
new JRRuntimeException(
EXCEPTION_MESSAGE_KEY_HANDLERS_NOT_FOUND_FOR_NAMESPACE,
new Object[]{type.getNamespace()});
}
return bundle.getHandler(type.getName(), exporterKey);
}
protected Map getBundles()
{
Object cacheKey = ExtensionsEnvironment.getExtensionsCacheKey();
Map handlerBundles;
synchronized (handlersCache)
{
handlerBundles = (Map) handlersCache.get(cacheKey);
if (handlerBundles == null)
{
handlerBundles = loadBundles();
handlersCache.put(cacheKey, handlerBundles);
}
}
return handlerBundles;
}
protected Map loadBundles()
{
List bundleList = jasperReportsContext.getExtensions(GenericElementHandlerBundle.class);
Map bundles = new HashMap();
for (Iterator it = bundleList.iterator(); it.hasNext();)
{
GenericElementHandlerBundle bundle = it.next();
String namespace = bundle.getNamespace();
if (bundles.containsKey(namespace))
{
log.warn("Found two generic element handler bundles for namespace "
+ namespace);
}
else
{
bundles.put(namespace, bundle);
}
}
return bundles;
}
}