|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.csvreader.CsvReader
A stream based parser for parsing delimited text data from a file or a stream.
Nested Class Summary | |
class |
CsvReader.CatastrophicException
A critical exception has occurred internally within an object. |
class |
CsvReader.FinalizedException
Methods are being called on an object that has already been finalized. |
Field Summary | |
static int |
ESCAPE_MODE_BACKSLASH
Use a backslash character before the text qualifier to represent an occurance of the text qualifier. |
static int |
ESCAPE_MODE_DOUBLED
Double up the text qualifier to represent an occurance of the text qualifier. |
Constructor Summary | |
CsvReader(InputStream inputStream,
char delimiter,
Charset charset)
Constructs a CsvReader object using
an InputStream object as the data
source. |
|
CsvReader(InputStream inputStream,
Charset charset)
Constructs a CsvReader object using
an InputStream object as the data
source. |
|
CsvReader(Reader inputStream)
Constructs a CsvReader object using
a Reader object as the data
source. |
|
CsvReader(Reader inputStream,
char delimiter)
Constructs a CsvReader object using
a Reader object as the data
source. |
|
CsvReader(String fileName)
Creates a CsvReader object using a
file as the data source. |
|
CsvReader(String fileName,
char delimiter)
Creates a CsvReader object using a
file as the data source. |
|
CsvReader(String fileName,
char delimiter,
Charset charset)
Creates a CsvReader object using a
file as the data source. |
Method Summary | |
void |
close()
Closes and releases all related resources. |
String |
get(int columnIndex)
Returns the current column value for a given column index. |
String |
get(String headerName)
Returns the current column value for a given column header name. |
int |
getColumnCount()
Gets the count of columns found in this record. |
char |
getComment()
Gets the character being used as a comment signal. |
long |
getCurrentRecord()
Gets the index of the current record. |
char |
getDelimiter()
Gets the character being used as the column delimiter. |
int |
getEscapeMode()
Gets the current way to escape an occurance of the text qualifier inside qualified data. |
String |
getHeader(int columnIndex)
Returns the column header value for a given column index. |
int |
getHeaderCount()
Gets the count of headers read in by a previous call to readHeaders() . |
String[] |
getHeaders()
Returns the header values as a string array. |
int |
getIndex(String headerName)
Gets the corresponding column index for a given column header name. |
int |
getLength(int columnIndex)
Returns the length of a column without doing extra work to find the column's actual value. |
boolean |
getMergeConsecutive()
Gets whether consecutive instances of the delimiter are being merged into one or not. |
char |
getTextQualifier()
Gets the character to use as a text qualifier in the data. |
boolean |
getTrimWhitespace()
Gets whether leading and trailing whitespace characters are being trimmed from non-textqualified column data. |
boolean |
getUseComments()
Gets whether comments are being looked for while parsing or not. |
boolean |
getUseTextQualifier()
Whether text qualifiers will be used while parsing or not. |
static CsvReader |
parse(String data)
Creates a CsvReader object using
a string of data as the source. |
boolean |
readHeaders()
Read the first record of data as column headers. |
boolean |
readRecord()
Reads another record. |
void |
setComment(char comment)
Sets the character to use as a comment signal. |
void |
setDelimiter(char delimiter)
Sets the character to use as the column delimiter. |
void |
setEscapeMode(int escapeMode)
Sets the current way to escape an occurance of the text qualifier inside qualified data. |
void |
setMergeConsecutive(boolean mergeConsecutive)
Sets whether consecutive instances of the delimiter are being merged into one or not. |
void |
setRowDelimiter(char rowDelimiter)
Sets the character to use as the row delimiter. |
void |
setTextQualifier(char textQualifier)
Sets the character to use as a text qualifier in the data. |
void |
setTrimWhitespace(boolean trimWhitespace)
Sets whether leading and trailing whitespace characters should be trimmed from non-textqualified column data or not. |
void |
setUseComments(boolean useComments)
Sets whether comments are being looked for while parsing or not. |
void |
setUseTextQualifier(boolean useTextQualifier)
Sets whether text qualifiers will be used while parsing or not. |
boolean |
skipLine()
Skips the next line of data using the standard end of line characters and does not do any column delimited parsing. |
boolean |
skipRecord()
Skips the next record of data by parsing each column. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int ESCAPE_MODE_DOUBLED
public static final int ESCAPE_MODE_BACKSLASH
Constructor Detail |
public CsvReader(String fileName, char delimiter, Charset charset)
CsvReader
object using a
file as the data source.
fileName
- The path to the file to use as the data source.delimiter
- The character to use as the column delimiter.charset
- The Charset
to use while parsing the data.public CsvReader(String fileName, char delimiter)
CsvReader
object using a
file as the data source. Uses ISO-8859-1 as the Charset
.
fileName
- The path to the file to use as the data source.delimiter
- The character to use as the column delimiter.public CsvReader(String fileName)
CsvReader
object using a
file as the data source. Uses a comma as the column
delimiter and ISO-8859-1 as the Charset
.
fileName
- The path to the file to use as the data source.public CsvReader(Reader inputStream, char delimiter)
CsvReader
object using
a Reader
object as the data
source.
inputStream
- The stream to use as the data source.delimiter
- The character to use as the column delimiter.public CsvReader(Reader inputStream)
CsvReader
object using
a Reader
object as the data
source. Uses a comma as the column delimiter.
inputStream
- The stream to use as the data source.public CsvReader(InputStream inputStream, char delimiter, Charset charset)
CsvReader
object using
an InputStream
object as the data
source.
inputStream
- The stream to use as the data source.delimiter
- The character to use as the column delimiter.charset
- The Charset
to use while parsing the data.public CsvReader(InputStream inputStream, Charset charset)
CsvReader
object using
an InputStream
object as the data
source. Uses a comma as the column delimiter.
inputStream
- The stream to use as the data source.charset
- The Charset
to use while parsing the data.Method Detail |
public int getColumnCount()
public long getCurrentRecord()
public boolean getTrimWhitespace()
public void setTrimWhitespace(boolean trimWhitespace)
trimWhitespace
- Whether leading and trailing whitespace characters
should be trimmed from non-textqualified column data
or not.public char getDelimiter()
public void setDelimiter(char delimiter)
delimiter
- The character to use as the column delimiter.public void setRowDelimiter(char rowDelimiter)
rowDelimiter
- The character to use as the row delimiter.
Default is combination of standard end of line characters
for Windows, Unix, or Mac.public int getEscapeMode()
public void setEscapeMode(int escapeMode) throws IllegalArgumentException
escapeMode
- The way to escape an occurance of the text
qualifier inside qualified data.
IllegalArgumentException
- When an illegal value is specified for escapeMode.public boolean getUseTextQualifier()
public void setUseTextQualifier(boolean useTextQualifier)
useTextQualifier
- Whether to use a text qualifier while parsing or not.public char getTextQualifier()
public void setTextQualifier(char textQualifier)
textQualifier
- The character to use as a text qualifier in the data.public char getComment()
public void setComment(char comment)
comment
- The character to use as a comment signal.public boolean getUseComments()
public void setUseComments(boolean useComments)
useComments
- Whether comments are being looked for while parsing or not.public boolean getMergeConsecutive()
public void setMergeConsecutive(boolean mergeConsecutive)
mergeConsecutive
- Whether to merge consecutive instances of the delimiter into one.public String[] getHeaders() throws CsvReader.FinalizedException
CsvReader.FinalizedException
- Thrown if this object has already been closed
or finalized.public int getHeaderCount()
readHeaders()
.
readHeaders()
.public String get(int columnIndex) throws CsvReader.FinalizedException
columnIndex
- The index of the column.
CsvReader.FinalizedException
- Thrown if this object has already been closed
or finalized.public String get(String headerName) throws CsvReader.FinalizedException
headerName
- The header name of the column.
CsvReader.FinalizedException
- Thrown if this object has already been closed
or finalized.public static CsvReader parse(String data)
CsvReader
object using
a string of data as the source. Uses ISO-8859-1 as the Charset
.
data
- The String of data to use as the source.
CsvReader
object using
the String of data as the source.public boolean readRecord() throws IOException, CsvReader.FinalizedException, CsvReader.CatastrophicException
IOException
- Thrown if an error occurs while reading data
from the source stream.
CsvReader.FinalizedException
- Thrown if this object has already been closed
or finalized.
CsvReader.CatastrophicException
- Thrown if a very rare extreme exception occurs during
parsing, normally resulting from improper data format.public boolean readHeaders() throws IOException, CsvReader.FinalizedException, CsvReader.CatastrophicException
IOException
- Thrown if an error occurs while reading data
from the source stream.
CsvReader.FinalizedException
- Thrown if this object has already been closed
or finalized.
CsvReader.CatastrophicException
- Thrown if a very rare extreme exception occurs during
parsing, normally resulting from improper data format.public String getHeader(int columnIndex) throws CsvReader.FinalizedException
columnIndex
- The index of the header column being requested.
CsvReader.FinalizedException
- Thrown if this object has already been closed
or finalized.public int getIndex(String headerName) throws CsvReader.FinalizedException
headerName
- The header name of the column.
CsvReader.FinalizedException
- Thrown if this object has already been closed
or finalized.public boolean skipRecord() throws IOException, CsvReader.FinalizedException, CsvReader.CatastrophicException
getCurrentRecord()
.
IOException
- Thrown if an error occurs while reading data
from the source stream.
CsvReader.FinalizedException
- Thrown if this object has already been closed
or finalized.
CsvReader.CatastrophicException
- Thrown if a very rare extreme exception occurs during
parsing, normally resulting from improper data format.public boolean skipLine() throws IOException, CsvReader.FinalizedException
IOException
- Thrown if an error occurs while reading data
from the source stream.
CsvReader.FinalizedException
- Thrown if this object has already been closed
or finalized.public int getLength(int columnIndex) throws CsvReader.FinalizedException
columnIndex
- The index of the header column being requested.
CsvReader.FinalizedException
- Thrown if this object has already been closed
or finalized.public void close()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |