com.sas.rio
Interface RIOStatementInterface

All Superinterfaces:

All Known Implementing Classes:

MVAStatement

public interface RIOStatementInterface

extends java.sql.Statement

This is the interface definition of RIOStatementInterface. This interface extends the java.sql.Statement interface functionality.

Fields inherited from interface java.sql.Statement

CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO

Method Summary

void	createTable(String libref, String tableName, Column[] columnObject, String options) Creates a new table with the name specified in the tableName String.
void	deleteTable(String libref, String tableName) Deletes the table with the name specified in the tableName String.
void	deleteTable(String libref, String tableName, String tableType, String alterPassword) Deletes the table for the specified tableType with the name specified in the tableName String.
ResultSet	getTable(String libref, String tableName) Gets an MVAResultSet object for the given table name.
ResultSet	getTable(String libref, String tableName, String tableType, String[] password, String options) Gets an MVAResultSet object for the given table name.

Methods inherited from interface java.sql.Statement

addBatch, cancel, clearBatch, clearWarnings, close, execute, execute, execute, exe cute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, < A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/sql/Statement.html#getFetchSize()">getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcu rrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout

Method Detail

createTable

public void createTable(String libref,
                        String tableName,
                        Column[] columnObject,
                        String options)
                 throws RIOException

Creates a new table with the name specified in the tableName String. The columns to be created and their attributes are passed through the columnObject parameter. Any SAS options to be sent with the create table will be passed through the options parameter.

Parameters:

libref - The libref name. Cannot be NULL.

tableName - The name of the table to be created. Table name cannot be NULL.

columnObject - A Column Object array containing column names and attributes. Column object cannot be NULL.

options - A String of applicable SAS dataset options. May be NULL.

Throws:

RIOException - This exception may be thrown.

getTable

public ResultSet getTable(String libref,
                          String tableName)
                   throws RIOException

Gets an MVAResultSet object for the given table name. By default all the columns and all rows are selected.

Parameters:

libref - The libref name. Cannot be NULL.

tableName - The name of the table to be opened. Table name cannot be NULL. By default, the driver looks for a dataset to open, if one doesn't exist it looks for a view to open. If both exist, it opens a dataset.

Returns:

An MVAResultSet object. All columns and all rows are selected.

Throws:

RIOException - This exception may be thrown.

getTable

public ResultSet getTable(String libref,
                          String tableName,
                          String tableType,
                          String[] password,
                          String options)
                   throws RIOException

Gets an MVAResultSet object for the given table name.

Parameters:

libref - The libref name. Cannot be NULL.

tableName - The name of the table to be opened.

tableType - The type of the table to be opened.It could be "DATA" or "VIEW". If NULL, the driver looks for a dataset to open, if one doesn't exist it looks for a view to open. If both exist, it opens a dataset. This parameter is currently being ignored and defaulted to NULL.

password - A String array of 3 elements specifying READ, WRITE and ALTER passwords if any. This parameter can be NULL. The first element is the READ password, the second the WRITE password and the third the ALTER password.

options - A String whose contents can be any SAS dataset options appropriate to the underlying engine and library. This includes the WHERE clause. options can be NULL.

Returns:

An MVAResultSet object. The ResultSet could be a subset of the actual set of columns and rows.

Throws:

RIOException - This exception may be thrown.

deleteTable

public void deleteTable(String libref,
                        String tableName)
                 throws RIOException

Deletes the table with the name specified in the tableName String.

Parameters:

libref - The libref name. Cannot be NULL.

tableName - The name of the table to be deleted. By default, the tableName dataset will be deleted.

Throws:

RIOException - This exception may be thrown.

deleteTable

public void deleteTable(String libref,
                        String tableName,
                        String tableType,
                        String alterPassword)
                 throws RIOException

Deletes the table for the specified tableType with the name specified in the tableName String.

Parameters:

libref - The libref name. Cannot be NULL.

tableName - The name of the table to be deleted.

tableType - The type of the table. It could be "DATA" or "VIEW" or any table type available in the database. If NULL, the tableName dataset will be deleted.

alterPassword - The alter password.

Throws:

RIOException - This exception may be thrown.