Java javax.imageio.metadata 接口 IIOMetadataFormat（JDK5）

142 阅读 0 评论 0 点赞

所有类

概述

软件包

类

使用

树

已过时

索引

帮助

摘要：嵌套 | 字段 | 构造方法 | 方法

详细信息：字段 | 构造方法 | 方法

javax.imageio.metadata
接口 IIOMetadataFormat

所有已知实现类：: IIOMetadataFormatImpl

public interface IIOMetadataFormat

描述从 IIOMetadata.getAsTree 返回并传递给 IIOMetadata.setFromTree 和 mergeTree 的元数据文档结构的对象。文档结构通过以下事物描述：一个关于可能属于某个给定父元素类型的子元素类型和数目的限制条件集合、可能属于某个元素的属性的名称、类型和值、以及可能存储在节点中的 Object 引用的类型和值。

N.B：实现此接口的类应该包含声明为 public static getInstance() 的方法，该方法返回该类的实例。通常，实现将仅构造单个实例并将其缓存以备将来调用 getInstance 时使用。

可由此类描述的结构是一个可以使用 XML 文档类型定义 (DTD) 表示的子集，再加上一些关于属性的数据类型的基本信息和在节点中存储 Object 引用的能力。将来，使用 XML 模式即可表示这些结构及其他结构。

IIOMetadataFormat 描述的结构与 DTD 之间的区别如下所示：

元素不包含嵌入了标记的文本和混合文本。
元素的子元素必须符合几个简单模式之一，这些简单模式在 CHILD_* 常量的文档中描述。
元素的内存表示形式可能包含对 Object 的引用。没有提供对这些对象的文本表示。

字段摘要
`static int`	`CHILD_POLICY_ALL` `getChildPolicy` 返回的常量，指示某个元素必须具有按顺序排列的其每个合法子元素的单个实例。
`static int`	`CHILD_POLICY_CHOICE` `getChildPolicy` 返回的常量，指示元素必须具有从其合法子元素中选择的零个或一个子元素。
`static int`	`CHILD_POLICY_EMPTY` `getChildPolicy` 返回的常量，指示某个元素不具有任何子元素。
`static int`	`CHILD_POLICY_MAX` 最大有效 `CHILD_POLICY_*` 常量，将用于范围检查。
`static int`	`CHILD_POLICY_REPEAT` `getChildPolicy` 返回的常量，指示元素必须具有其惟一合法子元素的零个或多个实例。
`static int`	`CHILD_POLICY_SEQUENCE` `getChildPolicy` 返回的常量，指示元素必须具有其所有合法子元素的实例序列。
`static int`	`CHILD_POLICY_SOME` `getChildPolicy` 返回的常量，指示元素必须具有按顺序排列的其每个合法子元素的零个或一个实例。
`static int`	`DATATYPE_BOOLEAN` `getAttributeDataType` 返回的常量，指示属性的值为 'true' 或 'false'。
`static int`	`DATATYPE_DOUBLE` 由 `getAttributeDataType` 返回的常量，指示属性的值为双精度十进制浮点数的字符串表示形式。
`static int`	`DATATYPE_FLOAT` 由 `getAttributeDataType` 返回的常量，指示属性的值为十进制浮点数的字符串表示形式。
`static int`	`DATATYPE_INTEGER` `getAttributeDataType` 返回的常量，指示属性的值为整数的字符串表示形式。
`static int`	`DATATYPE_STRING` `getAttributeDataType` 返回的常量，指示属性的值为通用的 Unicode 字符串。
`static int`	`VALUE_ARBITRARY` `getAttributeValueType` 和 `getObjectValueType` 返回的常量，指示可以将属性或用户对象设置为单个任意值。
`static int`	`VALUE_ENUMERATION` `getAttributeValueType` 和 `getObjectValueType` 返回的常量，指示可以将属性或用户对象设置为许多枚举值之一。
`static int`	`VALUE_LIST` `getAttributeValueType` 和 `getObjectValueType` 返回的常量，指示可以将属性或用户对象设置为一个值的列表或数组。
`static int`	`VALUE_NONE` `getObjectValueType` 返回的常量，指示缺少用户对象。
`static int`	`VALUE_RANGE` `getAttributeValueType` 和 `getObjectValueType` 返回的常量，指示可能将属性或用户对象设置为某个值范围。
`static int`	`VALUE_RANGE_MAX_INCLUSIVE` `getAttributeValueType` 和 `getObjectValueType` 返回的常量，指示可将属性或用户对象设置为某个值范围。
`static int`	`VALUE_RANGE_MAX_INCLUSIVE_MASK` 该值可以与 `VALUE_RANGE` 进行“或”运算来获取 `VALUE_RANGE_MAX_INCLUSIVE`，可以与 `VALUE_RANGE_MIN_INCLUSIVE` 进行“或”运算来获取 `VALUE_RANGE_MIN_MAX_INCLUSIVE`。
`static int`	`VALUE_RANGE_MIN_INCLUSIVE` `getAttributeValueType` 和 `getObjectValueType` 返回的常量，指示可以将属性或用户对象设置为某个值范围。
`static int`	`VALUE_RANGE_MIN_INCLUSIVE_MASK` 该值可以与 `VALUE_RANGE` 进行“或”运算来获取 `VALUE_RANGE_MIN_INCLUSIVE`，可以与 `VALUE_RANGE_MAX_INCLUSIVE` 进行“或”运算来获取 `VALUE_RANGE_MIN_MAX_INCLUSIVE`。
`static int`	`VALUE_RANGE_MIN_MAX_INCLUSIVE` `getAttributeValueType` 和 `getObjectValueType` 返回的常量，指示可以将属性或用户对象设置为某个值范围。

