JDBCToDataTableAdapter (SAS AppDevStudio API Developer Documentation for Java)

All Libraries

This Library

Package

Class

Use

Tree

Deprecated

Index

Grand Index

Help

Components

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sas.storage.jdbc
Class JDBCToDataTableAdapter

com.sas.storage.jdbc.JDBCToDataTableAdapter

All Implemented Interfaces:: com.sas.collection.ContentsChangedSource, ModelInterface, DataTableInterface, FormattedDataInterface, RowTemplateTableInterface, com.sas.table.StaticColumnInfoInterface, StaticColumnLabelInterface, StaticFormattedDataInterface, com.sas.table.StaticRowLabelInterface, StaticRowTemplateTableInterface, StaticTableInterface, TableInterface, com.sas.util.transforms.DisplayTransformInterface

public class JDBCToDataTableAdapter
implements DataTableInterface, ModelInterface, com.sas.collection.ContentsChangedSource
implements DataTableInterface, ModelInterface, com.sas.collection.ContentsChangedSource

The JDBCToDataTableAdapter allows JDBC data sources to be displayed in any viewer that requires a model of type com.sas.table.DataTableInterface, such as the com.sas.table.TableView.

The adapter requires a java.sql.Connection object and a query statement. They can be passed in on the constructor or set via methods. The setConnection() method will apply the connection object. The setQueryStatement() method will apply the SQL query statement. When non-null values for both connection and query statement have been applied, the adapter is initialized and ready to use.

The query statement must be a SQL query that is valid for the JDBC data source. This may include a blank statement, if valid.

If autoCommit is true when any setXXX method is used, an updateRow() method will be called upon the ResultSet so that the value(s) passed by the setXXX method are updated to the data source. If autoCommit is false, it is necessary to call the commitRow() method to commit changes to the data source.

This adapter works best with JDBC drivers that can create scrollable result sets. Table viewers usually need to read backwards to support scrolling the viewer. However, this adapter can support using scrolling viewers with forward-only result sets (ResultSet.TYPE_FORWARD_ONLY). That is accomplished by requerying the result set whenever there is a need to read a row before the current row. There is a performance penalty for this because the server must be requeried and the adapter re-initializes. If you want to turn off this feature, call setResultSetRequeryUsed(false).

Here an example of how the adapter can be created using the JdbcOdbc driver.

 Connection conn = null;
   try 
          {      
           Class.forName( "sun.jdbc.odbc.JdbcOdbcDriver" );    
           conn = java.sql.DriverManager.getConnection("jdbc:odbc:Northwind");
           //create the query statement.
           String queryStatement ="select * from orders";       

           //create the Adapter
           JDBCToDataTableAdapter adapter = new JDBCToDataTableAdapter(conn, queryStatement);
          }

The adapter can be configured and used within a webAF project. Add a com.sas.storage.jdbc.JDBCConnection component to your project. Open the customizer and specify the values needed for your JDBC connection, including the driver name and URL. Now open the customizer for the adapter. Specify the value for JDBC Connection using the top combo box. The drop-down list will show all JDBC Connection objects that exist in your project. You can set the properties for query statement, column information used, autoCommit, and read-only, as well.

Since:: 2.0

Field Summary

protected com.sas.collection.ContentsChangedListenerList allContentsChangedListeners
          List of all the ContentsChangedListeners

protected java.util.Hashtable defaultValues
          A Hashtable used to obtain default values for a column.

static int ERROR_CODE_END_OF_FILE
          An error code, used to signal that the end of file was reached when reading rows.

Fields inherited from class com.sas.storage.jdbc.JDBCAdapter

autoCommit, CLASS_NAME, columnInfoUsed, conn, designTime, displayTransform, forwardOnly, initialized, isRowCountKnown, LABEL, meta, NAME, printWarnings, queryRowCountDisabled, queryStatement, RB_KEY, readOnly, result, resultSetRequeryUsed, resultSetType, resultSetUsed, retrieveNumericTypesAsDouble, rowCount, rowCountQueryString, rowNumber, spcs, stmt, trimUsed

Fields inherited from interface com.sas.table.RowTemplateTableInterface

DEFAULT_INDEX

Constructor Summary

