IIOMetadata (Java 2 プラットフォーム SE v1.4.0)

概要

パッケージ

クラス

使用

階層ツリー

非推奨 API

索引

ヘルプ

Java^TM 2
Platform
Std. Ed. v1.4.0

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

javax.imageio.metadata
クラス IIOMetadata

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

public abstract class IIOMetadata
extends Object

イメージとストリームに関連したメタデータ (イメージ以外のデータ) を表すオブジェクトにより拡張される抽象クラスです。プラグインは、不透明な、プラグイン固有のオブジェクトを使用するメタデータを表します。ただし、これらのオブジェクトは、XML DOM インタフェースをサポートする IIOMetadataNode オブジェクトのツリーとして内部情報にアクセスする機能と、テキスト以外のデータを格納し、正当なデータ値に関する情報を取り出すための追加のインタフェースを提供します。このようなツリーの形式はプラグインに依存しますが、プラグインは、下記のプラグインに依存しない形式をサポートできます。1 つのプラグインで複数のメタデータ形式をサポートすることができ、その名前は getMetadataFormatNames を呼び出すことで判定できます。そのプラグインは、メタデータを損失なしで符号化するように設計された「ネイティブ」形式と呼ばれる 1 つの特殊な形式もサポートします。通常、この形式は、特定のファイル形式とともに動作するよう特別に設計され、メタデータの損失がない同じ形式でイメージをロードおよび格納することができますが、イメージ形式が異なる ImageReader と ImageWriter の間でメタデータを転送するには不便な場合があります。2 つのネイティブ形式の間でイメージのファイル形式の場合と同じ程度に損失なしで変換するには、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
          activateController メソッドを呼び出すときに、この IIOMetadata オブジェクトの設定を提供するのに使用する IIOMetadataController です。

protected IIOMetadataController defaultController
          この IIOMetadata オブジェクトのコントローラとして使用するよう推奨されている IIOMetadataController です。

protected String[] extraMetadataFormatClassNames
          null に初期化され、コンストラクタを介して設定された、IIOMetadataFormat を実装し、このプラグインでサポートされる標準およびネイティブ形式以外のメタデータ形式を表すクラスの名前の配列です。

protected String[] extraMetadataFormatNames
          null に初期化され、コンストラクタを介して設定された、このプラグインでサポートされる標準およびネイティブ形式以外の形式の名前の配列です。

protected String nativeMetadataFormatClassName
          null に初期化され、コンストラクタを介して設定された、IIOMetadataFormat を実装し、ネイティブメタデータ形式を表すクラスの名前です。

protected String nativeMetadataFormatName
          null に初期化され、コンストラクタを介して設定された、このオブジェクトのネイティブメタデータ形式の名前です。

protected boolean standardFormatSupported
          具象サブクラスが、コンストラクタを介して設定された標準のメタデータ形式をサポートするかどうかを示す boolean 値です。

コンストラクタの概要

protected IIOMetadata()
          空の IIOMetadata オブジェクトを構築します。

protected IIOMetadata(boolean standardMetadataFormatSupported, String nativeMetadataFormatName, String nativeMetadataFormatClassName, String[] extraMetadataFormatNames, String[] extraMetadataFormatClassNames)
          指定された形式名と形式のクラス名、および標準の形式をサポートするかどうかを示す boolean 値を使用して、IIOMetadata オブジェクトを構築します。

メソッドの概要

boolean activateController()
          この IIOMetadata オブジェクトに対してインストールされている IIOMetadataController をアクティブにし、結果の値を返します。

abstract Node getAsTree(String formatName)
          指定されたメタデータ形式で定義される規則に従って、このオブジェクト内に含まれるメタデータのツリーのルートを表す XML DOM Node オブジェクトを返します。

IIOMetadataController getController()
          現在インストールされている IIOMetadataController を返します。

IIOMetadataController getDefaultController()
          デフォルトが存在する場合は、現在インストールされているコントローラに関係なく、デフォルトの IIOMetadataController を返します。

String[] getExtraMetadataFormatNames()
          このプラグインの getAsTree、setFromTree、および mergeTree メソッドで認識される、ネイティブと標準の形式以外の、追加のメタデータ形式の名前が格納された String の配列を返します。

IIOMetadataFormat getMetadataFormat(String formatName)
          指定されたメタデータ形式を記述する IIOMetadataFormat オブジェクトを返します。

String[] getMetadataFormatNames()
          このプラグインの getAsTree、setFromTree、および mergeTree メソッドで認識される、ネイティブと標準の形式を含む、すべてのメタデータ形式の名前が格納された String の配列を返します。

String getNativeMetadataFormatName()
          このプラグインの「ネイティブ」メタデータ形式の名前を返します。

