RowSetTableContentProvider (server-common-api)

java.lang.Object
- com.webmethods.caf.faces.bean.PageFlowScopeAdapter
- - com.webmethods.caf.faces.data.sql.RowSetTableContentProvider

All Implemented Interfaces:: IPageFlowScopeAdapter, IAddressableTableContentProvider, IContentProvider, IRefreshable, IRefreshableContentProvider, ISelectableTableContentProvider, ISortableTableContentProvider, ITableContentProvider, ITransactionalContentProvider, IUpdateableContentProvider, IUpdateableTableContentProvider, Serializable

public class RowSetTableContentProvider
extends PageFlowScopeAdapter
implements IUpdateableTableContentProvider, ISortableTableContentProvider, ISelectableTableContentProvider, IRefreshableContentProvider, ITransactionalContentProvider, Serializable

JDBC CachedRowSet table content provider implementation. Allows to access a JDBC datasource and execute SQL queries againt it. Supports auto-refresh, transactional writebacks, row selection and row sorting. Needs an configured CachedRowSet instance to wrap. The CachedRowSet object must have the following properties set:

RowSet.setDataSourceName(java.lang.String)
RowSet.setCommand(java.lang.String)
CachedRowSet.setTableName(java.lang.String) for writebacks only

 
 CachedRowSetImpl rowSet = new CachedRowSetImpl();
 rowSet.setDataSourceName("northwind");
 rowSet.setCommand("SELECT * FROM CUSTOMERS WHERE Country = ?");
 rowSet.setTableName("CUSTOMERS");
 
 ITableContentProvider provider = new RowSetTableContentProvider(rowSet);
 provider.getParameters().set(0, "USA"); // country value
 
 // execute the query and read the data
 for (int i = 0; i < provider.getRowCount(); i++) {
        provider.setRowIndex(i);
        if (provider.isRowAvailable()) {
                String customerID = (String) provider.getValue("CustomerID");
                String companyName = (String) provider.getValue("CompanyName");
        }
 }
 ;
 
 // find a customer by id
 provider.setRowById("ANTON"); // Customer ID
 if (provider.isRowAvailable()) {
        provider.setValue("ContactName", "Jonh Doe");
 }
 
 provider.setRowById("ALFKI"); // another customer
 if (provider.isRowAvailable()) {
        provider.setValue("Country", "USA");
 }
 
 provider.setRowById("TODELETE");
 if (provider.isRowAvailable()) {
        provider.deleteRow(); // delete row
 }
 
 provider.applyChanges(); // commit changes
 
 // change query parameters
 provider.getParameters().set(0, "Ukraine"); // new country value
 if (provider.getRowCount() > 0) { // auto-refresh the provider by re-executing
                                                                        // the query and returing new record count
        // no customers from Ukraine, ha?
 }

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Object`	`autoIncementKeyValue`
`protected boolean`	`autoRefreshMode` Indicates if provider is in "autoRefresh" mode
`protected boolean`	`canTemplateRow`
`protected static String`	`COMMA`
`protected IErrorHandler`	`errorHandler`
`protected int`	`index`
`protected int`	`maxResult`
`protected RowSetMetaData`	`metaData`
`protected boolean`	`needRefresh` Indicates if provider needs to be refreshed
`protected MethodExpression`	`onCreateRow`
`protected MethodExpression`	`onDeleteRow`
`protected List<Object>`	`parameters`
`protected List<String>`	`propertyNames`
`protected List<Object>`	`rowIdProperties`
`protected CachedRowSet`	`rowSet` Wrapped instance of CachedRowSet
`protected String`	`rowVariable`
`protected SelectableTableContentProviderHelper`	`selectableHelper`
`protected ISortInfo`	`sortInfo`
`protected static String`	`SPACE`
`protected static String`	`SQL_ASCENDING`
`protected static String`	`SQL_DESCENDING`
`protected static String`	`SQL_ORDERBY`
`protected static String`	`SQL_PARAMETER`
`protected String`	`syncProviderId`
`protected Object`	`templateRow`
`protected boolean`	`updated`

Fields inherited from class com.webmethods.caf.faces.bean.PageFlowScopeAdapter
fExpireWithPageFlow

Constructor Summary

Constructors
Constructor and Description

RowSetTableContentProvider()
Default constructor.

RowSetTableContentProvider(CachedRowSet rowSet)
Initializes with the given rowSet object.

Constructors
Constructor and Description
`RowSetTableContentProvider()` Default constructor.
`RowSetTableContentProvider(CachedRowSet rowSet)` Initializes with the given rowSet object.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`applyChanges()` Commits changes back to the data source.
`void`	`cancelChanges()` Reverts all changes made since the last `ITransactionalContentProvider.applyChanges()` call.
`protected boolean`	`canOpen()` Returns true if the row set can be opened, i.e.
`void`	`createRow()` Creates new row in the row set.
`void`	`deleteRow()` Deletes current row in the row set
`protected boolean`	`ensureRowSetOpen()` Opens row set if it is not currently open and can be opened, i.e.
`boolean`	`getCanTemplateRow()` True if provider can be put into template row state.
`Connection`	`getCon()`
`Object`	`getCurrentRow()` Returns wrapped current row object.
`IErrorHandler`	`getErrorHandler()` Returns current error handler.
`int`	`getMaxResult()` Returns the maximum results amount.
`boolean`	`getNeedRefresh()` Returns true whenever a query parameter has changed since last `refresh()` call.
`MethodBinding`	`getOnCreateRow()` Deprecated.
`MethodExpression`	`getOnCreateRowExpression()` Returns the custom handler for `createRow()` method
`MethodBinding`	`getOnDeleteRow()` Deprecated. use `getOnDeleteRowExpression()` instead
`MethodExpression`	`getOnDeleteRowExpression()` Returns custom handler for `deleteRow()` method
`List<Object>`	`getParameters()` Returns parameters list.
`Object[]`	`getPropertyKeys()` Returns `String` array of all column names in the row set.
`int`	`getRowCount()` Returns number of records in the row set.
`String`	`getRowId()` Calculates row id based on `CachedRowSet.getKeyColumns()`.
`List<Object>`	`getRowIdProperties()` Returns row id properties list.
`int`	`getRowIndex()` Return current row index
`int`	`getRowSelectedCount()` Returns number of selected rows.
`Collection<String>`	`getRowSelectedIds()` Returns collection of `String` ids of the selected rows.
`CachedRowSet`	`getRowSet()` Returns currently set row set instance
`Collection`	`getRowUnselectedIds()` Returns collection of `String` ids of the un-selected rows (all other rows are selected implicitly) May be empty or contain non-existent ids; never null, never contains null.
`String`	`getRowVariable()` Returns row variable name.
`ISortInfo`	`getSort()` Returns current sort info.
`String`	`getSyncProviderId()`
`Class<?>`	`getType(Object propertyKey)` Returns java type of the given property
`boolean`	`getUseUnselectedModel()` Returns true if it's more effecient to use unselected model (ie `ISelectableTableContentProvider.getRowUnselectedIds()` rather than `ISelectableTableContentProvider.getRowSelectedIds()`).
`Object`	`getValue(Object propertyKey)` Returns column value of the current row for the given column name or index starting from 0.
`boolean`	`hasProperty(Object propertyKey)` Checks if the given property is supported by this content provider
`protected void`	`initializeNewRecord()` Initializes new record at "insert" row, using current state of templateRow.
`protected Object`	`initializeTemplateRecord(boolean withCurrentRowValues)` Creates an object with the default values for a template record (not inserted yet into the rowset).
`boolean`	`isAddressable()` Checks if this content provider truly is addressable.
`boolean`	`isAutoRefresh()` Returns `true` if the provider is currenlty in auto-refresh mode
`protected boolean`	`isOpen()` Returns true if the row set is currently open
`boolean`	`isReadOnly(Object propertyKey)` Returns true if the given column is readonly
`boolean`	`isRowAvailable()` true if row is available
`boolean`	`isRowSelected()` Returns `true` if current row is selected.
`boolean`	`isTemplateRow()` Is provider in state where it returns properties for template pseudo-row.
`protected boolean`	`openRowSet()` Executes the SQL query and populates the row set
`void`	`refresh()` Re-executes the SQL query and populates the row set with new data.
`void`	`setAutoRefresh(boolean autorefresh)` Sets auto refresh mode on.
`void`	`setCanTemplateRow(boolean value)` True if provider can be put into template row state.
`void`	`setCon(Connection con)`
`void`	`setCurrentRow(Object row)` Sets new current row object
`void`	`setErrorHandler(IErrorHandler errorHandler)` Set the errorhandler for this provider
`void`	`setMaxResult(int maxResult)` Sets the maximum results
`void`	`setNeedRefresh(boolean needRefresh)` Tells the provider that the input parameters have changed and the output results need to be refreshed the next time any output property is requested via `IContentProvider.getValue(Object)`.
`void`	`setOnCreateRow(MethodBinding onNewRow)` Deprecated. use `setOnCreateRowExpression(MethodExpression)` instead
`void`	`setOnCreateRowExpression(MethodExpression onNewRow)` Sets custom handler for `createRow()` method
`void`	`setOnDeleteRow(MethodBinding deleteRow)` Deprecated. use `setOnDeleteRowExpression(MethodExpression)` instead
`void`	`setOnDeleteRowExpression(MethodExpression deleteRow)` Sets custom handler for `deleteRow()` method
`void`	`setRowById(String id)` Iterates through the row set to find a record with the given id.
`void`	`setRowId(String id)` JavaBean property setter for `setRowById(String)`
`void`	`setRowIdProperties(List<?> rowIdProperties)` Sets new row id properties.
`void`	`setRowIndex(int rowIndex)` Set index row to input value.
`void`	`setRowSelected(boolean selected)` Sets the selection status for the current row.
`void`	`setRowSelectedIds(Collection ids)` Sets new selection using a collection of `String` ids of the rows to select.
`void`	`setRowSet(CachedRowSet rowSet)` Sets new row set instance
`void`	`setRowUnselectedIds(Collection ids)` Unselects rows using a collection of `String` ids of the un-selected rows (all other rows are selected implicitly).
`void`	`setRowVariable(String var)` Sets row variable name to use for accessing row specific data.
`void`	`setSort(ISortInfo sort)` Augments the SQL query with ORDER BY clause based on the sort info and re-execute it.
`void`	`setSyncProviderId(String syncProviderId)`
`void`	`setTemplateRow()` Sets provider to state where it returns properties for template pseudo-row.
`void`	`setValue(Object propertyKey, Object value)` Sets new value for the given column on the current row.
`boolean`	`supportsAutoRefresh()` Returns true

Methods inherited from class com.webmethods.caf.faces.bean.PageFlowScopeAdapter
getExpireWithPageFlow, setExpireWithPageFlow

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - rowSet
```
protected CachedRowSet rowSet
```
    Wrapped instance of CachedRowSet
  - metaData
```
protected RowSetMetaData metaData
```
  - autoRefreshMode
```
protected boolean autoRefreshMode
```
    Indicates if provider is in "autoRefresh" mode
  - needRefresh
```
protected boolean needRefresh
```
    Indicates if provider needs to be refreshed
  - sortInfo
```
protected ISortInfo sortInfo
```
  - propertyNames
```
protected List<String> propertyNames
```
  - index
```
protected int index
```
  - updated
```
protected boolean updated
```
  - templateRow
```
protected Object templateRow
```
  - canTemplateRow
```
protected boolean canTemplateRow
```
  - autoIncementKeyValue
```
protected Object autoIncementKeyValue
```
  - errorHandler
```
protected IErrorHandler errorHandler
```
  - onCreateRow
```
protected MethodExpression onCreateRow
```
  - onDeleteRow
```
protected MethodExpression onDeleteRow
```
  - maxResult
```
protected int maxResult
```
  - syncProviderId
```
protected String syncProviderId
```
  - rowIdProperties
```
protected List<Object> rowIdProperties
```
  - SQL_ORDERBY
```
protected static final String SQL_ORDERBY
```
    See Also:
    
    Constant Field Values
  - SQL_PARAMETER
```
protected static final String SQL_PARAMETER
```
    See Also:
    
    Constant Field Values
  - SPACE
```
protected static final String SPACE
```
    See Also:
    
    Constant Field Values
  - COMMA
```
protected static final String COMMA
```
    See Also:
    
    Constant Field Values
  - SQL_ASCENDING
```
protected static final String SQL_ASCENDING
```
    See Also:
    
    Constant Field Values
  - SQL_DESCENDING
```
protected static final String SQL_DESCENDING
```
    See Also:
    
    Constant Field Values
  - parameters
```
protected List<Object> parameters
```
  - rowVariable
```
protected String rowVariable
```
  - selectableHelper
```
protected SelectableTableContentProviderHelper selectableHelper
```
- Constructor Detail
  - RowSetTableContentProvider
```
public RowSetTableContentProvider()
```
    Default constructor. setRowSet(CachedRowSet) must be called before use
  - RowSetTableContentProvider
```
public RowSetTableContentProvider(CachedRowSet rowSet)
```
    Initializes with the given rowSet object.
    
    Parameters:
    
    rowSet - a cached row set instance
- Method Detail
  - getRowSet
```
public CachedRowSet getRowSet()
```
    Returns currently set row set instance
    
    Returns:
    
    null if not set
  - getErrorHandler
```
public IErrorHandler getErrorHandler()
```
    Returns current error handler.
    
    Returns:
    
    null if doesn't exist
  - setErrorHandler
```
public void setErrorHandler(IErrorHandler errorHandler)
```
    Set the errorhandler for this provider
    
    Parameters:
    
    errorHandler - the errorhandler to be set
  - setRowSet
```
public void setRowSet(CachedRowSet rowSet)
```
    Sets new row set instance
    
    Parameters:
    
    rowSet - row set instance
  - getParameters
```
public List<Object> getParameters()
```
    Returns parameters list. Each ? in the command can be set using this list. The index of the ? in the SQL query corresponds to the index in this list, starting from 0.
    
    Returns:
    
    parameters list, can be empty, never null.
  - ensureRowSetOpen
```
protected boolean ensureRowSetOpen()
```
    Opens row set if it is not currently open and can be opened, i.e. all required parameters are supplied.
    
    Returns:
    
    false if the row set cannot be opened.
    
    Throws:
    
    ContentProviderException - if error happens during this operation
  - canOpen
```
protected boolean canOpen()
```
    Returns true if the row set can be opened, i.e. all required parameters are set.
    
    Returns:
    
    false if any parameter is not set (null)
  - isOpen
```
protected boolean isOpen()
```
    Returns true if the row set is currently open
    
    Returns:
    
    false if it is closed.
  - openRowSet
```
protected boolean openRowSet()
```
    Executes the SQL query and populates the row set
    
    Returns:
    
    true if successful
  - getCanTemplateRow
```
public boolean getCanTemplateRow()
```
    Description copied from interface: IUpdateableTableContentProvider
    
    True if provider can be put into template row state.
    
    Specified by:
    
    getCanTemplateRow in interface IUpdateableTableContentProvider
    
    See Also:
    
    #setTemplateRow()}
  - setCanTemplateRow
```
public void setCanTemplateRow(boolean value)
```
    Description copied from interface: IUpdateableTableContentProvider
    
    True if provider can be put into template row state. Default: true
    
    Specified by:
    
    setCanTemplateRow in interface IUpdateableTableContentProvider
  - isTemplateRow
```
public boolean isTemplateRow()
```
    Description copied from interface: IUpdateableTableContentProvider
    
    Is provider in state where it returns properties for template pseudo-row. In this state, row index is -1 and row id is null; ITableContentProvider.isRowAvailable() returns false. Setting the row index or id to any value removes provider from this state.
    
    Specified by:
    
    isTemplateRow in interface IUpdateableTableContentProvider
  - setTemplateRow
```
public void setTemplateRow()
```
    Description copied from interface: IUpdateableTableContentProvider
    
    Sets provider to state where it returns properties for template pseudo-row. In this state, row index is -1 and row id is null; ITableContentProvider.isRowAvailable() returns false. Setting the row index or id to any value removes provider from this state.
    
    Specified by:
    
    setTemplateRow in interface IUpdateableTableContentProvider
  - setCurrentRow
```
public void setCurrentRow(Object row)
```
    Description copied from interface: IUpdateableTableContentProvider
    
    Sets new current row object
    
    Specified by:
    
    setCurrentRow in interface IUpdateableTableContentProvider
    
    Parameters:
    
    row - new row object to replace object returned by ITableContentProvider.getCurrentRow()
  - initializeTemplateRecord
```
protected Object initializeTemplateRecord(boolean withCurrentRowValues)
```
    Creates an object with the default values for a template record (not inserted yet into the rowset). By default, creates a map with the default value for each named column specified by rowset's metadata.
    
    Parameters:
    
    withCurrentRowValues -
    
    Returns:
  - createRow
```
public void createRow()
```
    Creates new row in the row set. Calls initializeNewRecord() before inserting the record.
    
    Specified by:
    
    createRow in interface IUpdateableTableContentProvider
  - initializeNewRecord
```
protected void initializeNewRecord()
                            throws SQLException
