net.sf.anupam.csv.formatters

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Natural Language Processing
51.Net
52.Parser
53.PDF
54.Portal
55.Profiler
56.Project Management
57.Report
58.RSS RDF
59.Rule Engine
60.Science
61.Scripting
62.Search Engine
63.Security
64.Sevlet Container
65.Source Control
66.Swing Library
67.Template Engine
68.Test Coverage
69.Testing
70.UML
71.Web Crawler
72.Web Framework
73.Web Mail
74.Web Server
75.Web Services
76.Web Services apache cxf 2.2.6
77.Web Services AXIS2
78.Wiki Engine
79.Workflow Engines
80.XML
81.XML UI
Java Source Code / Java Documentation  » Development » CSVObjects » net.sf.anupam.csv.formatters 
net.sf.anupam.csv.formatters
net.sf.anupam.csv.formatters package Provides a framework and default implementations for formatting CSV fields during the CSV to POJO parsing. The framework is configurable and can be extended if the default formatters are not sufficient.

In most usage situations, no formatting is required on the CSV fields during parsing, and data formatting can be performed on the source CSV data itself.

However, minor formatting is necessary in certain circumstances, e.g., when only part of a CSV field value needs to be mapped to a POJO attribute. Common examples include extracting the first name from a full name, or changing the case of the input string value. This functionality is enabled by this package.

Default Formatters

The following formatters are present in the default system. The declarative formatter name is in brackets. Details on each formatter is present in the respective class' documentation.

  • {@link net.sf.anupam.csv.formatters.DoNothingFormatter DoNothingFormatter} (none)
  • {@link net.sf.anupam.csv.formatters.DoNothingFormatter firstWordFormatter} (firstWord)
  • {@link net.sf.anupam.csv.formatters.DoNothingFormatter lastWordFormatter} (lastWord)
  • {@link net.sf.anupam.csv.formatters.DoNothingFormatter AllUpperCaseFormatter} (AllUpperCase)

Configuration of Formatters

The formatters are registered into the CSV parser framework via the csv-formatter-config.xml XML file. The file defines the logical formatter name, and the formatter implementation class name.

Custom Formatters

Customer formatters can be created by implementing the {@link net.sf.anupam.csv.formatters.CSVFieldFormatter CSVFieldFormatter} interface, and its sole method: String format(String). This method acts as the transformation/formatting implementation. It is recommended that the custom formatters be stateless and provide re-entrant implementations.

Once the custom formatters are defined, they can be registered in the Framework by updating the csv-formatter-config.xml configuration file. A custom Xdoclet template/tagset is provided for ease of generating the configuration XML file.

Java Source File NameTypeComment
AllLowerCaseFormatter.javaClass A CSVFieldFormatter Formatter which transforms the input into all lower-case and returns the lower-case version.
AllUpperCaseFormatter.javaClass A CSVFieldFormatter Formatter which transforms the input into all upper case and returns the upper case version.
AllUpperCaseFormatterTest.javaClass AllUpperCaseFormatterTest.
CSVFieldFormatter.javaInterface Main Interface for a CSV field formatter.
CSVFormatterConfigParser.javaClass XML Parser (based on Commons Digester) to parse and return the CSV formatter configuration.
CSVFormatterConfigParserTest.javaClass CSVFormatterConfigParserTest.
CSVFormatterFactory.javaClass A singleton factory which creates and caches the CSVFieldFormatter csv field formatters .
DoNothingFormatter.javaClass A No-Op CSVFieldFormatter formatter that acts as the default if no explicit formatter is configured for a CSV field.
FirstWordFormatter.javaClass A CSVFieldFormatter formatter that returns the first word of the specified CSV value.
FirstWordFormatterTest.javaClass FirstWordFormatterTest.
FormatterConfiguration.javaClass FormatConfiguration.
LastWordFormatter.javaClass A CSVFieldFormatter formatter that returns the last word of the specified CSV value.
LastWordFormatterTest.javaClass LastWordFormatterTest.
TrimWordFormatter.javaClass A CSVFieldFormatter formatter that returns the trimmed CSV value.
TrimWordFormatterTest.javaClass TrimWordFormatterTest.
w__w_w___.___j__a__va_2__s._c_o__m_ | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.