org.knime.base.node.io.fixedwidthfr

Class FixedWidthFRPreviewTable

java.lang.Object

org.knime.base.node.io.fixedwidthfr.FixedWidthFRTable

org.knime.base.node.io.fixedwidthfr.FixedWidthFRPreviewTable

All Implemented Interfaces:

AutoCloseable, Iterable<DataRow>, DataTable

public class FixedWidthFRPreviewTable
extends FixedWidthFRTable

The data table displayed in the file reader's dialog's preview. We need an extra incarnation of a data table (different from from the FileTable) because if settings are not correct yet, the table in the preview must not throw any exception on unexpected or invalid data it reads (which the "normal" file table does). Thus, this table returns a row iterator that will create an error row when a error occurs during file reading. It will end the table after the erroneous element was read.

Author:

Peter Ohl, University of Konstanz

Constructor Summary

Constructors

Constructor and Description
FixedWidthFRPreviewTable(DataTableSpec tableSpec, FixedWidthFRSettings settings, ExecutionContext exec) Creates a new table, its like the "normal" FileTable, just not failing on invalid data files.

Method Summary

Modifier and Type	Method and Description
(package private) void	addChangeListener(ChangeListener listener) If someone wants to be notified if an error occurred he should register through this method.
protected CloseableRowIterator	createRowIterator(FixedWidthFRSettings nodeSettings, DataTableSpec tableSpec, ExecutionContext exec)
DataTableSpec	getDataTableSpec() Returns the DataTableSpec object of this table which gives information about the structure of this data table.
(package private) String	getErrorDetail()
(package private) String	getErrorMsg()
(package private) boolean	getErrorOccurred()
(package private) void	removeAllChangeListeners() Clears the list of change listeners.
(package private) void	setError(FileReaderException fre) This sets the flag indicating that the row iterator ended the table with an error.

Methods inherited from class org.knime.base.node.io.fixedwidthfr.FixedWidthFRTable

close, iterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

FixedWidthFRPreviewTable

FixedWidthFRPreviewTable(DataTableSpec tableSpec,
                         FixedWidthFRSettings settings,
                         ExecutionContext exec)

Creates a new table, its like the "normal" FileTable, just not failing on invalid data files.

Parameters:

settings - settings for the underlying FileTable

tableSpec - table spec for the underlying FileTable

exec - the execution context the progress is reported to

See Also:

FileTable

Method Detail

createRowIterator

protected CloseableRowIterator createRowIterator(FixedWidthFRSettings nodeSettings,
                                                 DataTableSpec tableSpec,
                                                 ExecutionContext exec)
                                          throws IOException

Overrides:

createRowIterator in class FixedWidthFRTable

Parameters:

nodeSettings - the node settings

tableSpec - the tableSpec

exec - the execution context

Returns:

a FixedWidthRowIterator

Throws:

IOException - if buffered file reader can't be created

getDataTableSpec

public DataTableSpec getDataTableSpec()

Returns the DataTableSpec object of this table which gives information about the structure of this data table.

Specified by:

getDataTableSpec in interface DataTable

Overrides:

getDataTableSpec in class FixedWidthFRTable

Returns:

the DataTableSpec of this table

setError

void setError(FileReaderException fre)

This sets the flag indicating that the row iterator ended the table with an error.

Parameters:

fre - the exception thrown by the error.

getErrorOccurred

boolean getErrorOccurred()

Returns:

true if an error occurred in an underlying row iterator. Meaning the table contains invalid data. NOTE: if false is returned it is not guaranteed that all data in the table is valid. It could be that no row iterator reached the invalid data yet.

getErrorMsg

String getErrorMsg()

Returns:

the error msg set by a row iterator that came across an error in the table. This is null if not set.

getErrorDetail

String getErrorDetail()

Returns:

a message containing more details about the error occurred. Could be null if no details are available.

addChangeListener

void addChangeListener(ChangeListener listener)

If someone wants to be notified if an error occurred he should register through this method.

Parameters:

listener - the object being notified when an error occurs.

removeAllChangeListeners

void removeAllChangeListeners()

Clears the list of change listeners.

See Also:

addChangeListener(ChangeListener)