com.sun.data.provider.impl
Class FilteredTableDataProvider

java.lang.Object
  com.sun.data.provider.impl.AbstractDataProvider
      com.sun.data.provider.impl.AbstractTableDataProvider
          com.sun.data.provider.impl.FilteredTableDataProvider

All Implemented Interfaces:

DataProvider, java.io.Serializable, TableDataProvider

public class FilteredTableDataProvider

extends AbstractTableDataProvider

Specialized TableDataProvider that is filtered by a specified TableDataFilter.

See Also:

Serialized Form

Field Summary

protected TableDataFilter	filter
protected TableDataProvider	provider

Fields inherited from class com.sun.data.provider.impl.AbstractTableDataProvider

cursorRow, rowKeyList, rowKeyMap, tcListeners

Fields inherited from class com.sun.data.provider.impl.AbstractDataProvider

dpListeners, fieldKeys

Constructor Summary

FilteredTableDataProvider()

Method Summary

RowKey	appendRow() Appends a new row at the end of the list and returns the row key for the newly appended row. NOTE: The method should only be called after testing the canAppendRow() method to see if this TableDataProvider supports the append operation.
boolean	canAppendRow() This method is called to test if this TableDataProvider supports the append operation. If rows can be appended to the list, this method should return true. If the data provider is not resizable, or cannot support an append operation, this method should return false.
boolean	canInsertRow(RowKey beforeRow) This method is called to test if this TableDataProvider supports resizability. If objects can be inserted and removed from the list, this method should return true. If the data provider is not resizable, this method should return false. The following methods will only be called if this method returns true: insertRow(RowKey beforeRow) appendRow() removeRow(RowKey rowKey)
boolean	canRemoveRow(RowKey row) This method is called to test if this TableDataProvider supports the removeRow operation. If rows can be removed from the table, this method should return true. If the data provider is does not support removing rows, this method should return false.
boolean	cursorFirst() Move the cursor to the first row in this TableDataProvider.
boolean	cursorLast() Move the cursor to the last row in this TableDataProvider.
boolean	cursorNext() Move the cursor to the row after the current cursor row, unless the cursor is currently at the last row TableDataProvider.
boolean	cursorPrevious() Move the cursor to the row before the current cursor row, unless the cursor is currently at the first row.
FieldKey	getFieldKey(java.lang.String fieldId) Returns the FieldKey associated with the specified data element canonical id, if any; otherwise, return null.
FieldKey[]	getFieldKeys()
int	getRowCount()
RowKey	getRowKey(java.lang.String rowId)
RowKey[]	getRowKeys(int count, RowKey afterRow) Returns an array of RowKey objects representing the requested batch of RowKeys. If null is passed as the afterRow parameter, the returned batch of RowKeys will start with the first one.
TableDataFilter	getTableDataFilter()
TableDataProvider	getTableDataProvider()
java.lang.Class	getType(FieldKey fieldKey) Returns the data type of the data element referenced by the specified data key.
java.lang.Object	getValue(FieldKey fieldKey, RowKey row) Return value of the data element referenced by the specified FieldKey and RowKey.
RowKey	insertRow(RowKey beforeRow) Inserts a new row at the specified row. NOTE: The method should only be called after testing the canInsertRow(RowKey beforeRow) to see if this TableDataProvider supports resizing.
boolean	isReadOnly(FieldKey fieldKey) Return a flag indicating whether the value of the data element represented by the specified FieldKey can be modified via the setValue() method.
boolean	isRowAvailable(RowKey row) Returns true if the specified RowKey represents data elements that are supported by this TableDataProvider; otherwise, return false
void	removeRow(RowKey row) Removes the specified row. NOTE: The method should only be called after testing the canRemoveRow(RowKey) method to see if this TableDataProvider supports removing rows.
void	setTableDataFilter(TableDataFilter filter)
void	setTableDataProvider(TableDataProvider provider)
void	setValue(FieldKey fieldKey, RowKey row, java.lang.Object value) Sets the value of the data element represented by the specified FieldKey and RowKey to the specified new value.

Methods inherited from class com.sun.data.provider.impl.AbstractTableDataProvider