JDBCToDataTableAdapter()
          Default constructor called when the adapter is made in a webAF project.

JDBCToDataTableAdapter(java.sql.Connection conn, java.lang.String queryStatement)
          Constructor used to create an initialized adapter.

JDBCToDataTableAdapter(java.sql.ResultSet result)
          Constructor used to connect an adapter directly to a previously created ResultSet.

Method Summary

protected boolean absolute(int index)
          For scrollable result sets, the absolute() method is called on the result set.

void addColumn(int p0, java.lang.Class p1, java.lang.Object p2)
          This method is not supported.

void addContentsChangedListener(com.sas.collection.ContentsChangedListener listener)


void addRow(int index)
          This method requires a value of -1 for index.

void addRow(int index, java.lang.Object[] values)
          This method requires a value of -1 for index.

boolean attachView()
          Required by com.sas.ModelInterface.

void commitRow()
          If autoCommit is false, this method calls updateRow on the result set.

int countColumns(int maxCount)
          The maxCount parameter is ignored and the result of getColumnCount is returned.

int countRows(int maxCount)
          Counts the number of rows when the underlying result set is not scrollable (TYPE_FORWARD_ONLY) and resultSetRequeryUsed is true.

void deleteColumn(int p0)
          This method is not supported.

void deleteRow(int row)
          Deletes the row at the given row number.

void detachView()
          Required by com.sas.ModelInterface.

void fireCellEvent(int row, int column)
          Fire a specific event for a model signaling that one cell has changed.

protected void fireContentsChanged()
          Fire a default contents changed event.

protected void fireContentsChanged(com.sas.collection.ContentsChangedEvent event)
          Send a ContentsChangedEvent to all the ContentsChangedListener objects in the listener list.

void fireModelEvent()
          Fire a default event for a model signaling the some aspect of the model has changed.

void fireModelEvent(java.util.EventObject event)
          Fire a specific event for a model signaling that some aspect of the model has changed.

int getBufferBlocks()
          This method always returns 1.

int getBufferSize()
          This returns the number of rows suggested to the JDBC driver as the number of rows to fetch from the database when more rows are needed for this result set object.

java.lang.Object getCell(int row, int col)
          Returns value of a cell in the JDBC data type of the cell.

java.lang.Class getCellClass(int row, int col)
          Returns the value of column class at the column identified by col.

java.lang.Class[][] getCellClasses(int startRowIndex, int startColumnIndex, int rowCount, int columnCount)
          Returns the classes for a block of cells.

java.lang.Object[][] getCells(int startRowIndex, int startColumnIndex, int rowCount, int columnCount)
          Returns values for a block of cells in the JDBC data types of the cells.

java.lang.Object[] getColumn(int index)
          Returns the values of all the cells in a column.

java.lang.Class getColumnClass(int index)
          Returns the class of a column.

java.lang.Class[] getColumnClasses(int col, int columnCount)
          Returns the classes for a range of columns.

int getColumnCount()
          Returns the number of columns in the result set.

java.lang.Object getColumnDefaultValue(int index)
          Returns any default value set by setColumnDefaultValue.

java.lang.Object[] getColumnDefaultValues(int index, int count)
          Returns any default values set by setColumnDefaultValues.

int getColumnIndex(java.lang.String name)
          Returns the column index for a column name.

java.lang.Object getColumnInfo(int index, java.lang.String columnInfoName)
          Returns the named information for a column.

java.lang.String[] getColumnInfoNames()
          Returns NAME and LABEL in an array.

java.lang.String getColumnInfoUsed()
          Returns the column information that is currently being used as the column label.

java.lang.Object getColumnLabel(int index)
          If columnInfoUsed is "LABEL", gets the suggested column title provided by ResultSetMetaData object for the column at the given index.

java.lang.Object[] getColumnLabels(int index, int count)
          If columnInfoUsed is "LABEL", gets the suggested column titles provided by ResultSetMetaData object for the column range.

java.lang.String[] getDisplayedColumns()
          This method is not supported.

static com.sas.beans.ExtendedBeanInfo getExtendedBeanInfo()
          Manage properties in the webAF properties sheet.

java.lang.String getFormattedCell(int rowIndex, int colIndex)
          Returns the formatted value of a cell.

