Класс IIOMetadata

java.lang.Object
- javax.imageio.metadata.IIOMetadata

public abstract class IIOMetadata
extends Object

Абстрактный класс, который должен быть расширен объектами, представляющими метаданные (данные, не являющиеся изображением), связанные с изображениями и потоками. Плагины представляют метаданные с помощью непрозрачных, специфичных для плагина объектов. Однако эти объекты предоставляют возможность доступа к своей внутренней информации как к дереву IIOMetadataNode объектов, поддерживающих интерфейсы XML DOM, а также дополнительные интерфейсы для хранения нетекстовых данных и извлечения информации о допустимых значениях данных. Формат таких деревьев зависит от плагина, но плагины могут выбрать поддержку нейтрального для плагина формата, описанного ниже. Один плагин может поддерживать несколько форматов метаданных, имена которых могут быть определены, вызвав getMetadataFormatNames. Плагин также может поддерживать один специальный формат, называемый «родным» форматом, который предназначен для кодирования метаданных без потерь. Этот формат, как правило, будет разработан специально для работы с определённым форматом файла, так что изображения могут загружаться и сохраняться в том же формате без потери метаданных, но может быть менее полезным для передачи метаданных между ImageReader и ImageWriter для различных форматов изображений. Для преобразования между двумя родными форматами без потерь, насколько это позволяют форматы файлов изображений, необходимо использовать объект ImageTranscoder.

См. также:: ImageReader.getImageMetadata(int), ImageReader.getStreamMetadata(), ImageReader.readAll(int, javax.imageio.ImageReadParam), ImageWriter.getDefaultStreamMetadata(javax.imageio.ImageWriteParam), ImageWriter.getDefaultImageMetadata(javax.imageio.ImageTypeSpecifier, javax.imageio.ImageWriteParam), ImageWriter.write(javax.imageio.metadata.IIOMetadata, javax.imageio.IIOImage, javax.imageio.ImageWriteParam), ImageWriter.convertImageMetadata(javax.imageio.metadata.IIOMetadata, javax.imageio.ImageTypeSpecifier, javax.imageio.ImageWriteParam), ImageWriter.convertStreamMetadata(javax.imageio.metadata.IIOMetadata, javax.imageio.ImageWriteParam), IIOImage, ImageTranscoder

Поля

Модификатор и тип	Поле и описание
`protected IIOMetadataController`	`controller` Контроллер, который будет использоваться для предоставления настроек для этого объекта `IIOMetadata` при вызове метода `activateController`.
`protected IIOMetadataController`	`defaultController` Рекомендуемый контроллер для объекта `IIOMetadata`.
`protected String[]`	`extraMetadataFormatClassNames` Массив имён классов, реализующих интерфейс `IIOMetadataFormat`, и представляющих форматы метаданных, отличные от стандартного и родного, поддерживаемые этим плагином, инициализированный `null` и устанавливаемый через конструктор.
`protected String[]`	`extraMetadataFormatNames` Массив имён форматов, отличных от стандартного и родного, поддерживаемых этим плагином, инициализированный `null` и устанавливаемый через конструктор.
`protected String`	`nativeMetadataFormatClassName` Имя класса, реализующего интерфейс `IIOMetadataFormat` и представляющего родной формат метаданных, инициализированный `null` и устанавливаемый через конструктор.
`protected String`	`nativeMetadataFormatName` Имя родного формата метаданных для этого объекта, инициализированный `null` и устанавливаемый через конструктор.
`protected boolean`	`standardFormatSupported` Логическое значение, указывающее, поддерживает ли конкретный подкласс стандартный формат метаданных, устанавливаемый через конструктор.

Конструкторы

Модификатор Конструктор и описание

Модификатор	Конструктор и описание
`protected`	`IIOMetadata()` Создаёт пустой объект `IIOMetadata`.
`protected`	`IIOMetadata(boolean standardMetadataFormatSupported, String nativeMetadataFormatName, String nativeMetadataFormatClassName, String[] extraMetadataFormatNames, String[] extraMetadataFormatClassNames)` Создаёт объект `IIOMetadata` с заданными именами форматов и именами классов форматов, а также логическим значением, указывающим, поддерживается ли стандартный формат.

