net.sf.jtables.io.reader.ReaderTable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jtables Show documentation

Simple and lightweight framework to work with tables and table based files such as CSV and other (tab)-delimited files.

There is a newer version: 2.2.2

/**********************************************************************
Copyright (c) 2009-2012 Alexander Kerner. All rights reserved.
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.
 ***********************************************************************/

package net.sf.jtables.io.reader;

import java.io.IOException;
import java.io.Reader;

import net.sf.jtables.table.Row;
import net.sf.jtables.table.Table;
import net.sf.jtables.table.TableAnnotated;
import net.sf.jtables.table.impl.TableInteger;
import net.sf.jtables.table.impl.TableString;
import net.sf.kerner.utils.io.buffered.IOIterable;
import net.sf.kerner.utils.io.buffered.IOIterator;

/**
 * 
 * A {@code TableReader} reads an {@link TableAnnotated} from an input source.
 *  It does so by extending {@link IOIterable} in oder to provide
 * possibility to iterate over a table's rows.  Via
 * {@link ReaderTable#readTableAtOnce()} it is also possible to read in a whole
 * table at once.
 * 
 * @see IOIterable
 * @see TableAnnotated
 * @see TableString
 * @see TableInteger
 * @see Row
 * 
 * @author Alexander Kerner
 * @version 2012-03-14
 * 
 * @param 
 *            type of elements in {@code Table}
 */
public interface ReaderTable extends IOIterable> {

	/**
	 * Close this reader.
	 * 
	 * @see Reader#close()
	 * 
	 */
	void close();

	/**
	 * 
	 * Read a {@link Table} at once.
	 * 
	 * @return new instance of {@code AnnotatedTable} that was read
	 * @throws IOException
	 *             if reading failed
	 */
	TableAnnotated readTableAtOnce() throws IOException;

	/**
	 * Retrieve an {@link Iterator} to read one {@link Row} after another.
	 * 
	 * @throws IOException
	 *             if reading failed
	 */
	IOIterator> getIterator() throws IOException;

}