```
    Initializes new record at "insert" row, using current state of templateRow. By default, copies name columns from templateRow map object into "insert" row.
    
    Throws:
    
    SQLException
  - deleteRow
```
public void deleteRow()
```
    Deletes current row in the row set
    
    Specified by:
    
    deleteRow in interface IUpdateableTableContentProvider
    
    See Also:
    
    ITableContentProvider.getRowIndex()
  - refresh
```
public void refresh()
             throws ContentProviderException
```
    Re-executes the SQL query and populates the row set with new data.
    
    Specified by:
    
    refresh in interface IRefreshable
    
    Throws:
    
    ContentProviderException - if error loading data from the data source
  - supportsAutoRefresh
```
public boolean supportsAutoRefresh()
```
    Returns true
    
    Specified by:
    
    supportsAutoRefresh in interface IRefreshable
    
    Returns:
    
    true
    
    See Also:
    
    IRefreshable.setAutoRefresh(boolean)
  - setAutoRefresh
```
public void setAutoRefresh(boolean autorefresh)
                    throws ContentProviderException
```
    Description copied from interface: IRefreshable
    
    Sets auto refresh mode on. When auto refresh mode is on, the provider calls IRefreshable.getNeedRefresh() to determine whether the refresh needs to be done before returning any result properties. If it returns true, the provider calls IRefreshable.refresh() method to updated the result properties.
    
    Specified by:
    
    setAutoRefresh in interface IRefreshable
    
    Parameters:
    
    autorefresh - true to turn it on
    
    Throws:
    
    ContentProviderException - if auto refresh mode is not supported
    
    See Also:
    
    IRefreshable.supportsAutoRefresh(), IRefreshable.getNeedRefresh(), IRefreshable.setNeedRefresh(boolean)
  - isAutoRefresh
```
public boolean isAutoRefresh()
```
    Description copied from interface: IRefreshable
    
    Returns true if the provider is currenlty in auto-refresh mode
    
    Specified by:
    
    isAutoRefresh in interface IRefreshable
    
    Returns:
    
    false if auto-refresh mode is off or not supported
  - getNeedRefresh
```
public boolean getNeedRefresh()
```
    Returns true whenever a query parameter has changed since last refresh() call.
    
    Specified by:
    
    getNeedRefresh in interface IRefreshable
    
    Returns:
    
    true when the output properties are not up-to-date with the current input parameters, i.e. IRefreshable.refresh() needs to be executed manually or automatically.
  - setNeedRefresh
```
public void setNeedRefresh(boolean needRefresh)
```
    Description copied from interface: IRefreshable
    
    Tells the provider that the input parameters have changed and the output results need to be refreshed the next time any output property is requested via IContentProvider.getValue(Object).
    
    Specified by:
    
    setNeedRefresh in interface IRefreshable
    
    Parameters:
    
    needRefresh - true if the input parameters have changed
  - applyChanges
```
public void applyChanges()
                  throws ContentProviderException
