org.jdesktop.swing.data
Interface DataModel

All Known Implementing Classes:

AbstractDataModel

public interface DataModel

Abstract model interface for representing a record of named data fields. The map provides a uniform API for accessing data which may be contained in a variety of data model constructs underneath, such as RowSet, TabularDataModel, or arbitrary JavaBean classes. The user-interface Binding classes use this interface to "bind" user-interface components to field elements in a data model without having to understand the specific flavor of data model being used by the application. For example, a field element may map to a named column on a RowSet or a property on a JavaBean, but the binding classes don't need to understand those underlying data structures in order to read and write values.

For each named field, the data model provides access to:

• meta-data: information describing the data field, such as type and edit constraints
• value: the current value of the field

Often data models are collections of like-objects, such as the rows in a RowSet, or a list of JavaBeans. This interface provides a mechanism to index into such a collection such that at any given time, the data model contains the element values associated with the "current" record index into that collection (the current row, or the current bean, etc).

Method Summary

void	addValidator(Validator validator) Adds the specified validator for the fields represented by this data model.
void	addValueChangeListener(ValueChangeListener valueChangeListener) Adds the specified value change listener to be notified when the value is changed outside of calling setValue directly.
int	getFieldCount()
String[]	getFieldNames()
MetaData	getMetaData(String fieldName)
int	getRecordCount()
int	getRecordIndex()
Validator[]	getValidators()
Object	getValue(String fieldName)
ValueChangeListener[]	getValueChangeListeners()
void	removeValidator(Validator validator) Removes the specified validator from this data model.
void	removeValueChangeListener(ValueChangeListener valueChangeListener) Removes the specified value change listener from this value adapter.
void	setRecordIndex(int index) Sets the current record index such that the field values in this data model represent the values contained at the specified index in the underlying data model.
void	setValue(String fieldName, Object value)

Method Detail

getFieldNames

public String[] getFieldNames()

Returns:

array containing the names of all data fields in this map

getMetaData

public MetaData getMetaData(String fieldName)

Parameters:

fieldName - String containing the name of the field

Returns:

MetaData object which describes the named field

getValue

public Object getValue(String fieldName)

Parameters:

fieldName - String containing the name of the field

Returns:

Object containing the current value of the named field

setValue

public void setValue(String fieldName,
                     Object value)

Parameters:

fieldName - String containing the name of the field

value - Object containing the current value of the named field

getFieldCount

public int getFieldCount()

Returns:

integer containing the number of fields in this data model

getRecordCount

public int getRecordCount()

Returns:

integer containing the number of records accessible from this data model

setRecordIndex

public void setRecordIndex(int index)

Sets the current record index such that the field values in this data model represent the values contained at the specified index in the underlying data model.

Parameters:

index - integer representing the current index into the underlying data model's records

getRecordIndex

public int getRecordIndex()

Returns:

integer representing the current index into the underlying data model's records

addValidator

public void addValidator(Validator validator)

Adds the specified validator for the fields represented by this data model. A validator object may be used to perform validation checks which require analyzing more than one field value in a single check. This DataModel instance will be passed in as the value parameter to the validator's validate method.

Parameters:

validator - Validator object which performs validation checks on this set of data field values

See Also:

removeValidator(org.jdesktop.swing.data.Validator), getValidators()

removeValidator

public void removeValidator(Validator validator)

Removes the specified validator from this data model.

Parameters:

validator - Validator object which performs validation checks on this set of data field values

See Also:

addValidator(org.jdesktop.swing.data.Validator)

getValidators

public Validator[] getValidators()

Returns:

array containing the validators registered for data model

addValueChangeListener

public void addValueChangeListener(ValueChangeListener valueChangeListener)

Adds the specified value change listener to be notified when the value is changed outside of calling setValue directly.

Parameters:

valueChangeListener - ValueChangeListener object to receive events when the field value changes

removeValueChangeListener

public void removeValueChangeListener(ValueChangeListener valueChangeListener)

Removes the specified value change listener from this value adapter.

Parameters:

valueChangeListener - ValueChangeListener object to receive events when the field value changes

getValueChangeListeners

public ValueChangeListener[] getValueChangeListeners()

Returns:

array containing the ValueChangeListener objects registered on this data model