Class TreeDataProvider<T>

Constructor Detail

• TreeDataProvider

  public TreeDataProvider​(TreeData<T> treeData)

  Constructs a new TreeDataProvider.

  This data provider should be refreshed after making changes to the underlying TreeData instance.

  Parameters:

  treeData - the backing TreeData for this provider, not null

Method Detail

• getTreeData

  public TreeData<T> getTreeData()

  Return the underlying hierarchical data of this provider.

  Returns:

  the underlying data of this provider

• hasChildren

  public boolean hasChildren​(T item)

  Description copied from interface: HierarchicalDataProvider

  Check whether a given item has any children associated with it.

  Specified by:

  hasChildren in interface HierarchicalDataProvider<T,​SerializablePredicate<T>>

  Parameters:

  item - the item to check for children

  Returns:

  whether the given item has children

• getChildCount

  public int getChildCount​(HierarchicalQuery<T,​SerializablePredicate<T>> query)

  Description copied from interface: HierarchicalDataProvider

  Get the number of immediate child data items for the parent item returned by a given query.

  Specified by:

  getChildCount in interface HierarchicalDataProvider<T,​SerializablePredicate<T>>

  Parameters:

  query - given query to request the count for

  Returns:

  the count of child data items for the data item HierarchicalQuery.getParent()

• fetchChildren

  public Stream<T> fetchChildren​(HierarchicalQuery<T,​SerializablePredicate<T>> query)

  Description copied from interface: HierarchicalDataProvider

  Fetches data from this HierarchicalDataProvider using given query. Only the immediate children of HierarchicalQuery.getParent() will be returned.

  NOTE: If your data request is likely to involve I/O channels, see DataProvider.fetch(Query) for instructions on how to handle the stream without risking resource leaks.

  Specified by:

  fetchChildren in interface HierarchicalDataProvider<T,​SerializablePredicate<T>>

  Parameters:

  query - given query to request data with

  Returns:

  a stream of data objects resulting from the query

• getFilter

  public SerializablePredicate<T> getFilter()

  Description copied from interface: InMemoryDataProvider

  Gets the current filter of this data provider.

  Specified by:

  getFilter in interface InMemoryDataProvider<T>

  Returns:

  the filter of this data provider

• setFilter

  public void setFilter​(SerializablePredicate<T> filter)

  Description copied from interface: InMemoryDataProvider

  Sets a filter to be applied to all queries. The filter replaces any filter that has been set or added previously.

  Specified by:

  setFilter in interface ConfigurableFilterDataProvider<T,​SerializablePredicate<T>,​SerializablePredicate<T>>

  Specified by:

  setFilter in interface InMemoryDataProvider<T>

  Parameters:

  filter - the filter to set, or null to remove any set filters

  See Also:

  InMemoryDataProvider.setFilter(ValueProvider, SerializablePredicate), InMemoryDataProvider.setFilterByValue(ValueProvider, Object), InMemoryDataProvider.addFilter(SerializablePredicate)

• getSortComparator

  public SerializableComparator<T> getSortComparator()

  Description copied from interface: InMemoryDataProvider

  Gets the current sort comparator of this data provider.

  Specified by:

  getSortComparator in interface InMemoryDataProvider<T>

  Returns:

  the sort comparator of this data provider

• setSortComparator

  public void setSortComparator​(SerializableComparator<T> comparator)

  Description copied from interface: InMemoryDataProvider

  Sets the comparator to use as the default sorting for this data provider. This overrides the sorting set by any other method that manipulates the default sorting of this data provider.

  The default sorting is used if the query defines no sorting. The default sorting is also used to determine the ordering of items that are considered equal by the sorting defined in the query.

  Specified by:

  setSortComparator in interface InMemoryDataProvider<T>

  Parameters:

  comparator - a comparator to use, or null to clear any previously set sort order

  See Also:

  InMemoryDataProvider.setSortOrder(ValueProvider, SortDirection), InMemoryDataProvider.addSortComparator(SerializableComparator)

• withConvertedFilter

  public <C> DataProvider<T,​C> withConvertedFilter​(SerializableFunction<C,​SerializablePredicate<T>> filterConverter)

  Description copied from interface: DataProvider

  Wraps this data provider to create a data provider that uses a different filter type. This can be used for adapting this data provider to a filter type provided by a Component such as ComboBox.

  For example receiving a String from ComboBox and making a Predicate based on it:

   DataProvider<Person, Predicate<Person>> dataProvider;
   // ComboBox uses String as the filter type
   DataProvider<Person, String> wrappedProvider = dataProvider
           .withConvertedFilter(filterText -> {
               SerializablePredicate<Person> predicate = person -> person
                       .getName().startsWith(filterText);
               return predicate;
           });
   comboBox.setDataProvider(wrappedProvider);
   

  Specified by:

  withConvertedFilter in interface DataProvider<T,​SerializablePredicate<T>>

  Type Parameters:

  C - the filter type that the wrapped data provider accepts; typically provided by a Component

  Parameters:

  filterConverter - callback that converts the filter in the query of the wrapped data provider into a filter supported by this data provider. Will only be called if the query contains a filter. Not null

  Returns:

  wrapped data provider, not null