protected

IIOMetadata()

Создаёт пустой объект IIOMetadata.

protected

IIOMetadata(boolean standardMetadataFormatSupported,
           String nativeMetadataFormatName,
           String nativeMetadataFormatClassName,
           String[] extraMetadataFormatNames,
           String[] extraMetadataFormatClassNames)

Создаёт объект IIOMetadata с заданными именами форматов и именами классов форматов, а также логическим значением, указывающим, поддерживается ли стандартный формат.

Методы

Модификатор и тип	Метод и описание
`boolean`	`activateController()` Активирует установленный `IIOMetadataController` для объекта `IIOMetadata` и возвращает полученное значение.
`abstract Node`	`getAsTree(String formatName)` Возвращает объект XML DOM `Node`, представляющий корень дерева метаданных, содержащихся в этом объекте в соответствии с соглашениями, определёнными заданным форматом метаданных.
`IIOMetadataController`	`getController()` Возвращает установленный `IIOMetadataController`.
`IIOMetadataController`	`getDefaultController()` Возвращает стандартный `IIOMetadataController`, если он есть, независимо от текущего установленного контроллера.
`String[]`	`getExtraMetadataFormatNames()` Возвращает массив `String` с именами дополнительных форматов метаданных, отличных от родного и стандартного, распознаваемых методом `getAsTree`, `setFromTree`, и `mergeTree` плагина.
`IIOMetadataFormat`	`getMetadataFormat(String formatName)` Возвращает объект `IIOMetadataFormat`, описывающий заданный формат метаданных, или `null`, если описание недоступно.
`String[]`	`getMetadataFormatNames()` Возвращает массив `String` с именами всех форматов метаданных, включая родной и стандартный, распознаваемых методом `getAsTree`, `setFromTree`, и `mergeTree` плагина.
`String`	`getNativeMetadataFormatName()` Возвращает имя «родного» формата метаданных для данного плагина, что, как правило, позволяет беспривязный кодировать и передавать метаданные, хранящиеся в формате, обрабатываемом этим плагином.
`protected IIOMetadataNode`	`getStandardChromaNode()` Возвращает `IIOMetadataNode`, представляющий информацию о хроматичности стандартного `javax_imageio_1.0` формата метаданных, или `null`, если такая информация недоступна.
`protected IIOMetadataNode`	`getStandardCompressionNode()` Возвращает `IIOMetadataNode`, представляющий информацию о сжатии стандартного `javax_imageio_1.0` формата метаданных, или `null`, если такая информация недоступна.
`protected IIOMetadataNode`	`getStandardDataNode()` Возвращает `IIOMetadataNode`, представляющий информацию о формате данных стандартного `javax_imageio_1.0` формата метаданных, или `null`, если такая информация недоступна.
`protected IIOMetadataNode`	`getStandardDimensionNode()` Возвращает `IIOMetadataNode`, представляющий информацию о размерах стандартного `javax_imageio_1.0` формата метаданных, или `null`, если такая информация недоступна.
`protected IIOMetadataNode`	`getStandardDocumentNode()` Возвращает `IIOMetadataNode`, представляющий информацию о документе стандартного `javax_imageio_1.0` формата метаданных, или `null`, если такая информация недоступна.
`protected IIOMetadataNode`	`getStandardTextNode()` Возвращает `IIOMetadataNode`, представляющий текстовую информацию стандартного `javax_imageio_1.0` формата метаданных, или `null`, если такая информация недоступна.
`protected IIOMetadataNode`	`getStandardTileNode()` Возвращает `IIOMetadataNode`, представляющий информацию о плитках стандартного `javax_imageio_1.0` формата метаданных, или `null`, если такая информация недоступна.
`protected IIOMetadataNode`	`getStandardTransparencyNode()` Возвращает `IIOMetadataNode`, представляющий информацию о прозрачности стандартного `javax_imageio_1.0` формата метаданных, или `null`, если такая информация недоступна.
`protected IIOMetadataNode`	`getStandardTree()` Утилитарный метод для возвращения дерева `IIOMetadataNode` объектов, представляющих метаданные, содержащиеся в этом объекте в соответствии с соглашениями стандартного `javax_imageio_1.0` формата метаданных.
`boolean`	`hasController()` Возвращает `true`, если для объекта `IIOMetadata` установлен контроллер.
`abstract boolean`	`isReadOnly()` Возвращает `true`, если этот объект не поддерживает методы `mergeTree`, `setFromTree`, и `reset`.
`boolean`	`isStandardMetadataFormatSupported()` Возвращает `true`, если стандартный формат метаданных поддерживается объектами `getMetadataFormat`, `getAsTree`, `setFromTree`, и `mergeTree`.
`abstract void`	`mergeTree(String formatName, Node root)` Изменяет внутреннее состояние этого объекта `IIOMetadata` из дерева XML DOM `Node` объектов, синтаксис которых определён заданным форматом метаданных.
`abstract void`	`reset()` Сбрасывает все данные, хранящиеся в этом объекте, на значения по умолчанию, обычно до состояния объекта непосредственно после создания, хотя точные семантики зависят от плагина.
`void`	`setController(IIOMetadataController controller)` Устанавливает контроллер, который будет использоваться для предоставления настроек для объекта `IIOMetadata` при вызове метода `activateController`, перезаписывая любой контроллер по умолчанию.
`void`	`setFromTree(String formatName, Node root)` Устанавливает внутреннее состояние этого объекта `IIOMetadata` из дерева XML DOM `Node` объектов, синтаксис которых определён заданным форматом метаданных.