```
    Commits changes back to the data source. In case of an error clients may need to examine the wrapped SyncProviderException for details.
    
    Specified by:
    
    applyChanges in interface ITransactionalContentProvider
    
    Throws:
    
    ContentProviderException - if commit fails
  - cancelChanges
```
public void cancelChanges()
                   throws ContentProviderException
```
    Description copied from interface: ITransactionalContentProvider
    
    Reverts all changes made since the last ITransactionalContentProvider.applyChanges() call.
    
    Specified by:
    
    cancelChanges in interface ITransactionalContentProvider
    
    Throws:
    
    ContentProviderException
  - getPropertyKeys
```
public Object[] getPropertyKeys()
```
    Returns String array of all column names in the row set. Executes the SQL query to find out.
    
    Specified by:
    
    getPropertyKeys in interface IContentProvider
    
    Returns:
    
    array of column names in the row set
  - hasProperty
```
public boolean hasProperty(Object propertyKey)
```
    Description copied from interface: IContentProvider
    
    Checks if the given property is supported by this content provider
    
    Specified by:
    
    hasProperty in interface IContentProvider
    
    Parameters:
    
    propertyKey - property key of type String or Integer
    
    Returns:
    
    true if property is supported
  - getType
```
public Class<?> getType(Object propertyKey)
```
    Description copied from interface: IContentProvider
    
    Returns java type of the given property
    
    Specified by:
    
    getType in interface IContentProvider
    
    Parameters:
    
    propertyKey - the property key of type String or Integer
    
    Returns:
    
    property java Class
  - getValue
```
public Object getValue(Object propertyKey)
                throws ELException,
                       PropertyNotFoundException
