ariba.ui.aribaweb.util
Class CSVReader

java.lang.Object
  ariba.ui.aribaweb.util.CSVReader

public final class CSVReader
extends Object

CSVReader parses files in CSV (comma separated values) format. Subclassers should implement the consumeLineOfTokens method.

Constructor Summary

CSVReader(CSVConsumer csvConsumer)
Create a new CSVReader using a specific CSVConsumer to handle the rows.

Method Summary

String	getEncoding() Return the encoding used for the last read operation.
boolean	isEncodingExplicitlySet() Returns true if the file had the encoding as the first line in the file, e.g.
void	read(File file, String encoding) Reads the specified file, using the character encoding for the default locale.
void	read(Reader reader, String location) The primitive read entry point.
void	read(URL url, String defaultEncoding) Reads the specified URL, using the character encoding for the default locale.
void	readForSpecifiedEncoding(File file) Will read from the specified stream in the encoding specified on the first line of the stream.
void	readForSpecifiedEncoding(InputStream inputStream, String location) Will read from the specified stream in the encoding specified on the first line of the stream.
void	readForSpecifiedEncoding(URL url) Will read from the specified stream in the encoding specified on the first line of the stream.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CSVReader

public CSVReader(CSVConsumer csvConsumer)

Create a new CSVReader using a specific CSVConsumer to handle the rows. After reading has been performed, the CSVReader can be asked what the encoding was used.

Method Detail

getEncoding

public String getEncoding()

Return the encoding used for the last read operation. May be null if a Reader was passed in so we never know the underlying encoding if any.

Returns:

The value of the content-encoding header field.

isEncodingExplicitlySet

public boolean isEncodingExplicitlySet()

Returns true if the file had the encoding as the first line in the file, e.g. 8859_1 or 8859_1,,

Returns:

boolean indicating if the file has the encoding in the first line

read

public void read(URL url,
                 String defaultEncoding)
          throws IOException

Reads the specified URL, using the character encoding for the default locale.

Parameters:

url - the URL to read the data from

defaultEncoding - the encoding to use to read the data if none can be determined from the URLConnection

Throws:

IOException - any IOException reading from the URL

read

public void read(File file,
                 String encoding)
          throws IOException

Reads the specified file, using the character encoding for the default locale.

Parameters:

file - a path to the file to read

encoding - The encoding used for reading the file

Throws:

IOException - any IOException reading from the file could not be read.

readForSpecifiedEncoding

public void readForSpecifiedEncoding(URL url)
                              throws IOException

Will read from the specified stream in the encoding specified on the first line of the stream. For instance, the first line of the file may be "8859_1", or may be "8859_1,,,". The "8859_1" will be passed into read(inputStream, encoding, path) as the encoding.

Parameters:

url - the URL to read the data from

Throws:

IOException - any IOException reading from the URL

readForSpecifiedEncoding

public final void readForSpecifiedEncoding(File file)
                                    throws IOException

Will read from the specified stream in the encoding specified on the first line of the stream. For instance, the first line of the file may be "8859_1", or may be "8859_1,,,". The "8859_1" will be passed into read(inputStream, encoding, path) as the encoding.

Parameters:

file - the path to the file to read

Throws:

IOException - if an IOException occurs while reading the file

See Also:

read(Reader, String)

readForSpecifiedEncoding

public final void readForSpecifiedEncoding(InputStream inputStream,
                                           String location)
                                    throws IOException

Will read from the specified stream in the encoding specified on the first line of the stream. For instance, the first line of the file may be "8859_1", or may be "8859_1,,,". The "8859_1" will be passed into read(inputStream, encoding, path) as the encoding.

Parameters:

inputStream - the InputStream to read the data from

location - the path to the data source for debugging messages

Throws:

IOException - if an IOException occurs while reading the file

See Also:

read(Reader, String)

read

public final void read(Reader reader,
                       String location)
                throws IOException

The primitive read entry point. This method calls the CSVConsumer callback for each line read.

Parameters:

reader - the data source as passed in by one of the higher level read methods

location - the path for debugging messages

Throws:

IOException - if an IOException occurs while reading from reader

See Also:

CSVConsumer.consumeLineOfTokens(java.lang.String, int, java.util.List)