Интерфейс IIOMetadataController

public interface IIOMetadataController

Интерфейс, который должны реализовывать объекты, способные определить настройки объекта IIOMetadata, либо создавая графический интерфейс для получения значений от пользователя, либо другими средствами. Этот интерфейс просто определяет универсальный activate метод, который вызывает контроллер, не заботясь о том, как контроллер получает значения (т. е., неважно, создает ли контроллер графический интерфейс или просто вычисляет набор значений, для этого интерфейса это несущественно).

Внутри метода activate, контроллер получает начальные значения, запросив настройки объекта IIOMetadata, используя дерево DOM XML или интерфейс, специфичный для плагина, изменяет значения любым способом, затем изменяет настройки объекта IIOMetadata, используя методы setFromTree или mergeTree, или интерфейс, специфичный для плагина. В общем случае приложения могут ожидать, что когда метод activate вернет true, объект IIOMetadata будет готов к использованию в операции записи.

Поставщики могут выбрать предоставление графических интерфейсов для подклассов IIOMetadata, которые они определяют для конкретного плагина. Эти интерфейсы могут быть установлены в качестве контроллеров по умолчанию в соответствующих подклассах IIOMetadata.

В качестве альтернативы, в качестве контроллера может использоваться алгоритмический процесс, такой как поиск в базе данных или обработка командной строки, в этом случае метод activate просто выполнит поиск или вычисление настроек, вызовет методы объекта IIOMetadata для установки его состояния и вернет true.

Методы

activate

boolean activate(IIOMetadata metadata)

Активирует контроллер. Если true возвращается, все настройки в объекте IIOMetadata должны быть готовы к использованию в операции записи. Если false возвращается, никакие настройки в объекте IIOMetadata не будут изменены (т. е., пользователь отменил операцию).

Параметры:

metadata - объект IIOMetadata для изменения.

Возвращает:

true если объект IIOMetadata был изменён, false в противном случае.

Исключения:

IllegalArgumentException - если metadata равен null или не является экземпляром правильного класса.