Package com.vaadin.flow.data.provider.hierarchy

Class HierarchicalCommunicationController<T>

java.lang.Object

com.vaadin.flow.data.provider.hierarchy.HierarchicalCommunicationController<T>

Type Parameters:

T - the target bean type

All Implemented Interfaces:

Serializable

public class HierarchicalCommunicationController<T>
extends Object
implements Serializable

HierarchicalCommunicationController controls all the communication to client.

Since:

1.2

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
HierarchicalCommunicationController(String parentKey, DataKeyMapper<T> keyMapper, HierarchyMapper<T,?> mapper, DataGenerator<T> dataGenerator, SerializableFunction<Integer,HierarchicalArrayUpdater.HierarchicalUpdate> startUpdate, SerializableBiFunction<String,Range,Stream<T>> fetchItems)	Constructs communication controller with support for hierarchical data structure.

Method Summary

Modifier and Type	Method	Description
void	confirmUpdate(int updateId)
void	flush()
elemental.json.JsonValue	generateJson(T item)
void	setRequestRange(int start, int length)
void	setResendEntireRange(boolean resend)
void	unregisterPassivatedKeys()

Methods inherited from class java.lang.Object

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

Constructor Detail

HierarchicalCommunicationController

public HierarchicalCommunicationController(String parentKey,
                                           DataKeyMapper<T> keyMapper,
                                           HierarchyMapper<T,?> mapper,
                                           DataGenerator<T> dataGenerator,
                                           SerializableFunction<Integer,HierarchicalArrayUpdater.HierarchicalUpdate> startUpdate,
                                           SerializableBiFunction<String,Range,Stream<T>> fetchItems)

Constructs communication controller with support for hierarchical data structure.

Parameters:

parentKey - parent key or null if root

keyMapper - Object to String key mapper

mapper - Mapper for hierarchical data

dataGenerator - A data generator for items

startUpdate - Function for creating a new ArrayUpdater.Update for client

fetchItems - Function for fetching items for target parent and specified range

Method Detail

flush

public void flush()

confirmUpdate

public void confirmUpdate(int updateId)

setRequestRange

public void setRequestRange(int start,
                            int length)

setResendEntireRange

public void setResendEntireRange(boolean resend)

unregisterPassivatedKeys

public void unregisterPassivatedKeys()

generateJson

public elemental.json.JsonValue generateJson(T item)