Методы, унаследованные от класса java.lang.Object

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

Поля

standardFormatSupported

protected boolean standardFormatSupported

Логическое значение, указывающее, поддерживает ли конкретный подкласс стандартный формат метаданных, устанавливается через конструктор.

nativeMetadataFormatName

protected String nativeMetadataFormatName

Имя нативного формата метаданных для этого объекта, инициализируется значением null и устанавливается через конструктор.

nativeMetadataFormatClassName

protected String nativeMetadataFormatClassName

Имя класса, реализующего IIOMetadataFormat и представляющего нативный формат метаданных, инициализируется значением null и устанавливается через конструктор.

extraMetadataFormatNames

protected String[] extraMetadataFormatNames

Массив имён форматов, отличных от стандартного и нативного, которые поддерживаются этим плагином, инициализируется значением null и устанавливается через конструктор.

extraMetadataFormatClassNames

protected String[] extraMetadataFormatClassNames

Массив имён классов, реализующих IIOMetadataFormat и представляющих форматы метаданных, отличные от стандартного и нативного, которые поддерживаются этим плагином, инициализируется значением null и устанавливается через конструктор.

defaultController

protected IIOMetadataController defaultController

Предлагаемый IIOMetadataController для использования в качестве контроллера для этого объекта IIOMetadata. Он может быть получен через getDefaultController. Для установки контроллера по умолчанию вызовите setController(getDefaultController()). Эта переменная-член должна быть установлена подклассами, которые выбирают предоставление собственного контроллера по умолчанию, обычно графического интерфейса, для настройки параметров.

См. также:: IIOMetadataController, getDefaultController()

controller

protected IIOMetadataController controller

IIOMetadataController который будет использоваться для предоставления настроек для этого объекта IIOMetadata при вызове метода activateController. Это значение переопределяет любой контроллер по умолчанию, даже если null.

См. также:: IIOMetadataController, setController(IIOMetadataController), hasController(), activateController()

Конструкторы

IIOMetadata

protected IIOMetadata()

Создаёт пустой объект IIOMetadata. Подкласс отвечает за обеспечение значений всех защищённых переменных-членов, что позволит любым не переопределённым реализациям методов удовлетворить свои контракты. Например, extraMetadataFormatNames не должно иметь длину 0.