java.lang.String[][] getFormattedCells(int startRow, int startColumn, int rowCount, int columnCount)
          Returns the formatted values for a block of cells.

java.lang.String[] getFormattedColumn(int col)
          Returns the formatted values of all the cells in a column.

java.lang.String[] getFormattedRow(int row)
          Returns the formatted values of all the cells in a row.

java.lang.Object[] getRow(int row)
          Returns the values of all the cells in a row.

int getRowCount()
          Returns the number of rows in the result set.

java.lang.Object getRowLabel(int row)
          Returns the row number passed in as a statement.

java.lang.Object[] getRowLabels(int startIndex, int count)
          Returns the row number range as statements in an Object array.

java.lang.String getWhere()
          Returns the queryStatement.

protected void initDefaultValues()
          Initialize a hashtable for 1) storing column default values from setColumnDefaultValue, 2) getting column default values for getColumnDefaultValue.

boolean isCellsModifiable()
          Indicates whether cells can be modified.

boolean isColumnLabelsSupported()
          This method always returns true.

boolean isColumnsDeletable()
          This method always returns false.

boolean isColumnsExtendable()
          This method always returns false.

boolean isColumnsInsertable()
          This method always returns false.

boolean isColumnsLabelSupported()
          This method always returns false.

boolean isColumnsRedefinable()
          This method always returns false.

boolean isMultipleColumnUpdateSupported()
          This method always returns true.

boolean isMultipleRowUpdateSupported()
          This method always returns true.

boolean isRowLabelsSupported()
          This method always returns true.

boolean isRowsDeletable()
          Returns the same value as the isReadOnly method.

boolean isRowsExtendable()
          Returns the same value as the isReadOnly method.

boolean isRowsInsertable()
          This method always returns false.

boolean isRowsLabelSupported()
          This method always returns false.

void refresh()
          Sets the initialized field to false and calls the init method.

void removeContentsChangedListener(com.sas.collection.ContentsChangedListener listener)


void setBufferBlocks(int p0)
          This method is not supported.

void setBufferSize(int rows)
          Gives the JDBC driver a hint as to the number of rows to fetch from the database when more rows are needed for this ResultSet object.

void setCell(int rowIndex, int columnIndex, java.lang.Object value)
          Updates value into the cell at rowIndex, columnIndex.

void setCells(int startRowIndex, int startColumnIndex, int rowCount, int columnCount, java.lang.Object[][] values)
          Specifies the values for a block of cells.

void setColumn(int columnIndex, java.lang.Object[] values)
          Specifies the values of all the cells in a column.

void setColumnClass(int p0, java.lang.Class p1)
          This method is not supported.

void setColumnDefaultValue(int index, java.lang.Object newValue)
          Sets the default value associated with a column.

void setColumnInfoUsed(java.lang.String info)
          Sets the column information that is currently being used as the column label.

void setDisplayedColumns(java.lang.String[] p0)
          This method is not supported.

void setFormattedCell(int rowIndex, int columnIndex, java.lang.String value)
          Specifies the formatted value of a cell.

void setFormattedCells(int startRowIndex, int startColumnIndex, int rowCount, int columnCount, java.lang.String[][] values)
          Specifies the formatted values for a block of cells.

void setFormattedColumn(int index, java.lang.String[] values)
          Specifies the formatted values of all the cells in a column.

void setFormattedRow(int index, java.lang.String[] values)
          Specifies the formatted values of all the cells in a row.

void setRow(int rowIndex, java.lang.Object[] values)
          Specifies the values of all the cells in a row.

void setWhere(java.lang.String whereString)
          Passes the whereString to setQueryStatement method.

protected void updateCell(int col, java.lang.Object value)
          This method is called by public "setter" methods.

void useBufferHints(com.sas.models.BufferHints p0)
          This method is not supported.

Methods inherited from class com.sas.storage.jdbc.JDBCAdapter

