| java.lang.Object
 com.sun.data.provider.impl.AbstractDataProvider
com.sun.data.provider.impl.AbstractTableDataProvider
com.sun.data.provider.impl.ObjectListDataProvider
All known Subclasses: movieslib.MovieListDataProvider,
| ObjectListDataProvider | | public class ObjectListDataProvider extends AbstractTableDataProvider implements Serializable,TransactionalDataProvider(Code) | | This
com.sun.data.provider.TableDataProvider wraps access to a
list of Java Objects. The
FieldKey s correspond to the JavaBean
properties and optionally the public member fields of the Java Object.
This class implements
TransactionalDataProvider semantics,
meaning that all updates to existing fields, as well as inserted and
deleted rows, are cached until commitChanges() is called.
Once that call is made, any RowKey you have retrieved from
this instance is invalid, and must be reacquired.
WARNING - Until you call setList() or
setObjectType() with a non-null parameter, or use a constructor
variant that accepts an non-null non-empty list, no information about field keys will
be available. Therefore, any attempt to reference a FieldKey
or field identifier in a method call will throw
IllegalArgumentException.
NOTE about Serializable: This class wraps access to a list of any Java
Objects. The Objects can be swapped out using the setObject(Object)
method. For this class to remain Serializable, the contained Objects must
also be Serializable.
author:
Joe Nuxoll
author:
Winston Prakash (bug fixes) |
| ObjectListDataProvider | | public ObjectListDataProvider()(Code) | | Construct a new ObjectListDataProvider with no known object type. The
setObjectType() method can be used to set the object type.
If not set, the first added object will automatically define the object
type.
|
| ObjectListDataProvider | | public ObjectListDataProvider(List list)(Code) | | Constructs a new ObjectListDataProvider wrapping the specified list.
Parameters:
list - List to be wrapped |
| ObjectListDataProvider | | public ObjectListDataProvider(List list, boolean includeFields)(Code) | | Constructs a new ObjectListDataProvider wrapping the specified list
with the specified include fields flag.
Parameters:
list - List to be wrapped
Parameters:
includeFields - Desired include fields property setting |
| ObjectListDataProvider | | public ObjectListDataProvider(Class objectType)(Code) | | Constructs a new ObjectListDataProvider for the specified object type.
Parameters:
objectType - Desired object type Class |
| ObjectListDataProvider | | public ObjectListDataProvider(Class objectType, boolean includeFields)(Code) | | Constructs a new ObjectListDataProvider for the specified object type
and includeFields property value.
Parameters:
objectType - Desired object type Class
Parameters:
includeFields - Desired include fields property setting |
| addObject | | public void addObject(Object object)(Code) | | Append the specified object to the list of contained objects.
Parameters:
object - The Object to store in the list |
| canAppendRow | | public boolean canAppendRow() throws DataProviderException(Code) | | Return true if the userResizable property is set to
true, and there is a public zero-args constructor for the
class specified by the objectType property.
|
| canInsertRow | | public boolean canInsertRow(RowKey beforeRow) throws DataProviderException(Code) | | Return true if the userResizable property is set to
true, and there is a public zero-args constructor for the
class specified by the objectType property.
|
| clearObjectList | | public void clearObjectList()(Code) | | Clear the list of contained objects.
|
| getList | | public List getList()(Code) | | Return the List that we are wrapping.
|
| getObject | | public Object getObject(RowKey row)(Code) | | Returns the object stored at the specified row.
Parameters:
row - The desired row to retrieve the contained object from |
| getObjectType | | public Class getObjectType()(Code) | | Return the object type that this data provider contains. This
determines the list of
FieldKey s that this provider supplies.
|
| getObjects | | public Object[] getObjects()(Code) | | Return the contained objects as an array.
|
| insertRow | | public RowKey insertRow(RowKey beforeRow) throws DataProviderException(Code) | | Construct a new instance of the specified object type and insert it
at the specified position in the list.
Parameters:
beforeRow - Row before which to insert the new row |
| isIncludeFields | | public boolean isIncludeFields()(Code) | | Return the state of the includeFields property.
|
| isRemoved | | public boolean isRemoved(RowKey row)(Code) | | Return true if the specified row has been
marked for removal on the next call to commitChanges().
Parameters:
row - The RowKey of the row to check |
| isRowAvailable | | public boolean isRowAvailable(RowKey row) throws DataProviderException(Code) | | Return true if the specified
RowKey represents
a row in the original list, or a row that has been appended. FIXME -
deal with
RowKey s for inserted rows too, when inserts are
supported.
Parameters:
row - RowKey to test for availability |
| isUserResizable | | public boolean isUserResizable()(Code) | | Return the current state of the userResizable property. Note that
the wrapped list will not be actually resizable unless there is a
public no-args constructor on the objectType class.
|
| removeObject | | public void removeObject(Object object)(Code) | | Remove the specified object from the list of contained objects.
Parameters:
object - The Object to remove from the list |
| removeObject | | public void removeObject(RowKey row)(Code) | | Remove the object at the specified row from the list
of contained objects.
Parameters:
row - The desired Object row to remove from the list |
| setIncludeFields | | public void setIncludeFields(boolean includeFields)(Code) | | Set the includeFields property. This affects the set of
FieldKey s that this
com.sun.data.provider.DataProvider emits. If the property is set to true (the default), then
public fields will be included in the list of available keys (intermixed
with the public properties). Otherwise, only the public properties will
be available.
Parameters:
includeFields - The new include fields value |
| setList | | public void setList(List list)(Code) | | Replace the List that we are wrapping. In addition,
the objectType property will be reset based on the
class of the first element in the list (if any). If the list is
empty, objectType will be set to null.
Parameters:
list - The new list to be wrapped |
| setObject | | public void setObject(RowKey row, Object object)(Code) | | Replace the object at the specified row.
Parameters:
row - The desired row to set the contained object
Parameters:
object - The new object to set at the specified row |
| setObjectType | | public void setObjectType(Class objectType)(Code) | | Set the object type contained in this ObjectListDataProvider. This
type determines the list of public properties and fields to expose as
FieldKey s. If no object type is specified, the first added
object's class will be used as the object type.
Parameters:
objectType - The desired Class type to be contained in thisObjectDataProvider |
| setUserResizable | | public void setUserResizable(boolean resizable)(Code) | | Set the user resizable property. If set to true (the
default), the resizability of this ObjectListDataProvider is based on
wether or not a public default constructor exists in the object type.
If the userResizable propert is set to false, then this
ObjectListDataProvider will not be resizable, regardless of the existence
of a public default constructor on the object type.
Parameters:
resizable - true to make this ObjectListDataProviderresizable, pending the existence of a public default constructoron the contained object type, or false to make itnon-resizable.
See Also: com.sun.data.provider.TableDataProvider.canInsertRow(RowKey beforeRow) |
| Methods inherited from com.sun.data.provider.impl.AbstractTableDataProvider | public void addTableCursorListener(TableCursorListener listener)(Code)(Java Doc)
public void addTableDataListener(TableDataListener l)(Code)(Java Doc)
abstract public RowKey appendRow() throws DataProviderException(Code)(Java Doc)
abstract public boolean canAppendRow() throws DataProviderException(Code)(Java Doc)
abstract public boolean canInsertRow(RowKey beforeRow) throws DataProviderException(Code)(Java Doc)
abstract public boolean canRemoveRow(RowKey row) throws DataProviderException(Code)(Java Doc)
public boolean cursorFirst() throws DataProviderException(Code)(Java Doc)
public boolean cursorLast() throws DataProviderException(Code)(Java Doc)
public boolean cursorNext() throws DataProviderException(Code)(Java Doc)
public boolean cursorPrevious() throws DataProviderException(Code)(Java Doc)
public RowKey[] findAll(String fieldId, Object value) throws DataProviderException(Code)(Java Doc)
public RowKey[] findAll(String[] fieldIds, Object[] values) throws DataProviderException(Code)(Java Doc)
public RowKey[] findAll(FieldKey fieldKey, Object value) throws DataProviderException(Code)(Java Doc)
public RowKey[] findAll(FieldKey[] fieldKeys, Object[] values) throws DataProviderException(Code)(Java Doc)
public RowKey findFirst(String fieldId, Object value) throws DataProviderException(Code)(Java Doc)
public RowKey findFirst(String[] fieldIds, Object[] values) throws DataProviderException(Code)(Java Doc)
public RowKey findFirst(FieldKey fieldKey, Object value) throws DataProviderException(Code)(Java Doc)
public RowKey findFirst(FieldKey[] fieldKeys, Object[] values) throws DataProviderException(Code)(Java Doc)
protected void fireCursorChanged(RowKey oldRow, RowKey newRow)(Code)(Java Doc)
protected void fireCursorChanging(RowKey oldRow, RowKey newRow) throws TableCursorVetoException(Code)(Java Doc)
protected void fireRowAdded(RowKey newRow)(Code)(Java Doc)
protected void fireRowRemoved(RowKey oldRow)(Code)(Java Doc)
protected void fireValueChanged(FieldKey fieldKey, RowKey row, Object oldValue, Object newValue)(Code)(Java Doc)
public RowKey[] getAllRows() throws DataProviderException(Code)(Java Doc)
protected int getCursorIndex()(Code)(Java Doc)
public RowKey getCursorRow() throws DataProviderException(Code)(Java Doc)
abstract public int getRowCount() throws DataProviderException(Code)(Java Doc)
public RowKey getRowKey(String rowId) throws DataProviderException(Code)(Java Doc)
public RowKey[] getRowKeys(int count, RowKey afterRow) throws DataProviderException(Code)(Java Doc)
public TableCursorListener[] getTableCursorListeners()(Code)(Java Doc)
public TableDataListener[] getTableDataListeners()(Code)(Java Doc)
abstract public Class getType(FieldKey fieldKey) throws DataProviderException(Code)(Java Doc)
abstract public Object getValue(FieldKey fieldKey, RowKey row) throws DataProviderException(Code)(Java Doc)
public Object getValue(String fieldId, RowKey row) throws DataProviderException(Code)(Java Doc)
public Object getValue(FieldKey fieldKey) throws DataProviderException(Code)(Java Doc)
abstract public RowKey insertRow(RowKey beforeRow) throws DataProviderException(Code)(Java Doc)
abstract public boolean isReadOnly(FieldKey fieldKey) throws DataProviderException(Code)(Java Doc)
public boolean isRowAvailable(RowKey row) throws DataProviderException(Code)(Java Doc)
abstract public void removeRow(RowKey row) throws DataProviderException(Code)(Java Doc)
public void removeTableCursorListener(TableCursorListener listener)(Code)(Java Doc)
public void removeTableDataListener(TableDataListener l)(Code)(Java Doc)
protected boolean setCursorIndex(int index)(Code)(Java Doc)
public void setCursorRow(RowKey row) throws TableCursorVetoException(Code)(Java Doc)
abstract public void setValue(FieldKey fieldKey, RowKey row, Object value) throws DataProviderException(Code)(Java Doc)
public void setValue(String fieldId, RowKey row, Object value) throws DataProviderException(Code)(Java Doc)
public void setValue(FieldKey fieldKey, Object value) throws DataProviderException(Code)(Java Doc)
|
|
|