IIOMetadata

protected IIOMetadata(boolean standardMetadataFormatSupported,
                      String nativeMetadataFormatName,
                      String nativeMetadataFormatClassName,
                      String[] extraMetadataFormatNames,
                      String[] extraMetadataFormatClassNames)

Этот конструктор не пытается проверить имена классов на корректность. Неверные имена классов могут вызвать исключения при последующих вызовах getMetadataFormat.

Параметры:: standardMetadataFormatSupported - true может ли этот объект возвращать или принимать дерево DOM, используя стандартный формат метаданных.; nativeMetadataFormatName - имя нативного формата метаданных в виде String, или null, если нативный формат отсутствует.; nativeMetadataFormatClassName - имя класса нативного формата метаданных, или null, если нативный формат отсутствует.; extraMetadataFormatNames - массив Strings, указывающих на дополнительные форматы, поддерживаемые этим объектом, или null, если дополнительных форматов нет.; extraMetadataFormatClassNames - массив Strings, указывающих на имена классов любых дополнительных форматов, поддерживаемых этим объектом, или null, если дополнительных форматов нет.
Исключения:: IllegalArgumentException - если extraMetadataFormatNames имеет длину 0.; IllegalArgumentException - если extraMetadataFormatNames и extraMetadataFormatClassNames не оба null, или не имеют одинаковую длину.

Методы

isStandardMetadataFormatSupported

public boolean isStandardMetadataFormatSupported()

Возвращает true, если стандартный формат метаданных поддерживается getMetadataFormat, getAsTree, setFromTree, и mergeTree.

Реализация по умолчанию возвращает значение переменной-члена standardFormatSupported.

Возвращает:: true если стандартный формат метаданных поддерживается.
См. также:: getAsTree(java.lang.String), setFromTree(java.lang.String, org.w3c.dom.Node), mergeTree(java.lang.String, org.w3c.dom.Node), getMetadataFormat(java.lang.String)

isReadOnly

public abstract boolean isReadOnly()

Возвращает true если этот объект не поддерживает методы mergeTree, setFromTree, и reset.

Возвращает:: true, если этот объект IIOMetadata не может быть изменён.

getNativeMetadataFormatName

public String getNativeMetadataFormatName()

Возвращает имя "нативного" формата метаданных для этого плагина, который, как правило, позволяет осуществлять беспотерьную кодировку и передачу метаданных, хранящихся в формате, обрабатываемом этим плагином. Если такой формат не поддерживается, возвращается null.

Структура и содержимое "нативного" формата метаданных определяются плагином, который создал этот объект IIOMetadata. Плагины для простых форматов обычно создают фиктивный узел для корня, а затем серию дочерних узлов, представляющих отдельные теги, фрагменты или пары ключевое слово/значение. Плагин может выбрать, документировать свой нативный формат или нет.

Реализация по умолчанию возвращает значение переменной-члена nativeMetadataFormatName.

Возвращает:: имя нативного формата или null.
См. также:: getExtraMetadataFormatNames(), getMetadataFormatNames()

getExtraMetadataFormatNames

public String[] getExtraMetadataFormatNames()

Возвращает массив Strings содержащий имена дополнительных форматов метаданных, отличных от нативного и стандартного, распознаваемых методом getAsTree, setFromTree, и mergeTree плагина. Если таких дополнительных форматов нет, возвращается null.

Реализация по умолчанию возвращает копию переменной-члена extraMetadataFormatNames.

Возвращает:: массив Strings длиной не менее 1 или null.
См. также:: getAsTree(java.lang.String), setFromTree(java.lang.String, org.w3c.dom.Node), mergeTree(java.lang.String, org.w3c.dom.Node), getNativeMetadataFormatName(), getMetadataFormatNames()

getMetadataFormatNames

public String[] getMetadataFormatNames()

