net.sf.jasperreports.engine.JRPropertiesUtil 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
* The following actions are performed:
*
* - The default (hardcoded) properties are set.
* - If the system property "net.sf.jasperreports.properties" has been set
* then the specified proprties file is loaded.
* - Otherwise "jasperreports.properties" is loaded if found in the classpath.
* - For backward compatibility, system properties like "jasper.reports.compile.xml.validation"
* are checked and their values are used. This way of specifying properties is deprecated.
*
*
*
* @author Lucian Chirita ([email protected])
*/
public final class JRPropertiesUtil
{
/**
* The prefix used by all properties.
*/
public static final String PROPERTY_PREFIX = "net.sf.jasperreports.";
public static final String EXCEPTION_MESSAGE_KEY_LOAD_PROPERTIES_FILE_FAILURE = "engine.load.properties.file.failure";
public static final String EXCEPTION_MESSAGE_KEY_LOAD_PROPERTIES_FAILURE = "engine.load.properties.failure";
private JasperReportsContext jasperReportsContext;
/**
*
*/
private JRPropertiesUtil(JasperReportsContext jasperReportsContext)
{
this.jasperReportsContext = jasperReportsContext;
}
/**
*
*/
public static JRPropertiesUtil getInstance(JasperReportsContext jasperReportsContext)
{
return new JRPropertiesUtil(jasperReportsContext);
}
/**
* Loads a properties file from the classpath.
*
* @param name the resource name
* @param defaults the default properties
* @return the loaded properties if the resource is found, null otherwise
* @throws JRException
*/
public static Properties loadProperties (String name, Properties defaults) throws JRException
{
Properties properties = null;
InputStream is = null;
try
{
is = JRLoader.getLocationInputStream(name);
}
catch (SecurityException e)
{
// This could fail if we are in the applet viewer or some other
// restrictive environment, but most of the time it should be safe to ignore.
// We cannot log this properly using a logging API,
// as we want to keep applet JAR dependencies to a minimum.
}
if (is != null)
{
properties = new Properties(defaults);
try
{
properties.load(is);
}
catch (IOException e)
{
throw
new JRException(
EXCEPTION_MESSAGE_KEY_LOAD_PROPERTIES_FILE_FAILURE,
new Object[]{name},
e);
}
finally
{
try
{
is.close();
}
catch (IOException e)
{
}
}
}
return properties;
}
/**
* Returns the value of the property.
*
* @param key the key
* @return the property value
*/
public String getProperty(String key)
{
return jasperReportsContext.getProperty(key);
}
/**
*
*/
public void setProperty(String key, String value)
{
jasperReportsContext.setProperty(key, value);
}
/**
*
*/
public void removeProperty(String key)
{
jasperReportsContext.removeProperty(key);
}
/**
* Returns a property as a boolean value.
*
* @param key the key
* @return the property value as a boolean
*/
public boolean getBooleanProperty(String key)
{
return asBoolean(getProperty(key));
}
/**
* Returns a property as a boolean value.
*
* @param key the key
* @param defaultValue the default value
* @return the property value as a boolean
*/
public boolean getBooleanProperty(String key, boolean defaultValue)
{
return asBoolean(getProperty(key), defaultValue);
}
/**
* Returns a property as an integer value.
*
* @param key the key
* @return the property value as an integer
*/
public int getIntegerProperty (String key)
{
return asInteger(getProperty(key));
}
/**
* Returns a property as a float value.
*
* @param key the key
* @return the property value as a float
*/
public float getFloatProperty (String key)
{
return asFloat(getProperty(key));
}
/**
* Converts a String value into a boolean.
*
* @param value the value
* @return the value as a boolean
*/
public static boolean asBoolean(String value)
{
return Boolean.valueOf(value == null ? value : value.trim()).booleanValue();
}
public static boolean asBoolean(String value, boolean defaultValue)
{
return value == null ? defaultValue : Boolean.valueOf(value.trim()).booleanValue();
}
/**
* Converts a String value into a int.
*
* @param value the value
* @return the value as a int
*/
public static int asInteger(String value)
{
return Integer.parseInt(value == null ? value : value.trim());
}
/**
* Converts a String value into a float.
*
* @param value the value
* @return the value as a float
*/
public static float asFloat(String value)
{
return Float.parseFloat(value == null ? value : value.trim());
}
/**
* Class used by {@link JRPropertiesUtil#getProperties(String)}.
*
* @author Lucian Chirita
*/
public static class PropertySuffix
{
protected final String key;
protected final String suffix;
protected final String value;
public PropertySuffix (String key, String suffix, String value)
{
this.key = key;
this.suffix = suffix;
this.value = value;
}
public String getKey()
{
return key;
}
public String getSuffix ()
{
return suffix;
}
public String getValue ()
{
return value;
}
}
/**
* Returns the list of all properties for a key prefix.
*
* @param prefix the key prefix
* @return a list of {@link PropertySuffix PropertySuffix} objects containing the suffix of the key and the value
*/
public List getProperties (String prefix)
{
Map properties = jasperReportsContext.getProperties();
int prefixLength = prefix.length();
List values = new ArrayList();
for (Map.Entry entry : properties.entrySet())
{
String name = entry.getKey();
if (name.startsWith(prefix))
{
String suffix = name.substring(prefixLength);
String value = entry.getValue();
values.add(new PropertySuffix(name, suffix, value));
}
}
return values;
}
/**
* Returns the list of all properties for a key prefix.
*
* Only this holder's own properties are considered, and not global
* properties.
*
* @param propertiesHolder the properties holder
* @param prefix the key prefix
* @return a list of {@link PropertySuffix PropertySuffix} objects containing the suffix of the key and the value
* @see #getAllProperties(JRPropertiesHolder, String)
*/
public static List getProperties(JRPropertiesHolder propertiesHolder, String prefix)
{
return getProperties(getOwnProperties(propertiesHolder), prefix);
}
/**
* Returns the list of all properties for a key prefix, including global
* properties.
*
* @param propertiesHolder the properties holder
* @param prefix the key prefix
* @return a list of {@link PropertySuffix PropertySuffix} objects containing the suffix of the key and the value
* @see #getProperties(JRPropertiesHolder, String)
*/
public List getAllProperties(JRPropertiesHolder propertiesHolder, String prefix)
{
return getAllProperties(getOwnProperties(propertiesHolder), prefix);
}
/**
* Returns the list of all properties for a key prefix.
*
* Only properties from propertiesMap are considered, and
* not global properties.
*
* @param propertiesMap the properties map
* @param prefix the key prefix
* @return a list of {@link PropertySuffix PropertySuffix} objects containing the suffix of the key and the value
* @see #getAllProperties(JRPropertiesMap, String)
*/
public static List getProperties(JRPropertiesMap propertiesMap, String prefix)
{
int prefixLength = prefix.length();
List values = new ArrayList();
if (propertiesMap != null)
{
String[] propertyNames = propertiesMap.getPropertyNames();
for (int i = 0; i < propertyNames.length; i++)
{
String name = propertyNames[i];
if (name.startsWith(prefix))
{
String suffix = name.substring(prefixLength);
String value = propertiesMap.getProperty(name);
values.add(new PropertySuffix(name, suffix, value));
}
}
}
return values;
}
/**
* Returns the list of all properties for a key prefix, including global
* properties.
*
* @param propertiesMap the properties map
* @param prefix the key prefix
* @return a list of {@link PropertySuffix PropertySuffix} objects containing the suffix of the key and the value
* @see #getProperties(JRPropertiesMap, String)
*/
public List getAllProperties(JRPropertiesMap propertiesMap, String prefix)
{
List own = getProperties(propertiesMap, prefix);
List global = getProperties(prefix);
List collected;
if (own.isEmpty())
{
collected = global;
}
else
{
if (!global.isEmpty())
{
Set ownSuffixes = new HashSet();
for (Iterator it = own.iterator(); it.hasNext();)
{
PropertySuffix prop = it.next();
ownSuffixes.add(prop.getSuffix());
}
for (Iterator it = global.iterator(); it.hasNext();)
{
PropertySuffix prop = it.next();
if (!ownSuffixes.contains(prop.getSuffix()))
{
own.add(prop);
}
}
}
collected = own;
}
return collected;
}
/**
* Returns the value of a property, looking first in the supplied properties holder
* and then in the system properties.
*
* @param propertiesHolder the properties holder
* @param key the key
* @return the property value
*/
public String getProperty(JRPropertiesHolder propertiesHolder, String key)
{
String value = null;
while (propertiesHolder != null && value == null)
{
if (propertiesHolder.hasProperties())
{
value = propertiesHolder.getPropertiesMap().getProperty(key);
}
propertiesHolder = propertiesHolder.getParentProperties();
}
if (value == null)
{
value = getProperty(key);
}
return value;
}
/**
* Returns the value of a property, looking for it in several properties holders
* and then in the system properties.
*
* @param key the key
* @param propertiesHolders the properties holders
* @return the property value
*/
public String getProperty(String key, JRPropertiesHolder ... propertiesHolders)
{
String value = null;
main: for (JRPropertiesHolder propertiesHolder : propertiesHolders)
{
while (propertiesHolder != null)
{
if (propertiesHolder.hasProperties())
{
String prop = propertiesHolder.getPropertiesMap().getProperty(key);
if (prop != null)
{
value = prop;
break main;
}
}
propertiesHolder = propertiesHolder.getParentProperties();
}
}
if (value == null)
{
value = getProperty(key);
}
return value;
}
/**
* Returns the value of a property, looking first in the supplied properties map
* and then in the system properties.
*
* @param propertiesMap the properties map
* @param key the key
* @return the property value
*/
public String getProperty(JRPropertiesMap propertiesMap, String key)
{
String value = null;
if (propertiesMap != null)
{
value = propertiesMap.getProperty(key);
}
if (value == null)
{
value = getProperty(key);
}
return value;
}
/**
* Returns the value of a property as a boolean, looking first in the supplied properties holder
* and then in the system properties.
*
* @param propertiesHolder the properties holder
* @param key the key
* @param defaultValue the default value used if the property is not found
* @return the property value
*/
public boolean getBooleanProperty(JRPropertiesHolder propertiesHolder, String key, boolean defaultValue)
{
String value = getProperty(propertiesHolder, key);
return value == null ? defaultValue : asBoolean(value);
}
/**
* Returns the value of a property as a boolean, looking first in several properties holders
* and then in the system properties.
*
* @param key the key
* @param defaultValue the default value used if the property is not found
* @param propertiesHolders the properties holders
* @return the property value
*/
public boolean getBooleanProperty(String key, boolean defaultValue, JRPropertiesHolder ... propertiesHolders)
{
String value = getProperty(key, propertiesHolders);
return value == null ? defaultValue : asBoolean(value);
}
/**
* Returns the value of a property as a boolean, looking first in the supplied properties map
* and then in the system properties.
*
* @param propertiesMap the properties map
* @param key the key
* @param defaultValue the default value used if the property is not found
* @return the property value
*/
public boolean getBooleanProperty(JRPropertiesMap propertiesMap, String key, boolean defaultValue)
{
String value = getProperty(propertiesMap, key);
return value == null ? defaultValue : asBoolean(value);
}
/**
* Returns the value of a property as a boolean, looking first in the supplied properties map
* and then in the system properties.
*
* @param propertiesMap the properties map
* @param key the key
* @return the property value
*/
public Boolean getBooleanProperty(JRPropertiesMap propertiesMap, String key)
{
String value = getProperty(propertiesMap, key);
return value == null ? null : asBoolean(value);
}
/**
* Returns the value of a property as an Integer, looking first in the supplied properties holder
* and then in the system properties.
*
* @param propertiesHolder the properties holder
* @param key the key
* @return the property value
*/
public Integer getIntegerProperty(JRPropertiesHolder propertiesHolder, String key)
{
String value = getProperty(propertiesHolder, key);
return value == null ? null : asInteger(value);
}
/**
* Returns the value of a property as an integer, looking first in the supplied properties holder
* and then in the system properties.
*
* @param propertiesHolder the properties holder
* @param key the key
* @param defaultValue the default value used if the property is not found
* @return the property value
*/
public int getIntegerProperty(JRPropertiesHolder propertiesHolder, String key, int defaultValue)
{
String value = getProperty(propertiesHolder, key);
return value == null ? defaultValue : asInteger(value);
}
/**
* Returns the value of a property as an integer, looking first in the supplied properties map
* and then in the system properties.
*
* @param propertiesMap the properties map
* @param key the key
* @param defaultValue the default value used if the property is not found
* @return the property value
*/
public int getIntegerProperty(JRPropertiesMap propertiesMap, String key, int defaultValue)
{
String value = getProperty(propertiesMap, key);
return value == null ? defaultValue : asInteger(value);
}
/**
* Returns the value of a property as an integer.
*
* @param key the key
* @param defaultValue the default value used if the property is not found
* @return the property value
*/
public int getIntegerProperty(String key, int defaultValue)
{
String value = getProperty(key);
return value == null ? defaultValue : asInteger(value);
}
/**
* Returns the value of a property as a Float, looking first in the supplied properties holder
* and then in the system properties.
*
* @param propertiesHolder the properties holder
* @param key the key
* @return the property value
*/
public Float getFloatProperty(JRPropertiesHolder propertiesHolder, String key)
{
String value = getProperty(propertiesHolder, key);
return value == null ? null : asFloat(value);
}
/**
* Returns the value of a property as a float, looking first in the supplied properties holder
* and then in the system properties.
*
* @param propertiesHolder the properties holder
* @param key the key
* @param defaultValue the default value used if the property is not found
* @return the property value
*/
public float getFloatProperty(JRPropertiesHolder propertiesHolder, String key, float defaultValue)
{
String value = getProperty(propertiesHolder, key);
return value == null ? defaultValue : asFloat(value);
}
/**
* Returns the value of a property as a float, looking first in the supplied properties map
* and then in the system properties.
*
* @param propertiesMap the properties map
* @param key the key
* @param defaultValue the default value used if the property is not found
* @return the property value
*/
public float getFloatProperty(JRPropertiesMap propertiesMap, String key, float defaultValue)
{
String value = getProperty(propertiesMap, key);
return value == null ? defaultValue : asFloat(value);
}
/**
* Returns the value of a property as a float.
*
* @param key the key
* @param defaultValue the default value used if the property is not found
* @return the property value
*/
public float getFloatProperty(String key, float defaultValue)
{
String value = getProperty(key);
return value == null ? defaultValue : asFloat(value);
}
/**
* Converts a String value into a long.
*
* @param value the value
* @return the value as a long
*/
public static long asLong(String value)
{
return Long.parseLong(value == null ? value : value.trim());
}
/**
* Returns a property as a long value.
*
* @param key the key
* @return the property value as a long
*/
public long getLongProperty(String key)
{
return asLong(getProperty(key));
}
/**
* @deprecated Replaced by {@link #getLongProperty(JRPropertiesMap, String, long)}.
*/
public long getLongProperty(JRPropertiesMap propertiesMap, String key, int defaultValue)
{
return getLongProperty(propertiesMap, key, (long)defaultValue);
}
/**
* @deprecated Replaced by {@link #getLongProperty(JRPropertiesHolder, String, long)}.
*/
public long getLongProperty(JRPropertiesHolder propertiesHolder, String key, int defaultValue)
{
return getLongProperty(propertiesHolder, key, (long)defaultValue);
}
/**
* Returns the value of a property as a long, looking first in the supplied properties map
* and then in the system properties.
*
* @param propertiesMap the properties map
* @param key the key
* @param defaultValue the default value used if the property is not found
* @return the property value
*/
public long getLongProperty(JRPropertiesMap propertiesMap, String key, long defaultValue)
{
String value = getProperty(propertiesMap, key);
return value == null ? defaultValue : asLong(value);
}
/**
* Returns the value of a property as a long, looking first in the supplied properties holder
* and then in the system properties.
*
* @param propertiesHolder the properties holder
* @param key the key
* @param defaultValue the default value used if the property is not found
* @return the property value
*/
public long getLongProperty(JRPropertiesHolder propertiesHolder, String key, long defaultValue)
{
String value = getProperty(propertiesHolder, key);
return value == null ? defaultValue : asLong(value);
}
protected static JRPropertiesMap getOwnProperties(JRPropertiesHolder propertiesHolder)
{
return propertiesHolder.hasProperties() ? propertiesHolder.getPropertiesMap() : null;
}
/**
* Copies properties from one object to another.
*
*
* The properties to be copied are determined by one or more JasperReports
* properties having a specified prefix. The values of these properties
* are interpreted as prefixes of properties to copy.
*
*
* @param source the source properties holder
* @param destination the destination properties holder
* @param tranferPropertiesPrefix the prefix of the JasperReports properties
* that specify the object properties to copy
*/
public void transferProperties(JRPropertiesHolder source,
JRPropertiesHolder destination, String tranferPropertiesPrefix)
{
if (!source.hasProperties())
{
return;
}
transfer(source.getPropertiesMap(), destination, tranferPropertiesPrefix);
}
/**
* Copies properties from one object to another.
*
* @param source the source properties
* @param destination the destination properties holder
* @param tranferPropertiesPrefix the prefix of the JasperReports properties
* that specify the object properties to copy
* @see #transferProperties(JRPropertiesHolder, JRPropertiesHolder, String)
*/
public void transferProperties(JRPropertiesMap source,
JRPropertiesHolder destination, String tranferPropertiesPrefix)
{
if (source == null || !source.hasProperties())
{
return;
}
transfer(source, destination, tranferPropertiesPrefix);
}
public void transferProperties(JRPropertiesMap source,
JRPropertiesHolder destination, List propertyNames)
{
if (source == null || !source.hasProperties()
|| propertyNames == null || propertyNames.isEmpty())
{
return;
}
JRPropertiesMap destinationProperties = destination.getPropertiesMap();
for (String property : propertyNames)
{
String value = source.getProperty(property);
destinationProperties.setProperty(property, value);
}
}
protected void transfer(JRPropertiesMap source,
JRPropertiesHolder destination, String tranferPropertiesPrefix)
{
List transferPrefixProps = getProperties(tranferPropertiesPrefix);//FIXME cache this
for (Iterator prefixIt = transferPrefixProps.iterator(); prefixIt.hasNext();)
{
JRPropertiesUtil.PropertySuffix transferPrefixProp = prefixIt.next();
String transferPrefix = transferPrefixProp.getValue();
if (transferPrefix != null && transferPrefix.length() > 0)
{
List transferProps = getProperties(source, transferPrefix);
for (Iterator propIt = transferProps.iterator(); propIt.hasNext();)
{
JRPropertiesUtil.PropertySuffix property = propIt.next();
String value = property.getValue();
destination.getPropertiesMap().setProperty(property.getKey(), value);
}
}
}
}
/**
* Returns a property as a Character value.
*
* @param key the key
* @return the property value as a Character
* @see #asCharacter(String)
*/
public Character getCharacterProperty(String key)
{
return asCharacter(getProperty(key));
}
/**
* Returns the value of a property as a Character value,
* looking first in the supplied properties holder and then in the
* system properties.
*
* @param propertiesHolder the properties holder
* @param key the key
* @return the property value as a Character
*/
public Character getCharacterProperty(JRPropertiesHolder propertiesHolder, String key)
{
String value = getProperty(propertiesHolder, key);
return asCharacter(value);
}
/**
* Returns the value of a property as a Character value,
* looking first in the supplied properties map
* and then in the system properties.
*
* @param propertiesMap the properties map
* @param key the key
* @return the property value as a Character
*/
public Character getCharacterProperty(JRPropertiesMap propertiesMap, String key)
{
String value = getProperty(propertiesMap, key);
return asCharacter(value);
}
/**
* Converts a String into a Character value.
*
*
* If the String value is null or the empty string,
* null is returned. Otherwise, the method returns
* the first character in the string.
*
* @param value the String value
* @return the value converted to Character
*/
public static Character asCharacter(String value)
{
return value == null || value.length() == 0 ? null
: new Character(value.charAt(0));
}
public static String getOwnProperty(JRPropertiesHolder propertiesHolder, String key)
{
String value = null;
if (propertiesHolder.hasProperties())
{
value = propertiesHolder.getPropertiesMap().getProperty(key);
}
return value;
}
public String getLocalizedProperty(String property, Locale locale)
{
Control control = Control.getControl(Control.FORMAT_PROPERTIES);
String value = null;
// we're not looking at the fallback locale to be consistent with JRResourcesUtil.loadResourceBundle
List locales = control.getCandidateLocales(property, locale);
for (Locale candidate : locales)
{
String candidateString = candidate.toString();
String candidateProperty = candidateString.isEmpty() ? property : (property + "_" + candidateString);
String candidateValue = getProperty(candidateProperty);
if (candidateValue != null)// test for empty?
{
value = candidateValue;
break;
}
}
return value;
}
}