addTableCursorListener, addTableDataListener, findAll, findAll, findAll, findAll, findFirst, findFirst, findFirst, findFirst, fireCursorChanged, fireCursorChanging, fireRowAdded, fireRowRemoved, fireValueChanged, getAllRows, getCursorIndex, getCursorRow, getTableCursorListeners, getTableDataListeners, getValue, getValue, removeTableCursorListener, removeTableDataListener, setCursorIndex, setCursorRow, setValue, setValue

Methods inherited from class com.sun.data.provider.impl.AbstractDataProvider

addDataListener, addFieldKey, addFieldKeys, clearFieldKeys, fireProviderChanged, fireValueChanged, getDataListeners, getFakeData, getFakeData, getType, getValue, isReadOnly, removeDataListener, removeFieldKey, removeFieldKeys, setValue, sortFieldKeys

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.data.provider.DataProvider

addDataListener, getDataListeners, removeDataListener

Field Detail

provider

protected TableDataProvider provider

filter

protected TableDataFilter filter

Constructor Detail

FilteredTableDataProvider

public FilteredTableDataProvider()

Method Detail

setTableDataProvider

public void setTableDataProvider(TableDataProvider provider)

Parameters:

provider - TableDataProvider

getTableDataProvider

public TableDataProvider getTableDataProvider()

Returns:

TableDataProvider

setTableDataFilter

public void setTableDataFilter(TableDataFilter filter)

Parameters:

filter - TableDataFilter

getTableDataFilter

public TableDataFilter getTableDataFilter()

Returns:

TableDataFilter

getFieldKeys

public FieldKey[] getFieldKeys()
                        throws DataProviderException

Description copied from class: AbstractDataProvider

Specified by:

getFieldKeys in interface DataProvider

Overrides:

getFieldKeys in class AbstractDataProvider

Returns:

FieldKey[]

Throws:

DataProviderException

getFieldKey

public FieldKey getFieldKey(java.lang.String fieldId)
                     throws DataProviderException

Description copied from interface: DataProvider

Returns the FieldKey associated with the specified data element canonical id, if any; otherwise, return null.

Specified by:

getFieldKey in interface DataProvider

Overrides:

getFieldKey in class AbstractDataProvider

Parameters:

fieldId - String

Returns:

FieldKey

Throws:

DataProviderException

getType

public java.lang.Class getType(FieldKey fieldKey)
                        throws DataProviderException

Returns the data type of the data element referenced by the specified data key.

Specified by:

getType in interface DataProvider

Specified by:

getType in class AbstractTableDataProvider

Throws:

DataProviderException

isReadOnly

public boolean isReadOnly(FieldKey fieldKey)
                   throws DataProviderException

Return a flag indicating whether the value of the data element represented by the specified FieldKey can be modified via the setValue() method.

Specified by:

isReadOnly in interface DataProvider

Specified by:

isReadOnly in class AbstractTableDataProvider

Throws:

DataProviderException

getRowCount

public int getRowCount()
                throws DataProviderException

Specified by:

getRowCount in interface TableDataProvider

Specified by:

getRowCount in class AbstractTableDataProvider

Throws:

DataProviderException

getRowKeys

public RowKey[] getRowKeys(int count,
                           RowKey afterRow)
                    throws DataProviderException

Returns an array of RowKey objects representing the requested batch of RowKeys. If null is passed as the afterRow parameter, the returned batch of RowKeys will start with the first one.

Specified by:

getRowKeys in interface TableDataProvider

Overrides:

getRowKeys in class AbstractTableDataProvider

Throws:

DataProviderException

getRowKey

public RowKey getRowKey(java.lang.String rowId)
                 throws DataProviderException

Specified by:

getRowKey in interface TableDataProvider

Overrides:

getRowKey in class AbstractTableDataProvider

Throws:

DataProviderException

isRowAvailable

public boolean isRowAvailable(RowKey row)
                       throws DataProviderException

Returns true if the specified RowKey represents data elements that are supported by this TableDataProvider; otherwise, return false

Specified by:

isRowAvailable in interface TableDataProvider

Overrides:

isRowAvailable in class AbstractTableDataProvider

Throws:

DataProviderException

getValue

public java.lang.Object getValue(FieldKey fieldKey,
                                 RowKey row)
                          throws DataProviderException