addPropertyChangeListener, addPropertyChangeListener, calculateRowCount, close, doAbsolute, doCountColumns, doUpdateCell, finalize, getAutoCommit, getConnection, getDisplayTransform, getModel, getPrintWarnings, getQueryStatement, getResultSetConcurrency, getResultSetRowCount, getResultSetType, getRowCountByCountFunction, getRowCountQueryString, init, initializeData, isQueryRowCountDisabled, isReadOnly, isResultSetRequeryUsed, isRetrieveNumericTypesAsDouble, isTrimUsed, printSQLWarning, putColumnInfoUsed, putValueAt, removePropertyChangeListener, removePropertyChangeListener, retrieveColumnClass, retrieveColumnCount, retrieveColumnIndex, retrieveColumnInfoUsed, retrieveColumnLabel, retrieveRawSASNumericValue, retrieveRawSASNumericValue, retrieveValueAt, retrieveValueAt, setAutoCommit, setConnection, setDisplayTransform, setModel, setPrintWarnings, setQueryRowCountDisabled, setQueryStatement, setReadOnly, setResultSetRequeryUsed, setResultSetType, setRetrieveNumericTypesAsDouble, setRowCountQueryString, setTrimUsed

Methods inherited from interface com.sas.table.DataTableInterface

close, isReadOnly, setReadOnly

Field Summary
`protected com.sas.collection.ContentsChangedListenerList`	`allContentsChangedListeners` List of all the ContentsChangedListeners
`protected java.util.Hashtable`	`defaultValues` A Hashtable used to obtain default values for a column.
`static int`	`ERROR_CODE_END_OF_FILE` An error code, used to signal that the end of file was reached when reading rows.

Fields inherited from class com.sas.storage.jdbc.JDBCAdapter
`autoCommit, CLASS_NAME, columnInfoUsed, conn, designTime, displayTransform, forwardOnly, initialized, isRowCountKnown, LABEL, meta, NAME, printWarnings, queryRowCountDisabled, queryStatement, RB_KEY, readOnly, result, resultSetRequeryUsed, resultSetType, resultSetUsed, retrieveNumericTypesAsDouble, rowCount, rowCountQueryString, rowNumber, spcs, stmt, trimUsed`

Fields inherited from interface com.sas.table.RowTemplateTableInterface
`DEFAULT_INDEX`

Constructor Summary
`JDBCToDataTableAdapter()` Default constructor called when the adapter is made in a webAF project.
`JDBCToDataTableAdapter(java.sql.Connection conn, java.lang.String queryStatement)` Constructor used to create an initialized adapter.
`JDBCToDataTableAdapter(java.sql.ResultSet result)` Constructor used to connect an adapter directly to a previously created ResultSet.

