javatools.filehandlers

Class CSVLines

java.lang.Object

javatools.datatypes.PeekIterator<List<String>>

javatools.filehandlers.CSVLines

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<List<String>>, Iterator<List<String>>

public class CSVLines
extends PeekIterator<List<String>>

Copyright 2016 Fabian M. Suchanek Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. The class provides an iterator over the lines in a comma-separated file
Example:

      for(List<String> columns : new CSVFile("c:\\autoexec.csv")) {
         System.out.println(columns);
      }
  

Recognizes column headers if introduced by '#'. Recognizes all types of encodings (see Char.decode()).

Nested Class Summary

Nested classes/interfaces inherited from class javatools.datatypes.PeekIterator

PeekIterator.ElementaryPeekIterator<T>, PeekIterator.SimplePeekIterator<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected long	announceChars number of chars for announce (or -1)
protected List<String>	columns Holds the column names
protected Reader	in Containes the Reader
protected int	nextChar Holds the next char in line
protected char	separator Holds the spearator

Fields inherited from class javatools.datatypes.PeekIterator

closed, EMPTY, fetchedNextValue, next

Constructor Summary

Constructors

Constructor and Description
CSVLines(File f) Constructs a CSVReader
CSVLines(Reader reader) Constructs a CSVReader
CSVLines(String file) Constructs a CSVReader

Method Summary

Modifier and Type	Method and Description
void	close() Closes the underlying resource
List<String>	columnNames() returns the column names (or NULL)
protected String	component() Reads a component and the following comma
protected List<String>	internalNext() Returns the next or NULL if no next element is available
static void	main(String[] args) Test method
Integer	numColumns() returns the number of columns (or NULL)
void	setSeparator(char s) Sets the separator (comma by default)

Methods inherited from class javatools.datatypes.PeekIterator

asList, asList, asSet, asSet, asSet, emptyIterator, hasNext, internalSilentNext, iterator, list, list, next, nextOrNull, numElements, numElements, peek, remove, toString, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

announceChars

protected long announceChars

number of chars for announce (or -1)

in

protected Reader in

Containes the Reader

columns

protected List<String> columns

Holds the column names

nextChar

protected int nextChar

Holds the next char in line

separator

protected char separator

Holds the spearator

Constructor Detail

CSVLines

public CSVLines(File f)
         throws IOException

Constructs a CSVReader

Throws:

IOException

CSVLines

public CSVLines(Reader reader)
         throws IOException

Constructs a CSVReader

Throws:

IOException

CSVLines

public CSVLines(String file)
         throws IOException

Constructs a CSVReader

Throws:

IOException

Method Detail

setSeparator

public void setSeparator(char s)

Sets the separator (comma by default)

component

protected String component()
                    throws IOException

Reads a component and the following comma

Throws:

IOException

internalNext

protected List<String> internalNext()
                             throws Exception

Description copied from class: PeekIterator

Returns the next or NULL if no next element is available

Specified by:

internalNext in class PeekIterator<List<String>>

Throws:

Exception

columnNames

public List<String> columnNames()

returns the column names (or NULL)

numColumns

public Integer numColumns()

returns the number of columns (or NULL)

close

public void close()

Description copied from class: PeekIterator

Closes the underlying resource

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class PeekIterator<List<String>>

main

public static void main(String[] args)
                 throws Exception

Test method

Throws:

Exception