public class CsvReader extends Object
限定符和类型 | 字段和说明 |
---|---|
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.
|
构造器和说明 |
---|
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)
|
CsvReader(Reader inputStream,
char delimiter)
|
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. |
限定符和类型 | 方法和说明 |
---|---|
void |
close()
Closes and releases all related resources.
|
protected void |
finalize() |
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.
|
boolean |
getCaptureRawRecord() |
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.
|
String |
getRawRecord() |
char |
getRecordDelimiter() |
boolean |
getSafetySwitch()
Safety caution to prevent the parser from using large amounts of memory
in the case where parsing settings like file encodings don't end up
matching the actual format of a file.
|
boolean |
getSkipEmptyRecords() |
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.
|
String[] |
getValues() |
boolean |
isQualified(int columnIndex) |
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 |
setCaptureRawRecord(boolean captureRawRecord) |
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 |
setHeaders(String[] headers) |
void |
setRecordDelimiter(char recordDelimiter)
Sets the character to use as the record delimiter.
|
void |
setSafetySwitch(boolean safetySwitch)
Safety caution to prevent the parser from using large amounts of memory
in the case where parsing settings like file encodings don't end up
matching the actual format of a file.
|
void |
setSkipEmptyRecords(boolean skipEmptyRecords) |
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.
|
public static final int ESCAPE_MODE_DOUBLED
public static final int ESCAPE_MODE_BACKSLASH
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.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(Reader inputStream, char delimiter)
inputStream
- The stream to use as the data source.delimiter
- The character to use as the column delimiter.public CsvReader(String fileName) throws FileNotFoundException
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.FileNotFoundException
- FileNotFoundExceptionpublic CsvReader(String fileName, char delimiter) throws FileNotFoundException
fileName
- The path to the file to use as the data source.delimiter
- The character to use as the column delimiter.FileNotFoundException
- FileNotFoundExceptionpublic CsvReader(String fileName, char delimiter, Charset charset) throws FileNotFoundException
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.FileNotFoundException
- FileNotFoundExceptionpublic static CsvReader parse(String data)
data
- The String of data to use as the source.CsvReader
object using the String of data as the source.public void close()
public String get(int columnIndex) throws IOException
columnIndex
- The index of the column.IOException
- Thrown if this object has already been closed.public String get(String headerName) throws IOException
headerName
- The header name of the column.IOException
- Thrown if this object has already been closed.public boolean getCaptureRawRecord()
public int getColumnCount()
public char getComment()
public long getCurrentRecord()
public char getDelimiter()
public int getEscapeMode()
public String getHeader(int columnIndex) throws IOException
columnIndex
- The index of the header column being requested.IOException
- Thrown if this object has already been closed.public int getHeaderCount()
readHeaders()
.readHeaders()
.public String[] getHeaders() throws IOException
IOException
- Thrown if this object has already been closed.public int getIndex(String headerName) throws IOException
headerName
- The header name of the column.IOException
- Thrown if this object has already been closed.public String getRawRecord()
public char getRecordDelimiter()
public boolean getSafetySwitch()
public boolean getSkipEmptyRecords()
public char getTextQualifier()
public boolean getTrimWhitespace()
public boolean getUseComments()
public boolean getUseTextQualifier()
public String[] getValues() throws IOException
IOException
public boolean isQualified(int columnIndex) throws IOException
IOException
public boolean readHeaders() throws IOException
IOException
- Thrown if an error occurs while reading data from the
source stream.public boolean readRecord() throws IOException
IOException
- Thrown if an error occurs while reading data from the
source stream.public void setCaptureRawRecord(boolean captureRawRecord)
public void setComment(char comment)
comment
- The character to use as a comment signal.public void setDelimiter(char delimiter)
delimiter
- The character to use as the column delimiter.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 void setHeaders(String[] headers)
public void setRecordDelimiter(char recordDelimiter)
recordDelimiter
- The character to use as the record delimiter. Default is
combination of standard end of line characters for Windows,
Unix, or Mac.public void setSafetySwitch(boolean safetySwitch)
safetySwitch
- safetySwitchpublic void setSkipEmptyRecords(boolean skipEmptyRecords)
public void setTextQualifier(char textQualifier)
textQualifier
- The character to use as a text qualifier in the data.public void setTrimWhitespace(boolean trimWhitespace)
trimWhitespace
- Whether leading and trailing whitespace characters should be
trimmed from non-textqualified column data or not.public void setUseComments(boolean useComments)
useComments
- Whether comments are being looked for while parsing or not.public void setUseTextQualifier(boolean useTextQualifier)
useTextQualifier
- Whether to use a text qualifier while parsing or not.public boolean skipLine() throws IOException
IOException
- Thrown if an error occurs while reading data from the
source stream.public boolean skipRecord() throws IOException
getCurrentRecord()
.IOException
- Thrown if an error occurs while reading data from the
source stream.Copyright © 2015 jiucai.org. All rights reserved.