com.sas.cas.io

Class CASTableCursorSupport

java.lang.Object

com.sas.cas.io.CASBaseTable

com.sas.cas.io.CASTableCursorSupport

All Implemented Interfaces:

CASAttributed, CASTable

Direct Known Subclasses:

CASDefaultTable

public abstract class CASTableCursorSupport
extends CASBaseTable

Base class providing CASTable cursor support.

Nested Class Summary

Nested classes/interfaces inherited from class com.sas.cas.io.CASBaseTable

CASBaseTable.StreamAppender, CASBaseTable.StringAppender, CASBaseTable.StringBufferAppender

Nested classes/interfaces inherited from interface com.sas.cas.CASTable

CASTable.OutputType

Field Summary

Fields

Modifier and Type	Field and Description
protected int	cursor

Fields inherited from class com.sas.cas.io.CASBaseTable

DEFAULT_TOSTRING_ROWCOUNT, rb

Fields inherited from interface com.sas.cas.CASTable

HINT_PRESERVE_PADDING

Constructor Summary

Constructors

Constructor and Description
CASTableCursorSupport()

Method Summary

Modifier and Type	Method and Description
boolean	absolute(int row) Moves the cursor to the given row number.
void	afterLast() Moves the cursor to the end of this table, just after the last row.
void	beforeFirst() Moves the cursor to the front of this table, just before the first row.
protected abstract void	closeCheck() Checks if the table (provider) has been closed.
protected void	cursorCheck()
boolean	first() Moves the cursor to the first row in the table.
java.math.BigDecimal	getBigDecimalAt(int col) Gets the big decimal value at the current cursor position for the given column.
java.io.InputStream	getBinaryStreamAt(int col) Gets an input stream of uninterpreted bytes at the current cursor position for the given column.
byte[]	getBytesAt(int col) Gets a byte array value at the current cursor position for the given column.
int	getCursor() Gets the current cursor position in the table.
double[]	getDoubleArrayAt(int col) Gets the double array value at the current cursor position for the given column index.
double[]	getDoubleArrayAt(int col, int offset, int length) Gets the double array value at the current cursor position for the given column index.
double	getDoubleAt(int col) Gets the double value at the current cursor position for the given column index.
int	getIntAt(int col) Gets the integer value at the current cursor position for the given column.
long	getLongAt(int col) Gets the long value at the current cursor position for the given column.
java.lang.Object	getObjectAt(int col) Gets the raw object value at the current cursor for the given column.
java.lang.String	getStringAt(int col) Gets a string value at the current cursor position for the given column.
protected boolean	isValidRow()
boolean	last() Moves the cursor to the last row in the table.
boolean	next() Moves the cursor forward one row from its current position.
boolean	previous() Moves the cursor back one row from its current position.

Methods inherited from class com.sas.cas.io.CASBaseTable

addHint, addRowInfo, escapeForCSV, findColumn, getActionOptions, getBigDecimalAt, getBigDecimalAt, getBinaryStreamAt, getBinaryStreamAt, getBytesAt, getBytesAt, getColumnIndex, getColumnLabels, getColumnNames, getDateAt, getDateAt, getDateAt, getDateAt, getDateAt, getDateAt, getDateTimeAt, getDateTimeAt, getDateTimeAt, getDateTimeAt, getDateTimeAt, getDateTimeAt, getDoubleArrayAt, getDoubleArrayAt, getDoubleArrayAt, getDoubleArrayAt, getDoubleAt, getDoubleAt, getHints, getIntAt, getIntAt, getLongAt, getLongAt, getObjectAt, getObjectAt, getStringAt, getStringAt, getTimeAt, getTimeAt, getTimeAt, getTimeAt, getTimeAt, getTimeAt, leftPad, rightPad, setActionOptions, setHints, toAppender, toCSVString, toPrettyString, toStream, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sas.cas.CASTable

addHint, close, getActualRowCount, getBigDecimalAt, getBinaryStreamAt, getBytesAt, getColumnCount, getColumns, getDateAt, getDateAt, getDateTimeAt, getDateTimeAt, getDoubleArrayAt, getDoubleArrayAt, getDoubleAt, getFlags, getHints, getIntAt, getLabel, getLongAt, getName, getObjectAt, getRow, getRow, getRowCount, getRowSize, getSize, getStringAt, getTimeAt, getTimeAt, getTitle, getUserFlags, getUserValue, isDataLittleEndian, setHints, setLabel, setName, setTitle, setUserFlags, setUserValue

Methods inherited from interface com.sas.cas.CASAttributed

getAttribute, getAttributeCount, getAttributeKeys

Field Detail

cursor

protected int cursor

Constructor Detail

CASTableCursorSupport

public CASTableCursorSupport()

Method Detail

getCursor

public int getCursor()
              throws java.io.IOException

Description copied from interface: CASTable

Gets the current cursor position in the table. The cursor is a 0-based row number. A value of -1 indicates the cursor is positioned prior to the first row. A value equal to the number of rows in the table indicates the cursor is positioned after the last row.

Returns:

The cursor position

Throws:

java.io.IOException

next

public boolean next()
             throws java.io.IOException

Description copied from interface: CASTable

Moves the cursor forward one row from its current position. A CASTable cursor is initially positioned before the first row; the first call to the method next makes the first row the current row.