Method Summary
`protected boolean`	`absolute(int index)` For scrollable result sets, the `absolute()` method is called on the result set.
`void`	`addColumn(int p0, java.lang.Class p1, java.lang.Object p2)` This method is not supported.
`void`	`addContentsChangedListener(com.sas.collection.ContentsChangedListener listener)`
`void`	`addRow(int index)` This method requires a value of -1 for index.
`void`	`addRow(int index, java.lang.Object[] values)` This method requires a value of -1 for index.
`boolean`	`attachView()` Required by com.sas.ModelInterface.
`void`	`commitRow()` If `autoCommit` is false, this method calls `updateRow` on the result set.
`int`	`countColumns(int maxCount)` The maxCount parameter is ignored and the result of `getColumnCount` is returned.
`int`	`countRows(int maxCount)` Counts the number of rows when the underlying result set is not scrollable (`TYPE_FORWARD_ONLY`) and `resultSetRequeryUsed` is true.
`void`	`deleteColumn(int p0)` This method is not supported.
`void`	`deleteRow(int row)` Deletes the row at the given row number.
`void`	`detachView()` Required by com.sas.ModelInterface.
`void`	`fireCellEvent(int row, int column)` Fire a specific event for a model signaling that one cell has changed.
`protected void`	`fireContentsChanged()` Fire a default contents changed event.
`protected void`	`fireContentsChanged(com.sas.collection.ContentsChangedEvent event)` Send a ContentsChangedEvent to all the ContentsChangedListener objects in the listener list.
`void`	`fireModelEvent()` Fire a default event for a model signaling the some aspect of the model has changed.
`void`	`fireModelEvent(java.util.EventObject event)` Fire a specific event for a model signaling that some aspect of the model has changed.
`int`	`getBufferBlocks()` This method always returns 1.
`int`	`getBufferSize()` This returns the number of rows suggested to the JDBC driver as the number of rows to fetch from the database when more rows are needed for this result set object.
`java.lang.Object`	`getCell(int row, int col)` Returns value of a cell in the JDBC data type of the cell.
`java.lang.Class`	`getCellClass(int row, int col)` Returns the value of column class at the column identified by `col`.
`java.lang.Class[][]`	`getCellClasses(int startRowIndex, int startColumnIndex, int rowCount, int columnCount)` Returns the classes for a block of cells.
`java.lang.Object[][]`	`getCells(int startRowIndex, int startColumnIndex, int rowCount, int columnCount)` Returns values for a block of cells in the JDBC data types of the cells.
`java.lang.Object[]`	`getColumn(int index)` Returns the values of all the cells in a column.
`java.lang.Class`	`getColumnClass(int index)` Returns the class of a column.
`java.lang.Class[]`	`getColumnClasses(int col, int columnCount)` Returns the classes for a range of columns.
`int`	`getColumnCount()` Returns the number of columns in the result set.
`java.lang.Object`	`getColumnDefaultValue(int index)` Returns any default value set by `setColumnDefaultValue`.
`java.lang.Object[]`	`getColumnDefaultValues(int index, int count)` Returns any default values set by `setColumnDefaultValues`.
`int`	`getColumnIndex(java.lang.String name)` Returns the column index for a column name.
`java.lang.Object`	`getColumnInfo(int index, java.lang.String columnInfoName)` Returns the named information for a column.
`java.lang.String[]`	`getColumnInfoNames()` Returns NAME and LABEL in an array.
`java.lang.String`	`getColumnInfoUsed()` Returns the column information that is currently being used as the column label.
`java.lang.Object`	`getColumnLabel(int index)` If columnInfoUsed is "LABEL", gets the suggested column title provided by ResultSetMetaData object for the column at the given index.
`java.lang.Object[]`	`getColumnLabels(int index, int count)` If columnInfoUsed is "LABEL", gets the suggested column titles provided by ResultSetMetaData object for the column range.
`java.lang.String[]`	`getDisplayedColumns()` This method is not supported.
`static com.sas.beans.ExtendedBeanInfo`	`getExtendedBeanInfo()` Manage properties in the webAF properties sheet.
`java.lang.String`	`getFormattedCell(int rowIndex, int colIndex)` Returns the formatted value of a cell.
`java.lang.String[][]`	`getFormattedCells(int startRow, int startColumn, int rowCount, int columnCount)` Returns the formatted values for a block of cells.
`java.lang.String[]`	`getFormattedColumn(int col)` Returns the formatted values of all the cells in a column.
`java.lang.String[]`	`getFormattedRow(int row)` Returns the formatted values of all the cells in a row.
`java.lang.Object[]`	`getRow(int row)` Returns the values of all the cells in a row.
`int`	`getRowCount()` Returns the number of rows in the result set.
`java.lang.Object`	`getRowLabel(int row)` Returns the row number passed in as a statement.
`java.lang.Object[]`	`getRowLabels(int startIndex, int count)` Returns the row number range as statements in an Object array.
`java.lang.String`	`getWhere()` Returns the queryStatement.
`protected void`	`initDefaultValues()` Initialize a hashtable for 1) storing column default values from `setColumnDefaultValue`, 2) getting column default values for `getColumnDefaultValue`.
`boolean`	`isCellsModifiable()` Indicates whether cells can be modified.
`boolean`	`isColumnLabelsSupported()` This method always returns true.
`boolean`	`isColumnsDeletable()` This method always returns false.
`boolean`	`isColumnsExtendable()` This method always returns false.
`boolean`	`isColumnsInsertable()` This method always returns false.
`boolean`	`isColumnsLabelSupported()` This method always returns false.
`boolean`	`isColumnsRedefinable()` This method always returns false.
`boolean`	`isMultipleColumnUpdateSupported()` This method always returns true.
`boolean`	`isMultipleRowUpdateSupported()` This method always returns true.
`boolean`	`isRowLabelsSupported()` This method always returns true.
`boolean`	`isRowsDeletable()` Returns the same value as the `isReadOnly` method.
`boolean`	`isRowsExtendable()` Returns the same value as the `isReadOnly` method.
`boolean`	`isRowsInsertable()` This method always returns false.
`boolean`	`isRowsLabelSupported()` This method always returns false.
`void`	`refresh()` Sets the `initialized` field to false and calls the `init` method.
`void`	`removeContentsChangedListener(com.sas.collection.ContentsChangedListener listener)`
`void`	`setBufferBlocks(int p0)` This method is not supported.
`void`	`setBufferSize(int rows)` Gives the JDBC driver a hint as to the number of rows to fetch from the database when more rows are needed for this ResultSet object.
`void`	`setCell(int rowIndex, int columnIndex, java.lang.Object value)` Updates `value` into the cell at `rowIndex, columnIndex`.
`void`	`setCells(int startRowIndex, int startColumnIndex, int rowCount, int columnCount, java.lang.Object[][] values)` Specifies the values for a block of cells.
`void`	`setColumn(int columnIndex, java.lang.Object[] values)` Specifies the values of all the cells in a column.
`void`	`setColumnClass(int p0, java.lang.Class p1)` This method is not supported.
`void`	`setColumnDefaultValue(int index, java.lang.Object newValue)` Sets the default value associated with a column.
`void`	`setColumnInfoUsed(java.lang.String info)` Sets the column information that is currently being used as the column label.
`void`	`setDisplayedColumns(java.lang.String[] p0)` This method is not supported.
`void`	`setFormattedCell(int rowIndex, int columnIndex, java.lang.String value)` Specifies the formatted value of a cell.
`void`	`setFormattedCells(int startRowIndex, int startColumnIndex, int rowCount, int columnCount, java.lang.String[][] values)` Specifies the formatted values for a block of cells.
`void`	`setFormattedColumn(int index, java.lang.String[] values)` Specifies the formatted values of all the cells in a column.
`void`	`setFormattedRow(int index, java.lang.String[] values)` Specifies the formatted values of all the cells in a row.
`void`	`setRow(int rowIndex, java.lang.Object[] values)` Specifies the values of all the cells in a row.
`void`	`setWhere(java.lang.String whereString)` Passes the `whereString` to `setQueryStatement` method.
`protected void`	`updateCell(int col, java.lang.Object value)` This method is called by public "setter" methods.
`void`	`useBufferHints(com.sas.models.BufferHints p0)` This method is not supported.