Возвращает массив Strings содержащий имена всех форматов метаданных, включая нативный и стандартный, распознаваемых методом getAsTree, setFromTree, и mergeTree плагина. Если таких форматов нет, возвращается null.

Реализация по умолчанию вызывает getNativeMetadataFormatName, isStandardMetadataFormatSupported, и getExtraMetadataFormatNames и возвращает объединённый результат.

Возвращает:: массив Strings.
См. также:: getNativeMetadataFormatName(), isStandardMetadataFormatSupported(), getExtraMetadataFormatNames()

getMetadataFormat

public IIOMetadataFormat getMetadataFormat(String formatName)

Возвращает объект IIOMetadataFormat описывающий заданный формат метаданных, или null если описание недоступно. Переданное имя должно быть одним из тех, что возвращаются getMetadataFormatNames (т.е., имя нативного формата, имя стандартного формата или одно из возвращаемых getExtraMetadataFormatNames).

Реализация по умолчанию проверяет имя на соответствие глобальному имени стандартного формата метаданных и возвращает этот формат, если он поддерживается. В противном случае проверяет имя на соответствие именам нативного формата, а затем любым дополнительным именам форматов. Если совпадение найдено, извлекает имя класса IIOMetadataFormat из nativeMetadataFormatClassName или extraMetadataFormatClassNames, как соответствующим образом и создаёт экземпляр этого класса с помощью метода getInstance.

Параметры:: formatName - желаемый формат метаданных.
Возвращает:: объект IIOMetadataFormat.
Исключения:: IllegalArgumentException - если formatName является null или не является одним из имён, распознаваемых плагином.; IllegalStateException - если класс, соответствующий имени формата, не может быть загружен.

getAsTree

public abstract Node getAsTree(String formatName)

Возвращает объект XML DOM Node, представляющий корень дерева метаданных, содержащихся в этом объекте, согласно соглашениям, определённым заданным форматом метаданных.

Имена доступных форматов метаданных можно запросить с помощью метода getMetadataFormatNames.

Параметры:: formatName - желаемый формат метаданных.
Возвращает:: объект XML DOM Node образующий корень дерева.
Исключения:: IllegalArgumentException - если formatName является null или не является одним из имён, возвращаемых getMetadataFormatNames.
См. также:: getMetadataFormatNames(), setFromTree(java.lang.String, org.w3c.dom.Node), mergeTree(java.lang.String, org.w3c.dom.Node)

mergeTree

public abstract void mergeTree(String formatName,
                               Node root)
                        throws IIOInvalidTreeException

Изменяет внутреннее состояние этого объекта IIOMetadata из дерева XML DOM Nodes, синтаксис которого определяется заданным форматом метаданных. Предыдущее состояние изменяется только по необходимости, чтобы вместить узлы, присутствующие в заданном дереве. Если структура или содержимое дерева неверны, будет выброшено исключение IIOInvalidTreeException.

Поскольку семантика того, как дерево или поддерево могут быть объединены с другим деревом, полностью специфична для формата, авторы плагинов могут реализовать этот метод любым способом, наиболее подходящим для формата, включая простое замещение всего существующего состояния содержимым заданного дерева.

Параметры:: formatName - требуемый формат метаданных.; root - объект XML DOM Node , образующий корень дерева.
Выбрасывает:: IllegalStateException - если этот объект только для чтения.; IllegalArgumentException - если formatName имеет значение null или не является одним из имён, возвращаемых getMetadataFormatNames.; IllegalArgumentException - если root имеет значение null.; IIOInvalidTreeException - если дерево не может быть успешно проанализировано с использованием правил заданного формата.
См. также:: getMetadataFormatNames(), getAsTree(java.lang.String), setFromTree(java.lang.String, org.w3c.dom.Node)

getStandardChromaNode

protected IIOMetadataNode getStandardChromaNode()

Возвращает объект IIOMetadataNode, представляющий информацию о цветовом формате стандартного формата метаданных javax_imageio_1.0, или null, если такая информация недоступна. Этот метод предназначен для вызова вспомогательной функцией getStandardTree.