protected IIOMetadataNode getStandardChromaNode()
          標準の javax_imageio_1.0 メタデータ形式の彩度情報を表す IIOMetadataNode を返します。

protected IIOMetadataNode getStandardCompressionNode()
          標準の javax_imageio_1.0 メタデータ形式の圧縮情報を表す IIOMetadataNode を返します。

protected IIOMetadataNode getStandardDataNode()
          標準の javax_imageio_1.0 メタデータ形式のデータ形式情報を表す IIOMetadataNode を返します。

protected IIOMetadataNode getStandardDimensionNode()
          標準の javax_imageio_1.0 メタデータ形式の寸法情報を表す IIOMetadataNode を返します。

protected IIOMetadataNode getStandardDocumentNode()
          標準の javax_imageio_1.0 メタデータ形式のドキュメント情報を表す IIOMetadataNode を返します。

protected IIOMetadataNode getStandardTextNode()
          標準の javax_imageio_1.0 メタデータ形式のテキスト情報を表す IIOMetadataNode を返します。

protected IIOMetadataNode getStandardTileNode()
          標準の javax_imageio_1.0 メタデータ形式のタイリング情報を表す IIOMetadataNode を返します。

protected IIOMetadataNode getStandardTransparencyNode()
          標準の javax_imageio_1.0 メタデータ形式の透過性情報を表す IIOMetadataNode を返します。

protected IIOMetadataNode getStandardTree()
          標準の javax_imageio_1.0 メタデータ形式の規則に従って、このオブジェクト内に含まれるメタデータを表す IIOMetadataNode のツリーを返すユーティリティメソッドです。

boolean hasController()
          この IIOMetadata オブジェクトに対してコントローラがインストールされている場合は、true を返します。

abstract boolean isReadOnly()
          このオブジェクトが mergeTree、setFromTree、および reset メソッドをサポートしない場合は true を返します。

boolean isStandardMetadataFormatSupported()
          標準のメタデータ形式が getMetadataFormat、getAsTree、setFromTree、および mergeTree でサポートされる場合は true を返します。

abstract void mergeTree(String formatName, Node root)
          指定されたメタデータ形式で構文が定義される XML DOM Node のツリーから、この IIOMetadata オブジェクトの内部状態を変更します。

abstract void reset()
          このオブジェクトに格納されているすべてのデータをデフォルト値にリセットします。

void setController(IIOMetadataController controller)
          activateController メソッドを呼び出して、すべてのデフォルトコントローラをオーバーライドするときに、この IIOMetadata オブジェクトの設定値を指定するのに使う IIOMetadataController を設定します。

void setFromTree(String formatName, Node root)
          指定されたメタデータ形式で構文が定義される XML DOM Node のツリーから、この IIOMetadata オブジェクトの内部状態を設定します。

クラス java.lang.Object から継承したメソッド

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

フィールドの詳細

standardFormatSupported

protected boolean standardFormatSupported

具象サブクラスが、コンストラクタを介して設定された標準のメタデータ形式をサポートするかどうかを示す boolean 値です。

nativeMetadataFormatName

protected String nativeMetadataFormatName

null に初期化され、コンストラクタを介して設定された、このオブジェクトのネイティブメタデータ形式の名前です。

nativeMetadataFormatClassName

protected String nativeMetadataFormatClassName

null に初期化され、コンストラクタを介して設定された、IIOMetadataFormat を実装し、ネイティブメタデータ形式を表すクラスの名前です。

extraMetadataFormatNames

protected String[] extraMetadataFormatNames

null に初期化され、コンストラクタを介して設定された、このプラグインでサポートされる標準およびネイティブ形式以外の形式の名前の配列です。

extraMetadataFormatClassNames

protected String[] extraMetadataFormatClassNames

null に初期化され、コンストラクタを介して設定された、IIOMetadataFormat を実装し、このプラグインでサポートされる標準およびネイティブ形式以外のメタデータ形式を表すクラスの名前の配列です。

defaultController

protected IIOMetadataController defaultController

この IIOMetadata オブジェクトのコントローラとして使用するよう推奨されている IIOMetadataController です。getDefaultController を使用して取り出すことができます。デフォルトのコントローラをインストールするには、setController(getDefaultController()) を呼び出します。このインスタンス変数は、パラメータを設定するために独自のデフォルトコントローラ (通常は GUI) を提供するサブクラスで設定する必要があります。

関連項目:: IIOMetadataController, getDefaultController()

controller

protected IIOMetadataController controller

activateController メソッドを呼び出すときに、この IIOMetadata オブジェクトの設定を提供するのに使用する IIOMetadataController です。この値は、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)

指定された形式名と形式のクラス名、および標準の形式をサポートするかどうかを示す boolean 値を使用して、IIOMetadata オブジェクトを構築します。

