|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.knime.base.node.io.filereader.FileTable
public class FileTable
Implements a DataTable
that reads data from an ASCII file.
To instantiate this table you need to specify FileReaderSettings
and
a DataTableSpec
. File reader settings define
from where and how to read the data, the table spec specifies the structure
of the table to create.
Constructor Summary | |
---|---|
FileTable(DataTableSpec tableSpec,
FileReaderSettings frSettings,
boolean[] skipColumns,
ExecutionContext exec)
Creates a new file table with the structure defined in tableSpec and using the settings in frSettings when the file is read. |
|
FileTable(DataTableSpec tableSpec,
FileReaderSettings frSettings,
ExecutionContext exec)
Creates a new file table with the structure defined in tableSpec and using the settings in frSettings when the file is read. |
Method Summary | |
---|---|
void |
addStatusOfSettings(SettingsStatus status,
boolean openDataFile)
Adds its status messages to a passed status object. |
void |
dispose()
Call this before releasing the last reference to this table and all its iterators. |
protected void |
finalize()
|
DataTableSpec |
getDataTableSpec()
Returns the DataTableSpec object of this table which gives
information about the structure of this data table. |
SettingsStatus |
getStatusOfSettings(boolean openDataFile)
Method to check consistency and completeness of the current settings. |
FileRowIterator |
iterator()
Returns a row iterator which returns each row one-by-one from the table. |
String |
toString()
Returns a string summary for this table which is the entire table content. |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public FileTable(DataTableSpec tableSpec, FileReaderSettings frSettings, ExecutionContext exec)
tableSpec
- a table spec defining the structure of the table to
createfrSettings
- FileReaderSettings specifying the wheres and hows for
reading the ASCII data fileexec
- the execution context the progress is reported to; if null,
no progress is reportedpublic FileTable(DataTableSpec tableSpec, FileReaderSettings frSettings, boolean[] skipColumns, ExecutionContext exec)
tableSpec
- a table spec defining the structure of the table to
createfrSettings
- FileReaderSettings specifying the wheres and hows for
reading the ASCII data fileskipColumns
- array with the element set to true if the
corresponding column should be skipped (i.e. read but not be
included in the row). The array must have the length of the
'original' column number (in the file), the specified table
spec is the new one (with less columns).exec
- the execution context the progress is reported to; if null,
no progress is reportedMethod Detail |
---|
protected void finalize() throws Throwable
finalize
in class Object
Throwable
public void dispose()
next()
of any iterator
after disposing of the iterator has undefined behavior.
public FileRowIterator iterator()
iterator
in interface Iterable<DataRow>
iterator
in interface DataTable
DataRow
public DataTableSpec getDataTableSpec()
DataTableSpec
object of this table which gives
information about the structure of this data table.
getDataTableSpec
in interface DataTable
public SettingsStatus getStatusOfSettings(boolean openDataFile)
SettingsStatus
object which contains info, warning
and error messages. Or if the settings are alright it will return null.
openDataFile
- tells whether or not this method should try to access
the data file. This will - if set true
- verify
the accessibility of the data.
null
if no messages were generated
(i.e. all settings are just fine)public void addStatusOfSettings(SettingsStatus status, boolean openDataFile)
status
- the object to add messages to - if any.openDataFile
- specifies if we should check the accessibility of the
data file.public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |