Package uk.ac.starlink.table
Class AccessRowSequence
java.lang.Object
uk.ac.starlink.table.AccessRowSequence
- All Implemented Interfaces:
Closeable
,AutoCloseable
,RowData
,RowSequence
,uk.ac.starlink.util.Sequence
RowSequence implementation based on a RowAccess.
- Since:
- 24 Jul 2020
- Author:
- Mark Taylor
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Indicates that this sequence will not be required any more.static AccessRowSequence
createInstance
(StarTable table) Constructs an AccessRowSequence based on a given table.getCell
(int icol) Returns the contents of a cell in the current row.Object[]
getRow()
Returns the contents of the current table row, as an array with the same number of elements as there are columns in this table.boolean
next()
Attempts to advance the current row to the next one.
-
Constructor Details
-
AccessRowSequence
Constructor.- Parameters:
racc
- row access providing data accessnrow
- number of rows
-
-
Method Details
-
next
Description copied from interface:RowSequence
Attempts to advance the current row to the next one. Iftrue
is returned the attempt has been successful, and iffalse
is returned there are no more rows in this sequence. Since the initial position of a RowSequence is before the first row, this method must be called before current row data can be accessed using theRowSequence.getCell(int)
orRowSequence.getRow()
methods.- Specified by:
next
in interfaceRowSequence
- Specified by:
next
in interfaceuk.ac.starlink.util.Sequence
- Returns:
true
iff this sequence has been advanced to the next row- Throws:
IOException
- if there is some error
-
getCell
Description copied from interface:RowSequence
Returns the contents of a cell in the current row. The class of the returned object should be the same as, or a subclass of, the class returned bygetColumnInfo(icol).getContentClass()
. An unchecked exception will be thrown if there is no current row (next
has not yet been called).- Specified by:
getCell
in interfaceRowData
- Specified by:
getCell
in interfaceRowSequence
- Parameters:
icol
- column index- Returns:
- the contents of cell
icol
in the current row - Throws:
IOException
- if there is an error reading the data
-
getRow
Description copied from interface:RowSequence
Returns the contents of the current table row, as an array with the same number of elements as there are columns in this table. An unchecked exception will be thrown if there is no current row (next
has not yet been called).- Specified by:
getRow
in interfaceRowData
- Specified by:
getRow
in interfaceRowSequence
- Returns:
- an array of the objects in each cell in row
irow
- Throws:
IOException
- if there is an error reading the data
-
close
Description copied from interface:RowSequence
Indicates that this sequence will not be required any more. This should release resources associated with this object. The effect of calling any of the other methods following aclose
is undefined.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceRowSequence
- Throws:
IOException
-
createInstance
Constructs an AccessRowSequence based on a given table.- Parameters:
table
- table- Returns:
- new row access
- Throws:
IOException
-