javax.faces.convert.NumberConverter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of myfaces-api Show documentation
Show all versions of myfaces-api Show documentation
The public API classes of the Apache MyFaces CORE JSF-2.1 project
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package javax.faces.convert;
import java.math.BigDecimal;
import java.text.DecimalFormat;
import java.text.DecimalFormatSymbols;
import java.text.NumberFormat;
import java.text.ParseException;
import java.util.Currency;
import java.util.Locale;
import javax.el.ValueExpression;
import javax.faces.component.PartialStateHolder;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFConverter;
import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFJspProperty;
import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFProperty;
/**
* This tag creates a number formatting converter and associates it
* with the nearest parent UIComponent.
*
* Unless otherwise specified, all attributes accept static values or EL expressions.
*
* see Javadoc of JSF Specification
*/
@JSFConverter(
name="f:convertNumber",
bodyContent="empty",
tagClass="org.apache.myfaces.taglib.core.ConvertNumberTag")
@JSFJspProperty(
name="binding",
returnType = "javax.faces.convert.NumberConverter",
longDesc = "A ValueExpression that evaluates to a NumberConverter.")
public class NumberConverter
implements Converter, PartialStateHolder
{
// API FIELDS
public static final String CONVERTER_ID = "javax.faces.Number";
public static final String STRING_ID = "javax.faces.converter.STRING";
public static final String CURRENCY_ID = "javax.faces.converter.NumberConverter.CURRENCY";
public static final String NUMBER_ID = "javax.faces.converter.NumberConverter.NUMBER";
public static final String PATTERN_ID = "javax.faces.converter.NumberConverter.PATTERN";
public static final String PERCENT_ID = "javax.faces.converter.NumberConverter.PERCENT";
private String _currencyCode;
private String _currencySymbol;
private Locale _locale;
private int _maxFractionDigits;
private int _maxIntegerDigits;
private int _minFractionDigits;
private int _minIntegerDigits;
private String _pattern;
private String _type = "number";
private boolean _groupingUsed = true;
private boolean _integerOnly = false;
private boolean _transient;
private boolean _maxFractionDigitsSet;
private boolean _maxIntegerDigitsSet;
private boolean _minFractionDigitsSet;
private boolean _minIntegerDigitsSet;
// CONSTRUCTORS
public NumberConverter()
{
}
// METHODS
public Object getAsObject(FacesContext facesContext, UIComponent uiComponent, String value)
{
if (facesContext == null)
{
throw new NullPointerException("facesContext");
}
if (uiComponent == null)
{
throw new NullPointerException("uiComponent");
}
if (value != null)
{
value = value.trim();
if (value.length() > 0)
{
NumberFormat format = getNumberFormat(facesContext);
format.setParseIntegerOnly(_integerOnly);
DecimalFormat df = (DecimalFormat)format;
// The best we can do in this case is check if there is a ValueExpression
// with a BigDecimal as returning type , and if that so enable BigDecimal parsing
// to prevent loss in precision, and do not break existing examples (since
// in those cases it is expected to return Double). See MYFACES-1890 and TRINIDAD-1124
// for details
ValueExpression valueBinding = uiComponent.getValueExpression("value");
if (valueBinding != null)
{
Class destType = valueBinding.getType(facesContext.getELContext());
if (destType != null && BigDecimal.class.isAssignableFrom(destType))
{
df.setParseBigDecimal(true);
}
}
DecimalFormatSymbols dfs = df.getDecimalFormatSymbols();
boolean changed = false;
if(dfs.getGroupingSeparator() == '\u00a0')
{
dfs.setGroupingSeparator(' ');
df.setDecimalFormatSymbols(dfs);
value = value.replace('\u00a0', ' ');
changed = true;
}
formatCurrency(format);
try
{
return format.parse(value);
}
catch (ParseException e)
{
if(changed)
{
dfs.setGroupingSeparator('\u00a0');
df.setDecimalFormatSymbols(dfs);
}
try
{
return format.parse(value);
}
catch (ParseException pe)
{
if(getPattern() != null)
{
throw new ConverterException(_MessageUtils.getErrorMessage(facesContext,
PATTERN_ID,
new Object[]{value, "$###,###", _MessageUtils.getLabel(facesContext, uiComponent)}));
}
else if(getType().equals("number"))
{
throw new ConverterException(_MessageUtils.getErrorMessage(facesContext,
NUMBER_ID,
new Object[]{value, format.format(21),
_MessageUtils.getLabel(facesContext, uiComponent)}));
}
else if(getType().equals("currency"))
{
throw new ConverterException(_MessageUtils.getErrorMessage(facesContext,
CURRENCY_ID,
new Object[]{value, format.format(42.25),
_MessageUtils.getLabel(facesContext, uiComponent)}));
}
else if(getType().equals("percent"))
{
throw new ConverterException(_MessageUtils.getErrorMessage(facesContext,
PERCENT_ID,
new Object[]{value, format.format(.90),
_MessageUtils.getLabel(facesContext, uiComponent)}));
}
}
}
}
}
return null;
}
public String getAsString(FacesContext facesContext, UIComponent uiComponent, Object value)
{
if (facesContext == null)
{
throw new NullPointerException("facesContext");
}
if (uiComponent == null)
{
throw new NullPointerException("uiComponent");
}
if (value == null)
{
return "";
}
if (value instanceof String)
{
return (String)value;
}
NumberFormat format = getNumberFormat(facesContext);
format.setGroupingUsed(_groupingUsed);
if (_maxFractionDigitsSet)
{
format.setMaximumFractionDigits(_maxFractionDigits);
}
if (_maxIntegerDigitsSet)
{
format.setMaximumIntegerDigits(_maxIntegerDigits);
}
if (_minFractionDigitsSet)
{
format.setMinimumFractionDigits(_minFractionDigits);
}
if (_minIntegerDigitsSet)
{
format.setMinimumIntegerDigits(_minIntegerDigits);
}
formatCurrency(format);
try
{
return format.format(value);
}
catch (Exception e)
{
throw new ConverterException(_MessageUtils.getErrorMessage(facesContext, STRING_ID,
new Object[]{value,_MessageUtils.getLabel(facesContext, uiComponent)}),e);
}
}
private NumberFormat getNumberFormat(FacesContext facesContext)
{
Locale locale = _locale != null ? _locale : facesContext.getViewRoot().getLocale();
if (_pattern == null && _type == null)
{
throw new ConverterException("Cannot get NumberFormat, either type or pattern needed.");
}
// pattern
if (_pattern != null)
{
return new DecimalFormat(_pattern, new DecimalFormatSymbols(locale));
}
// type
if (_type.equals("number"))
{
return NumberFormat.getNumberInstance(locale);
}
else if (_type.equals("currency"))
{
return NumberFormat.getCurrencyInstance(locale);
}
else if (_type.equals("percent"))
{
return NumberFormat.getPercentInstance(locale);
}
throw new ConverterException("Cannot get NumberFormat, illegal type " + _type);
}
private void formatCurrency(NumberFormat format)
{
if (_currencyCode == null && _currencySymbol == null)
{
return;
}
boolean useCurrencyCode;
useCurrencyCode = _currencyCode != null;
if (useCurrencyCode)
{
// set Currency
try
{
format.setCurrency(Currency.getInstance(_currencyCode));
}
catch (Exception e)
{
throw new ConverterException("Unable to get Currency instance for currencyCode " +
_currencyCode);
}
}
else if (format instanceof DecimalFormat)
{
DecimalFormat dFormat = (DecimalFormat)format;
DecimalFormatSymbols symbols = dFormat.getDecimalFormatSymbols();
symbols.setCurrencySymbol(_currencySymbol);
dFormat.setDecimalFormatSymbols(symbols);
}
}
// STATE SAVE/RESTORE
public void restoreState(FacesContext facesContext, Object state)
{
if (state != null)
{
Object values[] = (Object[])state;
_currencyCode = (String)values[0];
_currencySymbol = (String)values[1];
_locale = (Locale)values[2];
Integer value = (Integer)values[3];
_maxFractionDigits = value != null ? value.intValue() : 0;
value = (Integer)values[4];
_maxIntegerDigits = value != null ? value.intValue() : 0;
value = (Integer)values[5];
_minFractionDigits = value != null ? value.intValue() : 0;
value = (Integer)values[6];
_minIntegerDigits = value != null ? value.intValue() : 0;
_pattern = (String)values[7];
_type = (String)values[8];
_groupingUsed = ((Boolean)values[9]).booleanValue();
_integerOnly = ((Boolean)values[10]).booleanValue();
_maxFractionDigitsSet = ((Boolean)values[11]).booleanValue();
_maxIntegerDigitsSet = ((Boolean)values[12]).booleanValue();
_minFractionDigitsSet = ((Boolean)values[13]).booleanValue();
_minIntegerDigitsSet = ((Boolean)values[14]).booleanValue();
}
}
public Object saveState(FacesContext facesContext)
{
if (!initialStateMarked())
{
Object values[] = new Object[15];
values[0] = _currencyCode;
values[1] = _currencySymbol;
values[2] = _locale;
values[3] = _maxFractionDigitsSet ? Integer.valueOf(_maxFractionDigits) : null;
values[4] = _maxIntegerDigitsSet ? Integer.valueOf(_maxIntegerDigits) : null;
values[5] = _minFractionDigitsSet ? Integer.valueOf(_minFractionDigits) : null;
values[6] = _minIntegerDigitsSet ? Integer.valueOf(_minIntegerDigits) : null;
values[7] = _pattern;
values[8] = _type;
values[9] = _groupingUsed ? Boolean.TRUE : Boolean.FALSE;
values[10] = _integerOnly ? Boolean.TRUE : Boolean.FALSE;
values[11] = _maxFractionDigitsSet ? Boolean.TRUE : Boolean.FALSE;
values[12] = _maxIntegerDigitsSet ? Boolean.TRUE : Boolean.FALSE;
values[13] = _minFractionDigitsSet ? Boolean.TRUE : Boolean.FALSE;
values[14] = _minIntegerDigitsSet ? Boolean.TRUE : Boolean.FALSE;
return values;
}
return null;
}
// GETTER & SETTER
/**
* ISO 4217 currency code
*
*/
@JSFProperty
public String getCurrencyCode()
{
return _currencyCode != null ?
_currencyCode :
getDecimalFormatSymbols().getInternationalCurrencySymbol();
}
public void setCurrencyCode(String currencyCode)
{
_currencyCode = currencyCode;
clearInitialState();
}
/**
* The currency symbol used to format a currency value. Defaults
* to the currency symbol for locale.
*
*/
@JSFProperty
public String getCurrencySymbol()
{
return _currencySymbol != null ?
_currencySymbol :
getDecimalFormatSymbols().getCurrencySymbol();
}
public void setCurrencySymbol(String currencySymbol)
{
_currencySymbol = currencySymbol;
clearInitialState();
}
/**
* Specifies whether output will contain grouping separators. Default: true.
*
*/
@JSFProperty(deferredValueType="java.lang.Boolean")
public boolean isGroupingUsed()
{
return _groupingUsed;
}
public void setGroupingUsed(boolean groupingUsed)
{
_groupingUsed = groupingUsed;
clearInitialState();
}
/**
* Specifies whether only the integer part of the input will be parsed. Default: false.
*
*/
@JSFProperty(deferredValueType="java.lang.Boolean")
public boolean isIntegerOnly()
{
return _integerOnly;
}
public void setIntegerOnly(boolean integerOnly)
{
_integerOnly = integerOnly;
clearInitialState();
}
/**
* The name of the locale to be used, instead of the default as
* specified in the faces configuration file.
*
*/
@JSFProperty(deferredValueType="java.lang.Object")
public Locale getLocale()
{
if (_locale != null)
{
return _locale;
}
FacesContext context = FacesContext.getCurrentInstance();
return context.getViewRoot().getLocale();
}
public void setLocale(Locale locale)
{
_locale = locale;
clearInitialState();
}
/**
* The maximum number of digits in the fractional portion of the number.
*
*/
@JSFProperty(deferredValueType="java.lang.Integer")
public int getMaxFractionDigits()
{
return _maxFractionDigits;
}
public void setMaxFractionDigits(int maxFractionDigits)
{
_maxFractionDigitsSet = true;
_maxFractionDigits = maxFractionDigits;
clearInitialState();
}
/**
* The maximum number of digits in the integer portion of the number.
*
*/
@JSFProperty(deferredValueType="java.lang.Integer")
public int getMaxIntegerDigits()
{
return _maxIntegerDigits;
}
public void setMaxIntegerDigits(int maxIntegerDigits)
{
_maxIntegerDigitsSet = true;
_maxIntegerDigits = maxIntegerDigits;
clearInitialState();
}
/**
* The minimum number of digits in the fractional portion of the number.
*
*/
@JSFProperty(deferredValueType="java.lang.Integer")
public int getMinFractionDigits()
{
return _minFractionDigits;
}
public void setMinFractionDigits(int minFractionDigits)
{
_minFractionDigitsSet = true;
_minFractionDigits = minFractionDigits;
clearInitialState();
}
/**
* The minimum number of digits in the integer portion of the number.
*
*/
@JSFProperty(deferredValueType="java.lang.Integer")
public int getMinIntegerDigits()
{
return _minIntegerDigits;
}
public void setMinIntegerDigits(int minIntegerDigits)
{
_minIntegerDigitsSet = true;
_minIntegerDigits = minIntegerDigits;
clearInitialState();
}
/**
* A custom Date formatting pattern, in the format used by java.text.SimpleDateFormat.
*
*/
@JSFProperty
public String getPattern()
{
return _pattern;
}
public void setPattern(String pattern)
{
_pattern = pattern;
clearInitialState();
}
public boolean isTransient()
{
return _transient;
}
public void setTransient(boolean aTransient)
{
_transient = aTransient;
}
/**
* The type of formatting/parsing to be performed. Values include:
* number, currency, and percent. Default: number.
*
*/
@JSFProperty
public String getType()
{
return _type;
}
public void setType(String type)
{
//TODO: validate type
_type = type;
clearInitialState();
}
private DecimalFormatSymbols getDecimalFormatSymbols()
{
return new DecimalFormatSymbols(getLocale());
}
private boolean _initialStateMarked = false;
public void clearInitialState()
{
_initialStateMarked = false;
}
public boolean initialStateMarked()
{
return _initialStateMarked;
}
public void markInitialState()
{
_initialStateMarked = true;
}
}