方法摘要
`boolean`	`canNodeAppear(String elementName, ImageTypeSpecifier imageType)` 如果允许元素（和它下面的子树）在给定类型（由 `ImageTypeSpecifier` 定义）的图像的元数据文档中出现，则返回 `true`。
`int`	`getAttributeDataType(String elementName, String attrName)` 返回以 `DATATYPE_` 开头的常量之一，指示指定元素中给定属性的值的格式和解释。
`String`	`getAttributeDefaultValue(String elementName, String attrName)` 如果指定属性不显式存在于指定元素中，则以 `String` 的形式返回其默认值；如果不存在可用的默认值，则返回 `null`。
`String`	`getAttributeDescription(String elementName, String attrName, Locale locale)` 返回包含指定属性的描述的 `String`，或者 `null`。
`String[]`	`getAttributeEnumerations(String elementName, String attrName)` 返回一个 `String` 数组，其包含指定元素中给定属性的合法枚举值。
`int`	`getAttributeListMaxLength(String elementName, String attrName)` 返回可用于定义此属性的最大列表项数。
`int`	`getAttributeListMinLength(String elementName, String attrName)` 返回可用于定义此属性的最小列表项数。
`String`	`getAttributeMaxValue(String elementName, String attrName)` 返回属性的最大合法值。
`String`	`getAttributeMinValue(String elementName, String attrName)` 返回属性的最小合法值。
`String[]`	`getAttributeNames(String elementName)` 返回一个 `String` 数组，该数组列出了与指定元素关联的属性的名称。
`int`	`getAttributeValueType(String elementName, String attrName)` 返回以 `VALUE_` 开头的常量之一，指示指定元素中给定属性的值是任意值、被限制在指定范围中的值、被限制为一组枚举值之一，还是一个任意值的以空白分隔的列表。
`String[]`	`getChildNames(String elementName)` 返回一个按出现顺序排列的 `String` 数组，指示允许作为指定元素子元素的元素的名称。
`int`	`getChildPolicy(String elementName)` 返回以 `CHILD_POLICY_` 开头的常量之一，指示指定元素子元素的合法模式。
`String`	`getElementDescription(String elementName, Locale locale)` 返回包含指定元素的描述的 `String`，或者 `null`。
`int`	`getElementMaxChildren(String elementName)` 返回使用子策略 `CHILD_POLICY_REPEAT` 的指定元素的最大子元素数。
`int`	`getElementMinChildren(String elementName)` 返回使用子策略 `CHILD_POLICY_REPEAT` 的指定元素的最小子元素数。
`int`	`getObjectArrayMaxLength(String elementName)` 返回指定元素中可用于定义 `Object` 引用的最大数组元素数。
`int`	`getObjectArrayMinLength(String elementName)` 返回指定元素中可用于定义 `Object` 引用的最小数组元素数。
`Class<?>`	`getObjectClass(String elementName)` 返回存储在元素中的 `Class` 类型的 `Object` 引用。
`Object`	`getObjectDefaultValue(String elementName)` 返回包含指定元素中 `Object` 引用的默认值的 `Object`。
`Object[]`	`getObjectEnumerations(String elementName)` 返回一个 `Object` 数组，该数组包含指定元素中 `Object` 引用的合法枚举值。
`Comparable<?>`	`getObjectMaxValue(String elementName)` 返回指定元素中 `Object` 引用的最大合法值。
`Comparable<?>`	`getObjectMinValue(String elementName)` 返回指定元素中 `Object` 引用的最小合法值。
`int`	`getObjectValueType(String elementName)` 返回以 `VALUE_` 开头的枚举值之一，指示允许用于 `Object` 引用的值（枚举、范围或数组）的类型。
`String`	`getRootName()` 返回格式的根元素的名称。
`boolean`	`isAttributeRequired(String elementName, String attrName)` 如果指定属性必须在指定元素中存在，则返回 `true`。