When a call to next returns false, the cursor is positioned after the last row.

Returns:

true if the current row is valid; false if there are no more rows

Throws:

java.io.IOException

previous

public boolean previous()
                 throws java.io.IOException

Description copied from interface: CASTable

Moves the cursor back one row from its current position.

When a call to previous returns false, the cursor is positioned before the first row.

Returns:

true if the current row is valid; false if there are no more rows

Throws:

java.io.IOException

absolute

public boolean absolute(int row)
                 throws java.io.IOException

Description copied from interface: CASTable

Moves the cursor to the given row number. If the row number is positive, the cursor moves to the given row with respect to the beginning of the table. The first row is row 0. If the given row number is negative, the cursor moves to the given row with respect to the end of the table. The last row is -1.

An attempt to position the cursor beyond the first or last row in the table leaves the cursor before the first row.

Parameters:

row - The absolute row number, 0-based.

Returns:

true if the cursor is moved to a position in this table; false if the cursor is before the first row or after the last row

Throws:

java.io.IOException

first

public boolean first()
              throws java.io.IOException

Description copied from interface: CASTable

Moves the cursor to the first row in the table.

Returns:

true if the cursor is on a valid row; false if there are no rows in the table

Throws:

java.io.IOException

beforeFirst

public void beforeFirst()
                 throws java.io.IOException

Description copied from interface: CASTable

Moves the cursor to the front of this table, just before the first row. This method has no effect if the table contains no rows.

Throws:

java.io.IOException

last

public boolean last()
             throws java.io.IOException

Description copied from interface: CASTable

Moves the cursor to the last row in the table.

Returns:

true if the cursor is on a valid row; false if there are no rows in the table

Throws:

java.io.IOException

afterLast

public void afterLast()
               throws java.io.IOException

Description copied from interface: CASTable

Moves the cursor to the end of this table, just after the last row. This method has no effect if the table contains no rows.

Throws:

java.io.IOException

getDoubleAt

public double getDoubleAt(int col)
                   throws java.io.IOException

Description copied from interface: CASTable

Gets the double value at the current cursor position for the given column index.

Parameters:

col - The column number, 0-based

Returns:

The double value

Throws:

java.io.IOException

getDoubleArrayAt

public double[] getDoubleArrayAt(int col)
                          throws java.io.IOException

Description copied from interface: CASTable

Gets the double array value at the current cursor position for the given column index. If the column does not represent an array, and single element array will be returned.

Parameters:

col - The column number, 0-based

Returns:

The double array value

Throws:

java.io.IOException

getDoubleArrayAt

public double[] getDoubleArrayAt(int col,
                                 int offset,
                                 int length)
                          throws java.io.IOException

Description copied from interface: CASTable

Gets the double array value at the current cursor position for the given column index. If the column does not represent an array, and single element array will be returned.

Parameters:

col - The column number, 0-based

offset - The starting offset of the array

length - The number of elements to return

Returns:

The double array value

Throws:

java.io.IOException

getIntAt

public int getIntAt(int col)
             throws java.io.IOException

Description copied from interface: CASTable

Gets the integer value at the current cursor position for the given column.

Parameters:

col - The column number, 0-based

Returns:

The integer value

Throws:

java.io.IOException

getLongAt

public long getLongAt(int col)
               throws java.io.IOException

Description copied from interface: CASTable

Gets the long value at the current cursor position for the given column.

Parameters:

col - The column number, 0-based

Returns:

The long value

Throws:

java.io.IOException

getBigDecimalAt

public java.math.BigDecimal getBigDecimalAt(int col)
                                     throws java.io.IOException

Description copied from interface: CASTable

Gets the big decimal value at the current cursor position for the given column.

Parameters:

col - The column number, 0-based

Returns:

The big decimal value

Throws:

java.io.IOException

getStringAt

public java.lang.String getStringAt(int col)
                             throws java.io.IOException

Description copied from interface: CASTable

Gets a string value at the current cursor position for the given column. Any data in the buffer for the column will be returned using the default encoding (UTF-8).

Parameters:

col - The column number, 0-based

Returns:

The string value

Throws:

java.io.IOException

getBytesAt

public byte[] getBytesAt(int col)
                  throws java.io.IOException

Description copied from interface: CASTable

Gets a byte array value at the current cursor position for the given column.

Parameters:

col - The column number, 0-based

Returns:

A copy of the byte array

Throws:

java.io.IOException

getBinaryStreamAt

public java.io.InputStream getBinaryStreamAt(int col)
                                      throws java.io.IOException

Description copied from interface: CASTable

Gets an input stream of uninterpreted bytes at the current cursor position for the given column.

Parameters:

col - The column number, 0-based

Returns:

An input stream

Throws:

java.io.IOException

getObjectAt

public java.lang.Object getObjectAt(int col)
                             throws java.io.IOException

Description copied from interface: CASTable

Gets the raw object value at the current cursor for the given column.

Parameters:

col - The column number, 0-based

Returns:

The object value

Throws:

java.io.IOException

isValidRow

protected boolean isValidRow()

closeCheck

protected abstract void closeCheck()
                            throws java.io.IOException

Checks if the table (provider) has been closed. An exception will be thrown if closed.

Throws:

java.io.IOException

cursorCheck

protected void cursorCheck()