CollectionContainer

setItems() - устанавливает коллекцию экземпляров сущности для контейнера.

getItems() - возвращает неизменяемый список сущностей, хранимых в контейнере. Используйте этот метод для обхода коллекции, получения потока (Java stream) или экземпляра сущности по его позиции в списке. Если требуется получить экземпляр сущности по его идентификатору, используйте метод getItem(entityId). Например:

@ViewComponent
private CollectionContainer<Department> departmentsDc;

private Optional<Department> findByName(String name) {
    return departmentsDc.getItems().stream()
            .filter(department -> Objects.equals(department.getName(), name))
            .findFirst();
}

getMutableItems() - возвращает изменяемый список сущностей, хранимых в контейнере. Все изменения списка, вызванные методами add(), addAll(), remove(), removeAll(), set(), clear(), публикуют событие CollectionChangeEvent. Визуальные компоненты, подписанные на это событие, будут обновлены автоматически. Например:

@ViewComponent
private CollectionContainer<Department> departmentsDc;

private void createDepartment() {
    Department department = metadata.create(Department.class);
    department.setName("Operations");
    departmentsDc.getMutableItems().add(department);
}

setItem() - устанавливает текущий экземпляр сущности для контейнера. Если передан не null, переданный экземпляр должен уже иметься в коллекции, чтобы быть выбранным. Метод публикует событие ItemChangeEvent.

@ViewComponent
private DataGrid<Department> departmentsTable;

@ViewComponent
private CollectionContainer<Department> departmentsDc;

private void selectFirstRow() {
    departmentsTable.getSelectionModel()
            .select(departmentsDc.getItems().get(0));
}

getItem() - переопределяет аналогичный метод родительского интерфейса InstanceContainer и возвращает текущий экземпляр. Если текущий экземпляр не задан, метод выбрасывает исключение. Используйте этот метод, если вы уверены, что для контейнера задан текущий экземпляр, в этом случае не требуется проверка возвращаемого значения на null.

getItemOrNull() - переопределяет аналогичный метод родительского интерфейса InstanceContainer и возвращает текущий экземпляр. Если текущий экземпляр не задан, метод возвращает null. Всегда проверяйте полученное значение на null перед использованием.

getItemIndex(entityId) - возвращает позицию сущности с данным идентификатором в списке, возвращаемом методами getItems() и getMutableItems(). Этот метод принимает Object, поэтому вы можете передать как id сущности, так и сам экземпляр сущности. Реализация контейнера поддерживает отображение идентификаторов на индексы, поэтому метод работает быстро даже с большими списками.

getItem(entityId) - возвращает экземпляр сущности из коллекции по её идентификатору. Это метод для удобства, который сначала получает позицию экземпляра с помощью getItemIndex(entityId), а затем возвращает экземпляр из списка, используя метод getItems().get(index). Метод выбрасывает исключение, если экземпляр с переданным id отсутствует в коллекции.

getItemOrNull(entityId) - то же, что и getItem(entityId), но возвращает null, если экземпляр с данным id отсутствует в коллекции. Всегда проверяйте полученное значение на null перед использованием.

containsItem(entityId) - возвращает true, если экземпляр с данным id есть в коллекции. Это метод для удобства, в котором на самом деле используется getItemIndex(entityId).

replaceItem(entity) - если экземпляр с тем же id есть в коллекции, он заменяется переданным экземпляром. Если таковой экземпляр отсутствует, переданный экземпляр будет добавлен к списку. Метод публикует событие CollectionChangeEvent с типом SET_ITEM или ADD_ITEMS, в зависимости от операции.

setSorter() - задает для контейнера переданный сортировщик. Стандартной реализацией интерфейса Sorter является CollectionContainerSorter. Фреймворк задает его автоматически, если для контейнера определен загрузчик, однако можно создать и собственную реализацию, если необходимо.

getSorter() - возвращает текущий сортировщик данного контейнера.