このコンストラクタはクラス名の有効性は判定しません。クラス名が無効な場合は、getMetadataFormat のその後の呼び出しで例外が発生する場合があります。

パラメータ:

standardMetadataFormatSupported - このオブジェクトが標準のメタデータ形式を使用して DOM ツリーを返すか受け取ることができる場合は true

nativeMetadataFormatName - ネイティブのメタデータ形式の String 名。ネイティブの形式がない場合は null

nativeMetadataFormatClassName - ネイティブメタデータ形式のクラスの名前。ネイティブの形式がない場合は null

extraMetadataFormatNames - このオブジェクトでサポートされる追加の形式を示す String の配列。存在しない場合は null

extraMetadataFormatClassNames - このオブジェクトでサポートされるすべての追加形式のクラス名を示す String の配列。存在しない場合は null

例外:

IllegalArgumentException - extraMetadataFormatNames の長さが 0 の場合

IllegalArgumentException - extraMetadataFormatNames および extraMetadataFormatClassNames が null でも同じ長さでもない場合

メソッドの詳細

isStandardMetadataFormatSupported

public boolean isStandardMetadataFormatSupported()

標準のメタデータ形式が getMetadataFormat、getAsTree、setFromTree、および mergeTree でサポートされる場合は true を返します。

デフォルトの実装は 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()

このオブジェクトが mergeTree、setFromTree、および reset メソッドをサポートしない場合は true を返します。

戻り値:: この IIOMetadata オブジェクトを変更できない場合は true

getNativeMetadataFormatName

public String getNativeMetadataFormatName()

このプラグインの「ネイティブ」メタデータ形式の名前を返します。通常、この形式を使用すると、このプラグインで処理される形式で格納されているメタデータを損失なしで符号化および転送できます。そのような形式がサポートされていない場合は、null が返されます。

「ネイティブ」メタデータ形式の構造と内容は、この IIOMetadata オブジェクトを作成したプラグインで定義されます。通常、単純な形式のプラグインは、ルートにダミーノードを作成してから、個々のタグ、チャンク、またはキーワードと値のペアを表す一連の子ノードを作成します。プラグインは、ネイティブ形式をドキュメント化するかどうかを選択することができます。

デフォルトの実装は nativeMetadataFormatName インスタンス変数の値を返します。

戻り値:: ネイティブ形式の名前、または null
関連項目:: getExtraMetadataFormatNames(), getMetadataFormatNames()

getExtraMetadataFormatNames

public String[] getExtraMetadataFormatNames()

このプラグインの getAsTree、setFromTree、および mergeTree メソッドで認識される、ネイティブと標準の形式以外の、追加のメタデータ形式の名前が格納された String の配列を返します。そのような追加の形式がない場合は、null が返されます。

デフォルトの実装は extraMetadataFormatNames インスタンス変数の複製を返します。

戻り値:: 少なくとも長さ 1 の String の配列、または 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()

このプラグインの getAsTree、setFromTree、および mergeTree メソッドで認識される、ネイティブと標準の形式を含む、すべてのメタデータ形式の名前が格納された String の配列を返します。そのような形式がない場合は、null が返されます。

デフォルトの実装は getNativeMetadataFormatName、isStandardMetadataFormatSupported、および getExtraMetadataFormatNames を呼び出し、結合された結果を返します。

戻り値:: String の配列
関連項目:: getNativeMetadataFormatName(), isStandardMetadataFormatSupported(), getExtraMetadataFormatNames()

getMetadataFormat

public IIOMetadataFormat getMetadataFormat(String formatName)

指定されたメタデータ形式を記述する IIOMetadataFormat オブジェクトを返します。記述が使用できない場合は null を返します。指定する名前は、getMetadataFormatNames から返された名前の 1 つでなければなりません (つまり、ネイティブの形式名、標準の形式名、または getExtraMetadataFormatNames から返された名前の 1 つ)。

デフォルトの実装では、グローバル標準メタデータ形式名に対して名前を判定し、サポートされている場合はその形式を返します。そうでない場合は、あとに追加の形式名が続くネイティブの形式名に対して判定します。一致が見つかった場合は、該当する nativeMetadataFormatClassName または extraMetadataFormatClassNames から IIOMetadataFormat クラスの名前を取り出し、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

指定されたメタデータ形式で構文が定義される XML DOM Node のツリーから、この IIOMetadata オブジェクトの内部状態を変更します。以前の状態は、指定されたツリーに存在するノードに適合するために必要な場合にだけ変更されます。ツリーの構造または内容が無効である場合は、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()

標準の javax_imageio_1.0 メタデータ形式の彩度情報を表す IIOMetadataNode を返します。そのような情報を使用できない場合は null を返します。このメソッドは、ユーティリティルーチン getStandardTree から呼び出すことを想定しています。

デフォルト実装は null を返します。