io.datafx.provider

Class ListDataProvider<T>

java.lang.Object

io.datafx.provider.ListDataProvider<T>

Type Parameters:

T - the type of data this ListDataProvider will deliver

All Implemented Interfaces:

WriteBackListProvider<T>, WriteBackProvider<T>, DataProvider<javafx.collections.ObservableList<T>>

public class ListDataProvider<T>
extends java.lang.Object
implements DataProvider<javafx.collections.ObservableList<T>>, WriteBackProvider<T>, WriteBackListProvider<T>

The ListDataProvider is an implementation of DataProvider that allows the retrieval and parsing of a list of data entities. In case a single entity is expected to be retrieved, an ObjectDataProvider should be used. Instances of this class are typically used to populate ObservableList instances.

This class requires a DataReader that either can be passed with the constructor or using the setDataReader(io.datafx.io.DataReader) method.
No external data will be retrieved until the retrieve() method is called.

Developers that prefer the builder approach can choose to use the ListDataProviderBuilder class to create an instance of ListDataProvider.

Example:

   JsonConverter jsonConverter = new JsonConverter("data", MyEntity.class);
   RestSourceBuilder restSourceBuilder = createRestSourceBuilder()
         .converter(jsonConverter)
         .path("part1").path("part2")
   RestSource restSource = restSourceBuilder.build();
   ListDataProvider<MyEntity> lodp = new ListDataProvider(restSource);
   lodp.setResultObservableList(model.allMyEntities());
 

Constructor Summary

Constructors

Constructor and Description
ListDataProvider()
ListDataProvider(DataReader<T> reader)
ListDataProvider(DataReader<T> reader, java.util.concurrent.Executor executor, javafx.collections.ObservableList<T> existingList) Create a ListDataProvider with a given Executor and an existing ListProperty

Method Summary

Modifier and Type	Method and Description
protected io.datafx.core.concurrent.PublishingTask<T>	createPublishingReceiverTask(javafx.collections.ObservableList myResult)
protected javafx.concurrent.Task<javafx.collections.ObservableList<T>>	createReceiverTask(javafx.collections.ObservableList myResult)
protected javafx.concurrent.Service<javafx.collections.ObservableList<T>>	createService(javafx.collections.ObservableList<T> value)
javafx.beans.property.ListProperty<T>	getData() returns the data obtained by this provider.
DataReader<T>	getDataReader()
java.util.concurrent.Executor	getExecutor()
javafx.concurrent.Worker<javafx.collections.ObservableList<T>>	retrieve() Starts to retrieve the data in a background thread and returns the Worker for monitoring.
void	setAddEntryHandler(WriteBackHandler<T> handler) Set the WriteBackHandler for this provider to the specified handler.
void	setDataReader(DataReader<T> reader)
void	setResultObservableList(javafx.collections.ObservableList<T> ol) This is a convenience method, allowing ObservableList instances (no ListProperties) to be synchronized with the result of the ListDataProvider.
void	setResultProperty(javafx.beans.property.Property<javafx.collections.ObservableList<T>> result) Provide an Property that wraps the to-be-retrieved data.
void	setWriteBackHandler(WriteBackHandler<T> handler) Set the WriteBackHandler for this provider to the specified handler.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListDataProvider

public ListDataProvider()

ListDataProvider

public ListDataProvider(DataReader<T> reader)

ListDataProvider

public ListDataProvider(DataReader<T> reader,
                        java.util.concurrent.Executor executor,
                        javafx.collections.ObservableList<T> existingList)

Create a ListDataProvider with a given Executor and an existing ListProperty

Parameters:

reader - the DataReader that will obtain the real data

executor - an Executor that will make the (asynchronous) call.

existingList - the ListProperty that will be populated with the retrieved data. Note that in the past, we had to use a ListProperty rather than an ObservableList since we override the getData() method, which should return ObservableValue<T>

Method Detail

setResultObservableList

public void setResultObservableList(javafx.collections.ObservableList<T> ol)

This is a convenience method, allowing ObservableList instances (no ListProperties) to be synchronized with the result of the ListDataProvider.

Parameters:

ol - The ObservableList instance that should be synchronized with the data retrieved by this ListDataProvider. Note that this ObservableList will be cleared when calling this method -- as there is no data retrieved yet.

setDataReader

public void setDataReader(DataReader<T> reader)

getDataReader

public DataReader<T> getDataReader()

retrieve

public javafx.concurrent.Worker<javafx.collections.ObservableList<T>> retrieve()

Description copied from interface: DataProvider

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

Specified by:

retrieve in interface DataProvider<javafx.collections.ObservableList<T>>

Returns:

Worker that retrieves the data

createService

protected javafx.concurrent.Service<javafx.collections.ObservableList<T>> createService(javafx.collections.ObservableList<T> value)

createPublishingReceiverTask

protected io.datafx.core.concurrent.PublishingTask<T> createPublishingReceiverTask(javafx.collections.ObservableList myResult)

createReceiverTask

protected final javafx.concurrent.Task<javafx.collections.ObservableList<T>> createReceiverTask(javafx.collections.ObservableList myResult)

getExecutor

public java.util.concurrent.Executor getExecutor()

getData

public javafx.beans.property.ListProperty<T> getData()

returns the data obtained by this provider. This method has to return an ObservableValue, so it wraps the resulting ObservableList into a ListProperty

Specified by:

getData in interface DataProvider<javafx.collections.ObservableList<T>>

Returns:

the ListProperty containing the data.

setAddEntryHandler

public void setAddEntryHandler(WriteBackHandler<T> handler)

Description copied from interface: WriteBackListProvider

Set the WriteBackHandler for this provider to the specified handler. When the provider decides to add data back to the original datasource (that is, when data has been added locally), the WriteBackHandler.createDataSource(java.lang.Object) method will be called. This method returns a WritableDataReader that will be used to send the data to the origin, by calling the WritableDataReader.writeBack() method.

Specified by:

setAddEntryHandler in interface WriteBackListProvider<T>

Parameters:

handler - the handler that will be used when the provider decides to write data back to the original source.

setWriteBackHandler

public void setWriteBackHandler(WriteBackHandler<T> handler)

Description copied from interface: WriteBackProvider

Set the WriteBackHandler for this provider to the specified handler. When the provider decides to write data back to the original datasource (that is, when data has been changed locally), the WriteBackHandler.createDataSource(java.lang.Object) method will be called. This method returns a WritableDataReader that will be used to send the data to the origin, by calling the WritableDataReader.writeBack() method.

Specified by:

setWriteBackHandler in interface WriteBackProvider<T>

Parameters:

handler - the handler that will be used when the provider decides to write data back to the original source.

setResultProperty

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

Description copied from interface: DataProvider

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

Specified by:

setResultProperty in interface DataProvider<javafx.collections.ObservableList<T>>

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.