Return value of the data element referenced by the specified FieldKey and RowKey.

Specified by:

getValue in interface TableDataProvider

Specified by:

getValue in class AbstractTableDataProvider

Throws:

DataProviderException

setValue

public void setValue(FieldKey fieldKey,
                     RowKey row,
                     java.lang.Object value)
              throws DataProviderException

Sets the value of the data element represented by the specified FieldKey and RowKey to the specified new value.

Specified by:

setValue in interface TableDataProvider

Specified by:

setValue in class AbstractTableDataProvider

Throws:

DataProviderException

canInsertRow

public boolean canInsertRow(RowKey beforeRow)
                     throws DataProviderException

This method is called to test if this TableDataProvider supports resizability. If objects can be inserted and removed from the list, this method should return true. If the data provider is not resizable, this method should return false.

The following methods will only be called if this method returns true:

• insertRow(RowKey beforeRow)
• appendRow()
• removeRow(RowKey rowKey)

Specified by:

canInsertRow in interface TableDataProvider

Specified by:

canInsertRow in class AbstractTableDataProvider

Throws:

DataProviderException

insertRow

public RowKey insertRow(RowKey beforeRow)
                 throws DataProviderException

Inserts a new row at the specified row.

NOTE: The method should only be called after testing the canInsertRow(RowKey beforeRow) to see if this TableDataProvider supports resizing.

Specified by:

insertRow in interface TableDataProvider

Specified by:

insertRow in class AbstractTableDataProvider

Throws:

DataProviderException

canAppendRow

public boolean canAppendRow()
                     throws DataProviderException

This method is called to test if this TableDataProvider supports the append operation. If rows can be appended to the list, this method should return true. If the data provider is not resizable, or cannot support an append operation, this method should return false.

Specified by:

canAppendRow in interface TableDataProvider

Specified by:

canAppendRow in class AbstractTableDataProvider

Throws:

DataProviderException

appendRow

public RowKey appendRow()
                 throws DataProviderException

Appends a new row at the end of the list and returns the row key for the newly appended row.

NOTE: The method should only be called after testing the canAppendRow() method to see if this TableDataProvider supports the append operation.

Specified by:

appendRow in interface TableDataProvider

Specified by:

appendRow in class AbstractTableDataProvider

Throws:

DataProviderException

canRemoveRow

public boolean canRemoveRow(RowKey row)
                     throws DataProviderException

This method is called to test if this TableDataProvider supports the removeRow operation. If rows can be removed from the table, this method should return true. If the data provider is does not support removing rows, this method should return false.

Specified by:

canRemoveRow in interface TableDataProvider

Specified by:

canRemoveRow in class AbstractTableDataProvider

Throws:

DataProviderException

removeRow

public void removeRow(RowKey row)
               throws DataProviderException

Removes the specified row.

NOTE: The method should only be called after testing the canRemoveRow(RowKey) method to see if this TableDataProvider supports removing rows.

Specified by:

removeRow in interface TableDataProvider

Specified by:

removeRow in class AbstractTableDataProvider

Throws:

DataProviderException

cursorFirst

public boolean cursorFirst()
                    throws DataProviderException

Move the cursor to the first row in this TableDataProvider.

Specified by:

cursorFirst in interface TableDataProvider

Overrides:

cursorFirst in class AbstractTableDataProvider

Throws:

DataProviderException

cursorPrevious

public boolean cursorPrevious()
                       throws DataProviderException

Move the cursor to the row before the current cursor row, unless the cursor is currently at the first row.

Specified by:

cursorPrevious in interface TableDataProvider

Overrides:

cursorPrevious in class AbstractTableDataProvider

Throws:

DataProviderException

cursorNext

public boolean cursorNext()
                   throws DataProviderException

Move the cursor to the row after the current cursor row, unless the cursor is currently at the last row TableDataProvider.

Specified by:

cursorNext in interface TableDataProvider

Overrides:

cursorNext in class AbstractTableDataProvider

Throws:

DataProviderException

cursorLast

public boolean cursorLast()
                   throws DataProviderException

Move the cursor to the last row in this TableDataProvider.

Specified by:

cursorLast in interface TableDataProvider

Overrides:

cursorLast in class AbstractTableDataProvider

Throws:

DataProviderException