| java.lang.Object
 com.bm.utils.csv.CSVParser
| CSVParser | | public class CSVParser implements CSVParse(Code) | | CSV is a file format used as a portable representation of a database. Each
line is one entry or record and the fields in a record are separated by
commas. Commas may be preceded or followed by arbitrary space and/or tab
characters which are ignored.
If field includes a comma or a new line, the whole field must be surrounded
with double quotes. When the field is in quotes, any quote literals must be
escaped by \" Backslash literals must be escaped by \\. Otherwise a backslash
and the character following will be treated as the following character, IE.
"\n" is equivalent to "n". Other escape sequences may be set using the
setEscapes() method. Text that comes after quotes that have been closed but
come before the next comma will be ignored.
Empty fields are returned as as String of length zero: "". The following line
has three empty fields and three non-empty fields in it. There is an empty
field on each end, and one in the middle. One token is returned as a space.
,second,," ",fifth,
Blank lines are always ignored. Other lines will be ignored if they start
with a comment character as set by the setCommentStart() method.
An example of how CVSLexer might be used:
CSVParser shredder = new CSVParser(System.in);
shredder.setCommentStart("#;!");
shredder.setEscapes("nrtf", "\n\r\t\f");
String t;
while ((t = shredder.nextValue()) != null) {
System.out.println("" + shredder.lastLineNumber() + " " + t);
}
Some applications do not output CSV according to the generally accepted
standards and this parse may not be able to handle it. One such application
is the Microsoft Excel spreadsheet. A separate class must be use to read
author:
Daniel Wiese
since:
17.04.2006 |
| Constructor Summary | |
| public | CSVParser(InputStream in)
Create a parser to parse comma separated values from an InputStream. | | public | CSVParser(InputStream in, char delimiter)
Create a parser to parse delimited values from an InputStream. | | public | CSVParser(Reader in)
Create a parser to parse comma separated values from a Reader. | | public | CSVParser(Reader in, char delimiter)
Create a parser to parse delimited values from a Reader. | | public | CSVParser(InputStream in, char delimiter, String escapes, String replacements, String commentDelims)
Create a parser to parse delimited values from an InputStream. | | public | CSVParser(InputStream in, String escapes, String replacements, String commentDelims)
Create a parser to parse comma separated values from an InputStream. | | public | CSVParser(Reader in, char delimiter, String escapes, String replacements, String commentDelims)
Create a parser to parse delimited values from a Reader. | | public | CSVParser(Reader in, String escapes, String replacements, String commentDelims)
Create a parser to parse comma separated values from a Reader. |
| Method Summary | |
| public void | changeDelimiter(char newDelim)
Change this parser so that it uses a new delimiter. | | public void | changeQuote(char newQuote)
Change this parser so that it uses a new character for quoting. | | public void | close()
Close any stream upon which this parser is based. | | public int | getLastLineNumber()
Get the number of the line from which the last value was retrieved. | | public int | lastLineNumber()
Get the line number that the last token came from. | | public String | nextValue()
get the next value. | | public void | setCommentStart(String commentDelims)
Set the characters that indicate a comment at the beginning of the line.
For example if the string "#;!" were passed in, all of the following
lines would be comments:
# Comment
; Another Comment
! Yet another comment
By default there are no comments in CVS files. | | public void | setEscapes(String escapes, String replacements)
Specify escape sequences and their replacements. |
| CSVParser | | public CSVParser(InputStream in)(Code) | | Create a parser to parse comma separated values from an InputStream.
Byte to character conversion is done using the platform default locale.
Parameters:
in - stream that contains comma separated values. |
| CSVParser | | public CSVParser(InputStream in, char delimiter)(Code) | | Create a parser to parse delimited values from an InputStream.
Byte to character conversion is done using the platform default locale.
Parameters:
in - stream that contains comma separated values.
Parameters:
delimiter - record separator
throws:
BadDelimiterException - if the specified delimiter cannot be used |
| CSVParser | | public CSVParser(Reader in)(Code) | | Create a parser to parse comma separated values from a Reader.
Parameters:
in - reader that contains comma separated values. |
| CSVParser | | public CSVParser(Reader in, char delimiter)(Code) | | Create a parser to parse delimited values from a Reader.
Parameters:
in - reader that contains comma separated values.
Parameters:
delimiter - record separator
throws:
BadDelimiterException - if the specified delimiter cannot be used |
| CSVParser | | public CSVParser(InputStream in, char delimiter, String escapes, String replacements, String commentDelims)(Code) | | Create a parser to parse delimited values from an InputStream.
Byte to character conversion is done using the platform default locale.
Parameters:
in - stream that contains comma separated values.
Parameters:
escapes - a list of characters that will represent escape sequences.
Parameters:
replacements - the list of replacement characters for those escape sequences.
Parameters:
commentDelims - list of characters a comment line may start with.
Parameters:
delimiter - record separator
throws:
BadDelimiterException - if the specified delimiter cannot be used |
| CSVParser | | public CSVParser(InputStream in, String escapes, String replacements, String commentDelims)(Code) | | Create a parser to parse comma separated values from an InputStream.
Byte to character conversion is done using the platform default locale.
Parameters:
in - stream that contains comma separated values.
Parameters:
escapes - a list of characters that will represent escape sequences.
Parameters:
replacements - the list of replacement characters for those escape sequences.
Parameters:
commentDelims - list of characters a comment line may start with. |
| CSVParser | | public CSVParser(Reader in, char delimiter, String escapes, String replacements, String commentDelims)(Code) | | Create a parser to parse delimited values from a Reader.
Parameters:
in - reader that contains comma separated values.
Parameters:
escapes - a list of characters that will represent escape sequences.
Parameters:
replacements - the list of replacement characters for those escape sequences.
Parameters:
commentDelims - list of characters a comment line may start with.
Parameters:
delimiter - record separator
throws:
BadDelimiterException - if the specified delimiter cannot be used |
| CSVParser | | public CSVParser(Reader in, String escapes, String replacements, String commentDelims)(Code) | | Create a parser to parse comma separated values from a Reader.
Parameters:
in - reader that contains comma separated values.
Parameters:
escapes - a list of characters that will represent escape sequences.
Parameters:
replacements - the list of replacement characters for those escape sequences.
Parameters:
commentDelims - list of characters a comment line may start with. |
| changeDelimiter | | public void changeDelimiter(char newDelim)(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:
BadDelimiterException - if the character cannot be used as a delimiter. |
| changeQuote | | public void changeQuote(char newQuote)(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. |
| getLastLineNumber | | public int getLastLineNumber()(Code) | | Get the number of the line from which the last value was retrieved.
line number or -1 if no tokens have been returned. |
| 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 no counted in the
line number count.
line number or -1 if no tokens have been returned yet. |
| nextValue | | public String nextValue() throws IOException(Code) | | get the next value.
the next value or null if there are no more values.
throws:
IOException - if an error occurs while reading. |
| setCommentStart | | public void setCommentStart(String commentDelims)(Code) | | Set the characters that indicate a comment at the beginning of the line.
For example if the string "#;!" were passed in, all of the following
lines would be comments:
# Comment
; Another Comment
! Yet another comment
By default there are no comments in CVS files. Commas and quotes may not
be used to indicate comment lines.
Parameters:
commentDelims - list of characters a comment line may start with. |
| setEscapes | | public void setEscapes(String escapes, String replacements)(Code) | | Specify escape sequences and their replacements. Escape sequences set
here are in addition to \\ and \". \\ and \" are always valid escape
sequences. This method allows standard escape sequenced to be used. For
example "\n" can be set to be a newline rather than an 'n'. A common way
to call this method might be:
setEscapes("nrtf", "\n\r\t\f");
which would set the escape sequences to be the Java escape sequences.
Characters that follow a \ that are not escape sequences will still be
interpreted as that character.
The two arguments to this method must be the same length. If they are
not, the longer of the two will be truncated.
Parameters:
escapes - a list of characters that will represent escape sequences.
Parameters:
replacements - the list of replacement characters for those escape sequences. |
|
|