```
    Returns column value of the current row for the given column name or index starting from 0. The row set will be opened if it is closed.
    
    Specified by:
    
    getValue in interface IContentProvider
    
    Parameters:
    
    propertyKey - column name of index
    
    Returns:
    
    value of the property, can be null
    
    Throws:
    
    PropertyNotFoundException - if property is not supported
    
    ELException
  - setValue
```
public void setValue(Object propertyKey,
                     Object value)
              throws ELException,
                     PropertyNotFoundException
```
    Sets new value for the given column on the current row. The row set will be opened if it is closed.
    
    Specified by:
    
    setValue in interface IUpdateableContentProvider
    
    Parameters:
    
    propertyKey - column name of index
    
    value - new value
    
    Throws:
    
    ELException - if error updating the column
    
    PropertyNotFoundException - if column does not exist
  - isReadOnly
```
public boolean isReadOnly(Object propertyKey)
                   throws ELException,
                          PropertyNotFoundException
```
    Returns true if the given column is readonly
    
    Specified by:
    
    isReadOnly in interface IUpdateableContentProvider
    
    Parameters:
    
    propertyKey - column name or index
    
    Returns:
    
    true if the column is readonly
    
    Throws:
    
    PropertyNotFoundException
    
    ELException
  - isRowAvailable
```
public boolean isRowAvailable()
```
    true if row is available
    
    Specified by:
    
    isRowAvailable in interface ITableContentProvider
    
    See Also:
    
    DataModel.isRowAvailable()
  - getRowCount
```
public int getRowCount()
```
    Returns number of records in the row set. Executes the query if necessary.
    
    Specified by:
    
    getRowCount in interface ITableContentProvider
    
    Returns:
    
    number of records
    
    See Also:
    
    DataModel.getRowCount()
  - getRowIndex
```
public int getRowIndex()
```
    Return current row index
    
    Specified by:
    
    getRowIndex in interface ITableContentProvider
    
    See Also:
    
    DataModel.getRowIndex()
  - setRowIndex
```
public void setRowIndex(int rowIndex)
```
    Set index row to input value.
    
    Specified by:
    
    setRowIndex in interface ITableContentProvider
    
    See Also:
    
    DataModel.getRowIndex()
  - getRowVariable
```
public String getRowVariable()
```
    Description copied from interface: ITableContentProvider
    
    Returns row variable name.
    
    If specified row variable can be used to access current row data for the provider internal needs, like sorting or addressing.
    
    Specified by:
    
    getRowVariable in interface ITableContentProvider
    
    Returns:
    
    row variable name or null if not specified
    
    See Also:
    
    ITableContentProvider.setRowVariable(String)
  - setRowVariable
```
public void setRowVariable(String var)
```
    Description copied from interface: ITableContentProvider
    
    Sets row variable name to use for accessing row specific data. For example, if the provider wrapps an array of a data objects with id property and the variable name is item, then the provider implementation can access id property of each record as item.id.
    
    This property should set only once at the provider initialization time
    
    Specified by:
    
    setRowVariable in interface ITableContentProvider
  - getCurrentRow
```
public Object getCurrentRow()
```
    Description copied from interface: ITableContentProvider
    
    Returns wrapped current row object. Can be null if not data is available
    
    Specified by:
    
    getCurrentRow in interface ITableContentProvider
    
    Returns:
    
    current row object
    
    See Also:
    
    ITableContentProvider.isRowAvailable()
  - isAddressable
```
public boolean isAddressable()
```
    Description copied from interface: IAddressableTableContentProvider
    
    Checks if this content provider truly is addressable.
    
    Specified by:
    
    isAddressable in interface IAddressableTableContentProvider
    
    Returns:
    
    true if addressable.
  - getRowIdProperties
```
public List<Object> getRowIdProperties()
```
    Returns row id properties list.
    
    Returns:
    
    empty list of no row id properties are set
  - setRowIdProperties
```
public void setRowIdProperties(List<?> rowIdProperties)
```
    Sets new row id properties. Can use property names or indexes compatibly with getPropertyKeys() and getValue(Object)
    
    Parameters:
    
    binding - value binding expression to evaluate row id
  - getRowId
```
public String getRowId()
```
    Calculates row id based on CachedRowSet.getKeyColumns().
    
    Specified by:
    
    getRowId in interface IAddressableTableContentProvider
    
    Returns:
    
    current row id or null
  - setRowById
```
public void setRowById(String id)
```
    Iterates through the row set to find a record with the given id. If not found sets current row index to -1.
    
    Specified by:
    
    setRowById in interface IAddressableTableContentProvider
    
    Parameters:
    
    id - row id
  - setRowId
```
public void setRowId(String id)
```
    JavaBean property setter for setRowById(String)
    
    Parameters:
    
    id -
  - isRowSelected
```
public boolean isRowSelected()
```
    Description copied from interface: ISelectableTableContentProvider
    
    Returns true if current row is selected.
    
    Specified by:
    
    isRowSelected in interface ISelectableTableContentProvider
    
    Returns:
    
    true if current row is selection
  - setRowSelected
```
public void setRowSelected(boolean selected)
```
    Description copied from interface: ISelectableTableContentProvider
    
    Sets the selection status for the current row.
    
    Specified by:
    
    setRowSelected in interface ISelectableTableContentProvider
    
    Parameters:
    
    selected - true to select current row; false to unselect.
  - getRowSelectedCount
```
public int getRowSelectedCount()
```
    Description copied from interface: ISelectableTableContentProvider
    
    Returns number of selected rows.
    
    Specified by:
    
    getRowSelectedCount in interface ISelectableTableContentProvider
    
    Returns:
    
    number of currently selection rows
  - getRowSelectedIds
```
public Collection<String> getRowSelectedIds()
```
    Description copied from interface: ISelectableTableContentProvider
    
    Returns collection of String ids of the selected rows. May be empty or contain non-existent ids; never null, never contains null.
    
    Specified by:
    
    getRowSelectedIds in interface ISelectableTableContentProvider
    
    Returns:
    
    collection of ids of selected rows
  - setRowSelectedIds
```
public void setRowSelectedIds(Collection ids)
```
    Description copied from interface: ISelectableTableContentProvider
    
    Sets new selection using a collection of String ids of the rows to select. May be empty or contain non-existent ids; never null, never contains null.
    
    Specified by:
    
    setRowSelectedIds in interface ISelectableTableContentProvider
    
    Parameters:
    
    ids - the collection of String row ids
  - getUseUnselectedModel
```
public boolean getUseUnselectedModel()
```
    Description copied from interface: ISelectableTableContentProvider
    
    Returns true if it's more effecient to use unselected model (ie ISelectableTableContentProvider.getRowUnselectedIds() rather than ISelectableTableContentProvider.getRowSelectedIds()).
    
    Specified by:
    
    getUseUnselectedModel in interface ISelectableTableContentProvider
    
    Returns:
    
    true if it's more effecient to use unselected model
  - getRowUnselectedIds
```
public Collection getRowUnselectedIds()
```
    Description copied from interface: ISelectableTableContentProvider
    
    Returns collection of String ids of the un-selected rows (all other rows are selected implicitly) May be empty or contain non-existent ids; never null, never contains null.
    
    Specified by:
    
    getRowUnselectedIds in interface ISelectableTableContentProvider
    
    Returns:
    
    collection of ids of the un-selection rows
  - setRowUnselectedIds
```
public void setRowUnselectedIds(Collection ids)
```
    Description copied from interface: ISelectableTableContentProvider
    
    Unselects rows using a collection of String ids of the un-selected rows (all other rows are selected implicitly). May be empty or contain non-existent ids; never null, never contains null.
    
    Specified by:
    
    setRowUnselectedIds in interface ISelectableTableContentProvider
    
    Parameters:
    
    ids - collection of String row ids
  - getSort
```
public ISortInfo getSort()
```
    Description copied from interface: ISortableTableContentProvider
    
    Returns current sort info. Never null.
    
    Specified by:
    
    getSort in interface ISortableTableContentProvider
    
    Returns:
    
    currenly set sort info
  - setSort
```
public void setSort(ISortInfo sort)
```
    Augments the SQL query with ORDER BY clause based on the sort info and re-execute it. Soft info property keys may be either binding expressions of row set field names.
    
    Specified by:
    
    setSort in interface ISortableTableContentProvider
    
    Parameters:
    
    sort - new sort info
  - getOnCreateRow
```
@Deprecated
public MethodBinding getOnCreateRow()
```
    Deprecated.
    
    Returns the custom handler for createRow() method
    
    See Also:
    
    setOnCreateRow(javax.faces.el.MethodBinding)
  - getOnCreateRowExpression
```
public MethodExpression getOnCreateRowExpression()
```
    Returns the custom handler for createRow() method
    
    See Also:
    
    setOnCreateRowExpression(MethodExpression)
  - setOnCreateRow
```
@Deprecated
public void setOnCreateRow(MethodBinding onNewRow)
```
    Deprecated. use setOnCreateRowExpression(MethodExpression) instead
    
    Sets custom handler for createRow() method
    
    Parameters:
    
    onNewRow - method binding expression for a method that is called from createRow()
  - setOnCreateRowExpression
```
public void setOnCreateRowExpression(MethodExpression onNewRow)
```
    Sets custom handler for createRow() method
    
    Parameters:
    
    onNewRow - method binding expression for a method that is called from createRow()
  - getOnDeleteRow
```
@Deprecated
public MethodBinding getOnDeleteRow()
```
    Deprecated. use getOnDeleteRowExpression() instead
    
    Returns custom handler for deleteRow() method
    
    See Also:
    
    setOnDeleteRow(javax.faces.el.MethodBinding)
  - getOnDeleteRowExpression
```
public MethodExpression getOnDeleteRowExpression()
```
    Returns custom handler for deleteRow() method
    
    See Also:
    
    setOnDeleteRowExpression(MethodExpression)
  - setOnDeleteRow
```
@Deprecated
public void setOnDeleteRow(MethodBinding deleteRow)
```
    Deprecated. use setOnDeleteRowExpression(MethodExpression) instead
    
    Sets custom handler for deleteRow() method
    
    Parameters:
    
    onNewRow - method binding expression for a method that is called from deleteRow()
  - setOnDeleteRowExpression
```
public void setOnDeleteRowExpression(MethodExpression deleteRow)
```
    Sets custom handler for deleteRow() method
    
    Parameters:
    
    onNewRow - method binding expression for a method that is called from deleteRow()
  - getSyncProviderId
```
public String getSyncProviderId()
```
  - setSyncProviderId
```
public void setSyncProviderId(String syncProviderId)
```
  - getMaxResult
```
public int getMaxResult()
```
    Returns the maximum results amount.
    
    Returns:
    
    value for maximum amount of results that can be made
  - setMaxResult
```
public void setMaxResult(int maxResult)
```
    Sets the maximum results
    
    Parameters:
    
    maxResult - max number of results
  - getCon
```
public Connection getCon()
```
  - setCon
```
public void setCon(Connection con)
```

Class RowSetTableContentProvider

Field Summary

Fields inherited from class com.webmethods.caf.faces.bean.PageFlowScopeAdapter

Constructor Summary

Method Summary

Methods inherited from class com.webmethods.caf.faces.bean.PageFlowScopeAdapter

Methods inherited from class java.lang.Object

Field Detail

rowSet

metaData

autoRefreshMode

needRefresh

sortInfo

propertyNames

index

updated

templateRow

canTemplateRow

autoIncementKeyValue

errorHandler

onCreateRow

onDeleteRow

maxResult

syncProviderId

rowIdProperties

SQL_ORDERBY

SQL_PARAMETER

SPACE

COMMA

SQL_ASCENDING

SQL_DESCENDING

parameters

rowVariable

selectableHelper

Constructor Detail

RowSetTableContentProvider

RowSetTableContentProvider

Method Detail

getRowSet

getErrorHandler

setErrorHandler

setRowSet

getParameters

ensureRowSetOpen

canOpen

isOpen

openRowSet

getCanTemplateRow

setCanTemplateRow

isTemplateRow

setTemplateRow

setCurrentRow

initializeTemplateRecord

createRow

initializeNewRecord

deleteRow

refresh

supportsAutoRefresh

setAutoRefresh

isAutoRefresh

getNeedRefresh

setNeedRefresh

applyChanges

cancelChanges

getPropertyKeys

hasProperty

getType

getValue

setValue

isReadOnly

isRowAvailable

getRowCount

getRowIndex

setRowIndex

getRowVariable

setRowVariable

getCurrentRow

isAddressable

getRowIdProperties

setRowIdProperties