Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

annotation driven number formatting with default number formatting rules

Browse Source
This commit is contained in:
Keith Donald
2009-11-11 18:53:02 +00:00
parent bfffb51257
commit b56a47da97
12 changed files with 335 additions and 225 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
org.springframework.context/src/main/java/org/springframework/format/annotation/NumberFormat.java Normal file
View File

@@ -0,0 +1,80 @@
/*
* Copyright 2002-2009 the original author or authors.
*
* Licensed 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 org.springframework.format.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Declares that a field should be formatted as a number.
* Supports formatting by style or custom pattern string.
* Can be applied to any JDK <code>java.lang.Number</code> type.
* <p>
* For style-based formatting, set the {@link #style()} attribute to be the desired {@link Style}.
* For custom formatting, set the {@link #pattern()} attribute to be the number pattern, such as <code>#,###.##</code>.
* <p>
* Each attribute is mutually exclusive, so only set one attribute per annotation instance (the one most convenient one for your formatting needs).
* When the pattern attribute is specified, it takes precedence over the style attribute.
* When no annotation attributes are specified, the default format applied is style-based with a style of {@link Style#NUMBER}.
*
* @author Keith Donald
* @since 3.0
* @see org.joda.time.format.DateTimeFormat
*/
@Target( { ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
public @interface NumberFormat {
/**
* The style pattern to use to format the field.
* Defaults to {@link Style#NUMBER} for general-purpose number formatter.
* Set this attribute when you wish to format your field in accordance with a common style other than the default style.
*/
Style style() default Style.NUMBER;
/**
* The custom pattern to use to format the field.
* Defaults to empty String, indicating no custom pattern String has been specified.
* Set this attribute when you wish to format your field in accordance with a custom number pattern not represented by a style.
*/
String pattern() default "";
/**
* Common number format styles.
* @author Keith Donald
* @since 3.0
*/
public enum Style {
/**
* General-purpose number format for the current locale.
*/
NUMBER,
/**
* A currency format for the current locale.
*/
CURRENCY,
/**
* A percent format for the current locale.
*/
PERCENT
}
}

2
org.springframework.context/src/main/java/org/springframework/format/number/AbstractNumberFormatter.java
View File

@@ -35,7 +35,6 @@ public abstract class AbstractNumberFormatter implements Formatter<Number> {
private boolean lenient = false;
/**
* Specify whether or not parsing is to be lenient. Default is false.
* <p>With lenient parsing, the parser may allow inputs that do not precisely match the format.
@@ -45,7 +44,6 @@ public abstract class AbstractNumberFormatter implements Formatter<Number> {
this.lenient = lenient;
}
public String print(Number integer, Locale locale) {
return getNumberFormat(locale).format(integer);
}

39
org.springframework.context/src/main/java/org/springframework/format/number/IntegerFormatter.java
View File

@@ -1,39 +0,0 @@
/*
* Copyright 2002-2009 the original author or authors.
*
* Licensed 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 org.springframework.format.number;
import java.text.NumberFormat;
import java.util.Locale;
/**
* A Number formatter for whole integer values.
*
* <p>Delegates to {@link NumberFormat#getIntegerInstance(Locale)}.
* The {@link #parse(String, Locale)} routine always returns a Long.
*
* @author Keith Donald
* @author Juergen Hoeller
* @since 3.0
* @see #setLenient
*/
public final class IntegerFormatter extends AbstractNumberFormatter {
protected NumberFormat getNumberFormat(Locale locale) {
return NumberFormat.getIntegerInstance(locale);
}
}

11
org.springframework.context/src/main/java/org/springframework/format/number/DecimalFormatter.java → org.springframework.context/src/main/java/org/springframework/format/number/NumberFormatter.java
View File

@@ -21,7 +21,7 @@ import java.text.NumberFormat;
import java.util.Locale;
/**
* A Number formatter for decimal values.
* A general-purpose Number formatter.
*
* <p>Delegates to {@link NumberFormat#getInstance(Locale)}.
* Configures BigDecimal parsing so there is no loss in precision.
@@ -34,10 +34,17 @@ import java.util.Locale;
* @see #setPattern
* @see #setLenient
*/
public final class DecimalFormatter extends AbstractNumberFormatter {
public final class NumberFormatter extends AbstractNumberFormatter {
private String pattern;
public NumberFormatter() {
}
public NumberFormatter(String pattern) {
this.pattern = pattern;
}
/**
* Sets the pattern to use to format number values.

8
org.springframework.context/src/main/java/org/springframework/format/support/FormattingConversionServiceFactoryBean.java
View File

@@ -19,6 +19,8 @@ import org.springframework.beans.factory.FactoryBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.core.convert.ConversionService;
import org.springframework.format.datetime.joda.JodaTimeFormattingConfigurer;
import org.springframework.format.number.NumberFormatAnnotationFormatterFactory;
import org.springframework.format.number.NumberFormatter;
import org.springframework.util.ClassUtils;
/**
@@ -40,6 +42,7 @@ public class FormattingConversionServiceFactoryBean implements FactoryBean<Conve
public void afterPropertiesSet() {
initConversionService();
installNumberFormatting();
installJodaTimeFormattingIfPresent();
}
@@ -67,6 +70,11 @@ public class FormattingConversionServiceFactoryBean implements FactoryBean<Conve
}
}
private void installNumberFormatting() {
this.conversionService.addFormatterForFieldType(Number.class, new NumberFormatter());
this.conversionService.addFormatterForFieldAnnotation(new NumberFormatAnnotationFormatterFactory());
}
private void installJodaTimeFormattingIfPresent() {
if (ClassUtils.isPresent("org.joda.time.DateTime", FormattingConversionService.class.getClassLoader())) {
new JodaTimeFormattingConfigurer().installJodaTimeFormatting(this.conversionService);

54
org.springframework.context/src/test/java/org/springframework/format/number/IntegerFormatterTests.java
View File

@@ -1,54 +0,0 @@
/*
* Copyright 2002-2009 the original author or authors.
*
* Licensed 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 org.springframework.format.number;
import static org.junit.Assert.assertEquals;
import java.text.ParseException;
import java.util.Locale;
import org.junit.Test;
import org.springframework.format.number.IntegerFormatter;
/**
* @author Keith Donald
*/
public class IntegerFormatterTests {
private IntegerFormatter formatter = new IntegerFormatter();
@Test
public void formatValue() {
assertEquals("23", formatter.print(23L, Locale.US));
}
@Test
public void parseValue() throws ParseException {
assertEquals((Long) 2356L, formatter.parse("2356", Locale.US));
}
@Test(expected = ParseException.class)
public void parseBogusValue() throws ParseException {
formatter.parse("bogus", Locale.US);
}
@Test(expected = ParseException.class)
public void parsePercentValueNotLenientFailure() throws ParseException {
formatter.parse("23.56", Locale.US);
}
}

6
org.springframework.context/src/test/java/org/springframework/format/number/DecimalFormatterTests.java → org.springframework.context/src/test/java/org/springframework/format/number/NumberFormatterTests.java
View File

@@ -23,14 +23,14 @@ import java.text.ParseException;
import java.util.Locale;
import org.junit.Test;
import org.springframework.format.number.DecimalFormatter;
import org.springframework.format.number.NumberFormatter;
/**
* @author Keith Donald
*/
public class DecimalFormatterTests {
public class NumberFormatterTests {
private DecimalFormatter formatter = new DecimalFormatter();
private NumberFormatter formatter = new NumberFormatter();
@Test
public void formatValue() {

136
org.springframework.context/src/test/java/org/springframework/format/number/NumberFormattingTests.java Normal file
View File

@@ -0,0 +1,136 @@
package org.springframework.format.number;
import static org.junit.Assert.assertEquals;
import java.math.BigDecimal;
import java.util.Locale;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.springframework.beans.MutablePropertyValues;
import org.springframework.context.i18n.LocaleContextHolder;
import org.springframework.format.annotation.NumberFormat;
import org.springframework.format.annotation.NumberFormat.Style;
import org.springframework.format.support.FormattingConversionService;
import org.springframework.validation.DataBinder;
public class NumberFormattingTests {
private FormattingConversionService conversionService = new FormattingConversionService();
private DataBinder binder;
@Before
public void setUp() {
conversionService.addFormatterForFieldType(Number.class, new NumberFormatter());
conversionService.addFormatterForFieldAnnotation(new NumberFormatAnnotationFormatterFactory());
LocaleContextHolder.setLocale(Locale.US);
binder = new DataBinder(new TestBean());
binder.setConversionService(conversionService);
}
@After
public void tearDown() {
LocaleContextHolder.setLocale(null);
}
@Test
public void testDefaultNumberFormatting() {
MutablePropertyValues propertyValues = new MutablePropertyValues();
propertyValues.addPropertyValue("numberDefault", "3,339.12");
binder.bind(propertyValues);
assertEquals(0, binder.getBindingResult().getErrorCount());
assertEquals("3,339", binder.getBindingResult().getFieldValue("numberDefault"));
}
@Test
public void testDefaultNumberFormattingAnnotated() {
MutablePropertyValues propertyValues = new MutablePropertyValues();
propertyValues.addPropertyValue("numberDefaultAnnotated", "3,339.12");
binder.bind(propertyValues);
assertEquals(0, binder.getBindingResult().getErrorCount());
assertEquals("3,339.12", binder.getBindingResult().getFieldValue("numberDefaultAnnotated"));
}
@Test
public void testCurrencyFormatting() {
MutablePropertyValues propertyValues = new MutablePropertyValues();
propertyValues.addPropertyValue("currency", "$3,339.12");
binder.bind(propertyValues);
assertEquals(0, binder.getBindingResult().getErrorCount());
assertEquals("$3,339.12", binder.getBindingResult().getFieldValue("currency"));
}
@Test
public void testPercentFormatting() {
MutablePropertyValues propertyValues = new MutablePropertyValues();
propertyValues.addPropertyValue("percent", "53%");
binder.bind(propertyValues);
assertEquals(0, binder.getBindingResult().getErrorCount());
assertEquals("53%", binder.getBindingResult().getFieldValue("percent"));
}
@Test
public void testPatternFormatting() {
}
public static class TestBean {
private Integer numberDefault;
@NumberFormat
private Double numberDefaultAnnotated;
@NumberFormat(style=Style.CURRENCY)
private BigDecimal currency;
@NumberFormat(style=Style.PERCENT)
private BigDecimal percent;
@NumberFormat(pattern="#,##.00")
private BigDecimal pattern;
public Integer getNumberDefault() {
return numberDefault;
}
public void setNumberDefault(Integer numberDefault) {
this.numberDefault = numberDefault;
}
public Double getNumberDefaultAnnotated() {
return numberDefaultAnnotated;
}
public void setNumberDefaultAnnotated(Double numberDefaultAnnotated) {
this.numberDefaultAnnotated = numberDefaultAnnotated;
}
public BigDecimal getCurrency() {
return currency;
}
public void setCurrency(BigDecimal currency) {
this.currency = currency;
}
public BigDecimal getPercent() {
return percent;
}
public void setPercent(BigDecimal percent) {
this.percent = percent;
}
public BigDecimal getPattern() {
return pattern;
}
public void setPattern(BigDecimal pattern) {
this.pattern = pattern;
}
}
}

43
org.springframework.context/src/test/java/org/springframework/format/support/FormattingConversionServiceFactoryBeanTests.java Normal file
View File

@@ -0,0 +1,43 @@
package org.springframework.format.support;
import static org.junit.Assert.assertEquals;
import java.math.BigDecimal;
import java.util.Date;
import java.util.Locale;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.springframework.context.i18n.LocaleContextHolder;
import org.springframework.core.convert.ConversionService;
public class FormattingConversionServiceFactoryBeanTests {
private ConversionService conversionService;
@Before
public void setUp() {
FormattingConversionServiceFactoryBean factory = new FormattingConversionServiceFactoryBean();
factory.afterPropertiesSet();
this.conversionService = factory.getObject();
LocaleContextHolder.setLocale(Locale.US);
}
@After
public void tearDown() {
LocaleContextHolder.setLocale(null);
}
@Test
public void testFormatNumber() {
BigDecimal value = conversionService.convert("3,000.25", BigDecimal.class);
assertEquals("3,000.25", conversionService.convert(value, String.class));
}
@Test
public void testFormatDate() {
Date value = conversionService.convert("10/29/09 12:00 PM", Date.class);
assertEquals("10/29/09 12:00 PM", conversionService.convert(value, String.class));
}
}

4
org.springframework.context/src/test/java/org/springframework/format/support/FormattingConversionServiceTests.java
View File

@@ -34,7 +34,7 @@ import org.springframework.core.convert.converter.Converter;
import org.springframework.format.datetime.joda.DateTimeFormatAnnotationFormatterFactory;
import org.springframework.format.datetime.joda.DateTimeParser;
import org.springframework.format.datetime.joda.ReadablePartialPrinter;
import org.springframework.format.number.IntegerFormatter;
import org.springframework.format.number.NumberFormatter;
/**
* @author Keith Donald
@@ -57,7 +57,7 @@ public class FormattingConversionServiceTests {
@Test
public void testFormatFieldForTypeWithFormatter() throws ParseException {
formattingService.addFormatterForFieldType(Number.class, new IntegerFormatter());
formattingService.addFormatterForFieldType(Number.class, new NumberFormatter());
String formatted = formattingService.convert(new Integer(3), String.class);
assertEquals("3", formatted);
Integer i = (Integer) formattingService.convert("3", Integer.class);

4
org.springframework.context/src/test/java/org/springframework/validation/DataBinderTests.java
View File

@@ -44,7 +44,7 @@ import org.springframework.context.i18n.LocaleContextHolder;
import org.springframework.context.support.ResourceBundleMessageSource;
import org.springframework.context.support.StaticMessageSource;
import org.springframework.core.convert.support.DefaultConversionService;
import org.springframework.format.number.DecimalFormatter;
import org.springframework.format.number.NumberFormatter;
import org.springframework.format.support.FormattingConversionService;
import org.springframework.util.StringUtils;
@@ -300,7 +300,7 @@ public class DataBinderTests extends TestCase {
TestBean tb = new TestBean();
DataBinder binder = new DataBinder(tb);
FormattingConversionService conversionService = new FormattingConversionService();
conversionService.addFormatterForFieldType(Float.class, new DecimalFormatter());
conversionService.addFormatterForFieldType(Float.class, new NumberFormatter());
binder.setConversionService(conversionService);
MutablePropertyValues pvs = new MutablePropertyValues();
pvs.addPropertyValue("myFloat", "1,2");