字段详细信息

CHILD_POLICY_EMPTY

static final int CHILD_POLICY_EMPTY

getChildPolicy 返回的常量，指示某个元素不具有任何子元素。换句话说，要求其为叶节点。

另请参见：: 常量字段值

CHILD_POLICY_ALL

static final int CHILD_POLICY_ALL

getChildPolicy 返回的常量，指示某个元素必须具有按顺序排列的其每个合法子元素的单个实例。在使用 DTD 的情况下，元素的内容由序列 a,b,c,d,... 定义。

另请参见：: 常量字段值

CHILD_POLICY_SOME

static final int CHILD_POLICY_SOME

getChildPolicy 返回的常量，指示元素必须具有按顺序排列的其每个合法子元素的零个或一个实例。在使用 DTD 的情况下，元素的内容由序列 a?,b?,c?,d?,... 定义。

另请参见：: 常量字段值

CHILD_POLICY_CHOICE

static final int CHILD_POLICY_CHOICE

getChildPolicy 返回的常量，指示元素必须具有从其合法子元素中选择的零个或一个子元素。在使用 DTD 的情况下，元素的内容由选择 a|b|c|d|... 定义。

另请参见：: 常量字段值

CHILD_POLICY_SEQUENCE

static final int CHILD_POLICY_SEQUENCE

getChildPolicy 返回的常量，指示元素必须具有其所有合法子元素的实例序列。在使用 DTD 的情况下，元素的内容由序列 (a|b|c|d|...)* 定义。

另请参见：: 常量字段值

CHILD_POLICY_REPEAT

static final int CHILD_POLICY_REPEAT

getChildPolicy 返回的常量，指示元素必须具有其惟一合法子元素的零个或多个实例。在使用 DTD 的情况下，元素的内容由带有星号的表达式 a* 定义。

另请参见：: 常量字段值

CHILD_POLICY_MAX

static final int CHILD_POLICY_MAX

最大有效 CHILD_POLICY_* 常量，将用于范围检查。

另请参见：: 常量字段值