io.datafx.provider

Interface DataProvider<T>

Type Parameters:

T - the (Java) type of data that will be provided by this DataProvider

All Known Implementing Classes:

ListDataProvider, ObjectDataProvider

public interface DataProvider<T>

The DataProvider interface defines how applications interact with the data that is retrieved via a DataReader.

Retrieved data is stored in a Property. There are three different ways for obtaining the retrieved data:

1. Call getData() on the DataProvider. This will return an ObservableValue containing the data.
2. Provide a property to the DataProvider, by calling setResultProperty(javafx.beans.property.Property). The passed argument is a Property, that will be set when data is retrieved.
3. Obtain the Worker that is retrieving the data, and observe the Worker.valueProperty()

Method Summary

Modifier and Type	Method and Description
javafx.beans.value.ObservableValue<T>	getData() A ObservableValue that wraps the provided Data.
javafx.concurrent.Worker<T>	retrieve() Starts to retrieve the data in a background thread and returns the Worker for monitoring.
void	setResultProperty(javafx.beans.property.Property<T> result) Provide an Property that wraps the to-be-retrieved data.

Method Detail

getData

javafx.beans.value.ObservableValue<T> getData()

A ObservableValue that wraps the provided Data. When calling this method, the data might or might not be available. In case data is not yet available, adding an InvalidationListener or a ChangeListener to the result of this method will make sure that you will be notified once data is available.

Returns:

An ObservableValue that contains or will contain the data obtained by this DataProvider.

setResultProperty

void setResultProperty(javafx.beans.property.Property<T> result)

Provide an Property that wraps the to-be-retrieved data.

Parameters:

result - a javafx.beans.property that already exists in the application, and that will be used by this DataProvider to store the retrieved data.

retrieve

javafx.concurrent.Worker<T> retrieve()

Starts to retrieve the data in a background thread and returns the Worker for monitoring. The Worker has the generic type T. The incoming data can be observed using the Worker.valueProperty() property

Returns:

Worker that retrieves the data