Java Doc for LabeledCSVParser.java in  » Portal » Open-Portal » com » sun » portal » ubt » report » data » file » parser » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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 geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Portal » Open Portal » com.sun.portal.ubt.report.data.file.parser 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.sun.portal.ubt.report.data.file.parser.LabeledCSVParser

LabeledCSVParser
public class LabeledCSVParser implements CSVParse(Code)
Decorate a CSVParse object to provide an index of field names. Many (most?) CSV files have a list of field names (labels) as the first line. A LabeledCSVParser will consume this line automatically. The methods LabeledCSVParser.getLabels() , LabeledCSVParser.getLabelIndex(String) and LabeledCSVParser.getValueByLabel(String) allow these labels to be discovered and used while parsing CSV data. This class can also be used to conveniently ignore field labels if they happen to be present in a CSV file and are not desired.



Constructor Summary
public  LabeledCSVParser(CSVParse parse)
     Construct a LabeledCSVParser on a CSVParse implementation.

Method Summary
public  voidchangeDelimiter(char newDelim)
     Change this parser so that it uses a new delimiter.
public  voidchangeQuote(char newQuote)
     Change this parser so that it uses a new character for quoting.
public  voidclose()
     Close any stream upon which this parser is based.
public  String[][]getAllValues()
     Get all the values from the file.

If the file has already been partially read, only the values that have not already been read will be included.

Each line of the file that has at least one value will be represented.

public  intgetLabelIndex(String label)
     Get the index of the column having the given label. The LabeledCSVParser.getLine() method returns an array of field values for a single record of data.
public  String[]getLabels()
     Return an array of all field names from the top of the CSV file.
public  intgetLastLineNumber()
     Get the line number that the last token came from.
public  String[]getLine()
     Get all the values from a line.

If the line has already been partially read, only the values that have not already been read will be included.

In addition to returning all the values from a line, LabeledCSVParser maintains a buffer of the values.

public  StringgetValueByLabel(String label)
     Given the label for the column, get the column from the last line that was read.
public  intlastLineNumber()
     Get the line number that the last token came from.
public  StringnextValue()
     Read the next value from the file.
public  voidsetLabels(HashMap labelMap)
    


Constructor Detail
LabeledCSVParser
public LabeledCSVParser(CSVParse parse) throws IOException(Code)
Construct a LabeledCSVParser on a CSVParse implementation.
Parameters:
  parse - CSVParse implementation
throws:
  IOException - if an error occurs while reading.




Method Detail
changeDelimiter
public void changeDelimiter(char newDelim) throws BadDelimiterException(Code)
Change this parser so that it uses a new delimiter.

The initial character is a comma, the delimiter cannot be changed to a quote or other character that has special meaning in CSV.
Parameters:
  newDelim - delimiter to which to switch.
throws:
  com.sun.portal.ubt.report.data.file.parser.BadDelimiterException - if the character cannot be used as a delimiter.




changeQuote
public void changeQuote(char newQuote) throws BadQuoteException(Code)
Change this parser so that it uses a new character for quoting.

The initial character is a double quote ("), the delimiter cannot be changed to a comma or other character that has special meaning in CSV.
Parameters:
  newQuote - character to use for quoting.
throws:
  BadQuoteException - if the character cannot be used as a quote.




close
public void close() throws IOException(Code)
Close any stream upon which this parser is based.
throws:
  IOException - if an error occurs while closing the stream.



getAllValues
public String[][] getAllValues() throws IOException(Code)
Get all the values from the file.

If the file has already been partially read, only the values that have not already been read will be included.

Each line of the file that has at least one value will be represented. Comments and empty lines are ignored.

The resulting double array may be jagged.

The last line of the values is saved and may be accessed by getValueByLabel(). all the values from the file or null if there are no more values.
throws:
  IOException - if an error occurs while reading.




getLabelIndex
public int getLabelIndex(String label)(Code)
Get the index of the column having the given label. The LabeledCSVParser.getLine() method returns an array of field values for a single record of data. This method returns the index of a member of that array based on the specified field name. The first field has the index 0.
Parameters:
  label - The field name. The index of the field name, or -1 if the label does not exist.



getLabels
public String[] getLabels() throws IOException(Code)
Return an array of all field names from the top of the CSV file. Field names.



getLastLineNumber
public int getLastLineNumber()(Code)
Get the line number that the last token came from.

New line breaks that occur in the middle of a token are not counted in the line number count.

The first line of labels does not count towards the line number. line number or -1 if no tokens have been returned yet.




getLine
public String[] getLine() throws IOException(Code)
Get all the values from a line.

If the line has already been partially read, only the values that have not already been read will be included.

In addition to returning all the values from a line, LabeledCSVParser maintains a buffer of the values. This feature allows LabeledCSVParser.getValueByLabel(String) to function. In this case LabeledCSVParser.getLine() is used simply to iterate CSV data. The iteration ends when null is returned.

Note: The methods LabeledCSVParser.nextValue() and LabeledCSVParser.getAllValues() are incompatible with LabeledCSVParser.getValueByLabel(String) because the former methods cause the offset of field values to shift and corrupt the internal buffer maintained by LabeledCSVParser.getLine . all the values from the line or null if there are no more values.
throws:
  IOException - if an error occurs while reading.




getValueByLabel
public String getValueByLabel(String label) throws IllegalStateException(Code)
Given the label for the column, get the column from the last line that was read. If the column cannot be found in the line, null is returned.
Parameters:
  label - The field name.
throws:
  IllegalStateException - if nextValue has been called as part of getting the last line. nextValue is not compatible with this method.



lastLineNumber
public int lastLineNumber()(Code)
Get the line number that the last token came from.

New line breaks that occur in the middle of a token are not counted in the line number count.

The first line of labels does not count towards the line number. line number or -1 if no tokens have been returned yet.




nextValue
public String nextValue() throws IOException(Code)
Read the next value from the file. The line number from which this value was taken can be obtained from getLastLineNumber().

This method is not compatible with getValueByLabel(). Using this method will make getValueByLabel() throw an IllegalStateException for the rest of the line. the next value or null if there are no more values.
throws:
  IOException - if an error occurs while reading.




setLabels
public void setLabels(HashMap labelMap) throws IOException(Code)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

w__w_w_._j_a_v__a2s___.c_o___m_ | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.