com.vaadin.data.provider.HierarchicalQuery Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.data.provider;
import java.util.Comparator;
import java.util.List;
import java.util.Optional;
/**
* Immutable hierarchical query object used to request data from a backend.
* Contains the parent node, index limits, sorting and filtering information.
*
* @param
* bean type
* @param
* filter type
*
* @since 8.1
*/
public class HierarchicalQuery extends Query {
private final T parent;
/**
* Constructs a new hierarchical query object with given filter and parent
* node.
*
* @param filter
* filtering for fetching; can be null
* @param parent
* the hierarchical parent object, null
* corresponding to the root node
*/
public HierarchicalQuery(F filter, T parent) {
super(filter);
this.parent = parent;
}
/**
* Constructs a new hierarchical query object with given offset, limit,
* sorting and filtering.
*
* @param offset
* first index to fetch
* @param limit
* fetched item count
* @param sortOrders
* sorting order for fetching; used for sorting backends
* @param inMemorySorting
* comparator for sorting in-memory data
* @param filter
* filtering for fetching; can be null
* @param parent
* the hierarchical parent object, null
* corresponding to the root node
*/
public HierarchicalQuery(int offset, int limit,
List sortOrders, Comparator inMemorySorting,
F filter, T parent) {
super(offset, limit, sortOrders, inMemorySorting, filter);
this.parent = parent;
}
/**
* Get the hierarchical parent object, where null corresponds
* to the root node.
*
* @return the hierarchical parent object
*/
public T getParent() {
return parent;
}
/**
* Get an Optional of the hierarchical parent object.
*
* @see #getParent()
* @return the result of {@link #getParent()} wrapped by an Optional
*/
public Optional getParentOptional() {
return Optional.ofNullable(parent);
}
}