Methods inherited from class com.sas.storage.jdbc.JDBCAdapter
addPropertyChangeListener, addPropertyChangeListener, calculateRowCount, close, doAbsolute, doCountColumns, doUpdateCell, finalize, getAutoCommit, getConnection, getDisplayTransform, getModel, getPrintWarnings, getQueryStatement, getResultSetConcurrency, getResultSetRowCount, getResultSetType, getRowCountByCountFunction, getRowCountQueryString, init, initializeData, isQueryRowCountDisabled, isReadOnly, isResultSetRequeryUsed, isRetrieveNumericTypesAsDouble, isTrimUsed, printSQLWarning, putColumnInfoUsed, putValueAt, removePropertyChangeListener, removePropertyChangeListener, retrieveColumnClass, retrieveColumnCount, retrieveColumnIndex, retrieveColumnInfoUsed, retrieveColumnLabel, retrieveRawSASNumericValue, retrieveRawSASNumericValue, retrieveValueAt, retrieveValueAt, setAutoCommit, setConnection, setDisplayTransform, setModel, setPrintWarnings, setQueryRowCountDisabled, setQueryStatement, setReadOnly, setResultSetRequeryUsed, setResultSetType, setRetrieveNumericTypesAsDouble, setRowCountQueryString, setTrimUsed

Methods inherited from interface com.sas.table.DataTableInterface
`close, isReadOnly, setReadOnly`

Field Detail

ERROR_CODE_END_OF_FILE

public static final int ERROR_CODE_END_OF_FILE

An error code, used to signal that the end of file was reached when reading rows.

See Also:: Constant Field Values

defaultValues

protected java.util.Hashtable defaultValues

A Hashtable used to obtain default values for a column.

allContentsChangedListeners

protected transient com.sas.collection.ContentsChangedListenerList allContentsChangedListeners

List of all the ContentsChangedListeners

Constructor Detail