public abstract class IIOMetadata extends Object
IIOMetadataNode
オブジェクトのツリーとして内部情報にアクセスする機能と、テキスト以外のデータを格納し、正当なデータ値に関する情報を取り出すための追加のインタフェースを提供します。 このようなツリーの形式はプラグインに依存しますが、プラグインは、下記のプラグインに依存しない形式をサポートできます。 1つのプラグインで複数のメタデータ形式をサポートすることができ、その名前はgetMetadataFormatNames
を呼び出すことで判定できます。 そのプラグインは、メタデータを損失なしでエンコードするように設計された「ネイティブ」形式と呼ばれる単一の特殊な形式をサポートすることもあります。 通常、この形式は、特定のファイル形式とともに動作するよう特別に設計され、メタデータの損失がない同じ形式でイメージをロードおよび格納することができますが、イメージ形式が異なる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)
,ImageTranscoder.convertImageMetadata(javax.imageio.metadata.IIOMetadata, javax.imageio.ImageTypeSpecifier, javax.imageio.ImageWriteParam)
,ImageTranscoder.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 DOMNode
オブジェクトを返します。IIOMetadataController
getController()
現在インストールされているIIOMetadataController
を返します。IIOMetadataController
getDefaultController()
デフォルトのIIOMetadataController
がある場合は、現在インストールされているコントローラとは関係なく、これを返します。String[]
getExtraMetadataFormatNames()
このプラグインのgetAsTree
、setFromTree
、およびmergeTree
メソッドで認識される、ネイティブおよび標準の形式以外の、追加のメタデータ形式の名前が格納されたString
の配列を返します。IIOMetadataFormat
getMetadataFormat(String formatName)
指定されたメタデータ形式を記述するIIOMetadataFormat
オブジェクトを返します。記述が使用できない場合はnull
を返します。String[]
getMetadataFormatNames()
このプラグインのgetAsTree
、setFromTree
、およびmergeTree
メソッドで認識される、ネイティブと標準の形式を含む、すべてのメタデータ形式の名前が格納されたString
の配列を返します。String
getNativeMetadataFormatName()
このプラグインの「ネイティブ」メタデータ形式の名前を返します。通常、この形式を使用すると、このプラグインで処理される形式で格納されているメタデータを損失なしでエンコードおよび転送できます。protected IIOMetadataNode
getStandardChromaNode()
標準のjavax_imageio_1.0
メタデータ形式の彩度情報を表すIIOMetadataNode
を返します。そのような情報を使用できない場合はnull
を返します。protected IIOMetadataNode
getStandardCompressionNode()
標準のjavax_imageio_1.0
メタデータ形式の圧縮情報を表すIIOMetadataNode
を返します。そのような情報を使用できない場合はnull
を返します。protected IIOMetadataNode
getStandardDataNode()
標準のjavax_imageio_1.0
メタデータ形式のデータ形式情報を表すIIOMetadataNode
を返します。そのような情報を使用できない場合はnull
を返します。protected IIOMetadataNode
getStandardDimensionNode()
標準のjavax_imageio_1.0
メタデータ形式の次元情報を表すIIOMetadataNode
を返します。そのような情報を使用できない場合はnull
を返します。protected IIOMetadataNode
getStandardDocumentNode()
標準のjavax_imageio_1.0
メタデータ形式のドキュメント情報を表すIIOMetadataNode
を返します。そのような情報を使用できない場合はnull
を返します。protected IIOMetadataNode
getStandardTextNode()
標準のjavax_imageio_1.0
メタデータ形式のテキスト情報を表すIIOMetadataNode
を返します。そのような情報を使用できない場合はnull
を返します。protected IIOMetadataNode
getStandardTileNode()
標準のjavax_imageio_1.0
メタデータ形式のタイリング情報を表すIIOMetadataNode
を返します。そのような情報を使用できない場合はnull
を返します。protected IIOMetadataNode
getStandardTransparencyNode()
標準のjavax_imageio_1.0
メタデータ形式の透過性情報を表すIIOMetadataNode
を返します。そのような情報を使用できない場合はnull
を返します。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 DOMNode
のツリーから、このIIOMetadata
オブジェクトの内部状態を変更します。abstract void
reset()
このオブジェクトに格納されているすべてのデータをデフォルト値にリセットします。通常は、このオブジェクトの構築直後の状態にリセットします。ただし、正確なセマンティックスはプラグインによって異なります。void
setController(IIOMetadataController controller)
activateController
メソッドを呼び出して、すべてのデフォルト・コントローラをオーバーライドするときに、このIIOMetadata
オブジェクトの設定値を指定するために使用するIIOMetadataController
を設定します。void
setFromTree(String formatName, Node root)
指定されたメタデータ形式で構文が定義されるXML DOMNode
のツリーから、このIIOMetadata
オブジェクトの内部状態を設定します。
-
フィールド詳細
-
standardFormatSupported
protected boolean standardFormatSupported具象サブクラスが、コンストラクタを介して設定された標準のメタデータ形式をサポートするかどうかを示すboolean値です。 -
nativeMetadataFormatName
protected String nativeMetadataFormatNamenull
に初期化され、コンストラクタを介して設定された、このオブジェクトのネイティブ・メタデータ形式の名前です。 -
nativeMetadataFormatClassName
protected String nativeMetadataFormatClassNamenull
に初期化され、コンストラクタを介して設定された、IIOMetadataFormat
を実装し、ネイティブ・メタデータ形式を表すクラスの名前です。 -
extraMetadataFormatNames
protected String[] extraMetadataFormatNamesnull
に初期化され、コンストラクタを介して設定された、このプラグインでサポートされる標準およびネイティブ形式以外の形式の名前の配列です。 -
extraMetadataFormatClassNames
protected String[] extraMetadataFormatClassNamesnull
に初期化され、コンストラクタを介して設定された、IIOMetadataFormat
を実装し、このプラグインでサポートされる標準およびネイティブ形式以外のメタデータ形式を表すクラスの名前の配列です。 -
defaultController
protected IIOMetadataController defaultControllerこのIIOMetadata
オブジェクトのコントローラとして使用するよう推奨されているIIOMetadataController
です。getDefaultController
を使用して取り出すことができます。 デフォルトのコントローラをインストールするには、setController(getDefaultController())
を呼び出します。 このインスタンス変数は、パラメータを設定するために独自のデフォルト・コントローラ(通常はGUI)を提供するサブクラスで設定する必要があります。 -
controller
protected IIOMetadataController controlleractivateController
メソッドが呼び出されたときに、このIIOMetadata
オブジェクトの設定を指定するために使用するIIOMetadataController
です。 この値はnull
の場合を含むすべてのデフォルト・コントローラをオーバーライドします。
-
-
コンストラクタの詳細
-
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
指定されたメタデータ形式で定義される規則に従って、このオブジェクト内に含まれるメタデータのツリーのルートを表すXML DOMNode
オブジェクトを返します。使用可能なメタデータ形式の名前は、
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 DOMNode
のツリーから、このIIOMetadata
オブジェクトの内部状態を変更します。 以前の状態は、指定されたツリーに存在するノードに適合するために必要な場合にだけ変更されます。 ツリーの構造または内容が無効である場合は、IIOInvalidTreeException
がスローされます。ツリーまたはサブツリーをほかのツリーとマージする方法のセマンティックスは完全に形式固有なので、プラグインの作成者は、その形式にもっとも適切な方法でこのメソッドを実装することができます。既存のすべての状態を指定されたツリーの内容に置き換えるだけなどの方法があります。
- パラメータ:
formatName
- 目的のメタデータ形式。root
- ツリーのルートを形成するXML DOMNode
オブジェクト。- 例外:
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
を返します。サブクラスは、標準のメタデータ形式をサポートする場合は、このメソッドをオーバーライドして適切なサブツリーを生成する必要があります。
- 戻り値:
IIOMetadataNode
、またはnull
。- 関連項目:
getStandardTree()
-
getStandardCompressionNode
protected IIOMetadataNode getStandardCompressionNode()標準のjavax_imageio_1.0
メタデータ形式の圧縮情報を表すIIOMetadataNode
を返します。そのような情報を使用できない場合はnull
を返します。 このメソッドは、ユーティリティ・ルーチンgetStandardTree
から呼び出すことを想定しています。デフォルトの実装では
null
を返します。サブクラスは、標準のメタデータ形式をサポートする場合は、このメソッドをオーバーライドして適切なサブツリーを生成する必要があります。
- 戻り値:
IIOMetadataNode
、またはnull
。- 関連項目:
getStandardTree()
-
getStandardDataNode
protected IIOMetadataNode getStandardDataNode()標準のjavax_imageio_1.0
メタデータ形式のデータ形式情報を表すIIOMetadataNode
を返します。そのような情報を使用できない場合はnull
を返します。 このメソッドは、ユーティリティ・ルーチンgetStandardTree
から呼び出すことを想定しています。デフォルトの実装では
null
を返します。サブクラスは、標準のメタデータ形式をサポートする場合は、このメソッドをオーバーライドして適切なサブツリーを生成する必要があります。
- 戻り値:
IIOMetadataNode
、またはnull
。- 関連項目:
getStandardTree()
-
getStandardDimensionNode
protected IIOMetadataNode getStandardDimensionNode()標準のjavax_imageio_1.0
メタデータ形式の次元情報を表すIIOMetadataNode
を返します。そのような情報を使用できない場合はnull
を返します。 このメソッドは、ユーティリティ・ルーチンgetStandardTree
から呼び出すことを想定しています。デフォルトの実装では
null
を返します。サブクラスは、標準のメタデータ形式をサポートする場合は、このメソッドをオーバーライドして適切なサブツリーを生成する必要があります。
- 戻り値:
IIOMetadataNode
、またはnull
。- 関連項目:
getStandardTree()
-
getStandardDocumentNode
protected IIOMetadataNode getStandardDocumentNode()標準のjavax_imageio_1.0
メタデータ形式のドキュメント情報を表すIIOMetadataNode
を返します。そのような情報を使用できない場合はnull
を返します。 このメソッドは、ユーティリティ・ルーチンgetStandardTree
から呼び出すことを想定しています。デフォルトの実装では
null
を返します。サブクラスは、標準のメタデータ形式をサポートする場合は、このメソッドをオーバーライドして適切なサブツリーを生成する必要があります。
- 戻り値:
IIOMetadataNode
、またはnull
。- 関連項目:
getStandardTree()
-
getStandardTextNode
protected IIOMetadataNode getStandardTextNode()標準のjavax_imageio_1.0
メタデータ形式のテキスト情報を表すIIOMetadataNode
を返します。そのような情報を使用できない場合はnull
を返します。 このメソッドは、ユーティリティ・ルーチンgetStandardTree
から呼び出すことを想定しています。デフォルトの実装では
null
を返します。サブクラスは、標準のメタデータ形式をサポートする場合は、このメソッドをオーバーライドして適切なサブツリーを生成する必要があります。
- 戻り値:
IIOMetadataNode
、またはnull
。- 関連項目:
getStandardTree()
-
getStandardTileNode
protected IIOMetadataNode getStandardTileNode()標準のjavax_imageio_1.0
メタデータ形式のタイリング情報を表すIIOMetadataNode
を返します。そのような情報を使用できない場合はnull
を返します。 このメソッドは、ユーティリティ・ルーチンgetStandardTree
から呼び出すことを想定しています。デフォルトの実装では
null
を返します。サブクラスは、標準のメタデータ形式をサポートする場合は、このメソッドをオーバーライドして適切なサブツリーを生成する必要があります。
- 戻り値:
IIOMetadataNode
、またはnull
。- 関連項目:
getStandardTree()
-
getStandardTransparencyNode
protected IIOMetadataNode getStandardTransparencyNode()標準のjavax_imageio_1.0
メタデータ形式の透過性情報を表すIIOMetadataNode
を返します。そのような情報を使用できない場合はnull
を返します。 このメソッドは、ユーティリティ・ルーチンgetStandardTree
から呼び出すことを想定しています。デフォルトの実装では
null
を返します。サブクラスは、標準のメタデータ形式をサポートする場合は、このメソッドをオーバーライドして適切なサブツリーを生成する必要があります。
- 戻り値:
IIOMetadataNode
、またはnull
。
-
getStandardTree
protected final IIOMetadataNode getStandardTree()標準のjavax_imageio_1.0
メタデータ形式の規則に従って、このオブジェクト内に含まれるメタデータを表すIIOMetadataNode
のツリーを返すユーティリティ・メソッドです。このメソッドは、各種の
getStandard*Node
メソッドを呼び出して、ルート・ノードの子をルートとする各サブツリーを指定します。 これらのメソッドのいずれかがnull
を返す場合、対応するサブツリーは省略されます。 これらのメソッドのすべてがnull
を返す場合は、1つのルート・ノードで構成されるツリーが返されます。- 戻り値:
javax_imageio_1.0
形式でメタデータ・ツリーのルートを表すIIOMetadataNode
。- 関連項目:
getStandardChromaNode()
,getStandardCompressionNode()
,getStandardDataNode()
,getStandardDimensionNode()
,getStandardDocumentNode()
,getStandardTextNode()
,getStandardTileNode()
,getStandardTransparencyNode()
-
setFromTree
public void setFromTree(String formatName, Node root) throws IIOInvalidTreeException指定されたメタデータ形式で構文が定義されるXML DOMNode
のツリーから、このIIOMetadata
オブジェクトの内部状態を設定します。 以前の状態は破棄されます。 ツリーの構造または内容が無効である場合は、IIOInvalidTreeException
がスローされます。デフォルトの実装では、あとに
mergeTree(formatName, root)
が続くreset
を呼び出します。- パラメータ:
formatName
- 目的のメタデータ形式。root
- ツリーのルートを形成するXML DOMNode
オブジェクト。- 例外:
IllegalStateException
- このオブジェクトが読込み専用の場合。IllegalArgumentException
-formatName
がnull
であるか、getMetadataFormatNames
から返された名前でない場合。IllegalArgumentException
-root
がnull
の場合。IIOInvalidTreeException
- 指定された形式のルールを使用してツリーを正常に構文解析できない場合。- 関連項目:
getMetadataFormatNames()
,getAsTree(java.lang.String)
,mergeTree(java.lang.String, org.w3c.dom.Node)
-
reset
public abstract void reset()このオブジェクトに格納されているすべてのデータをデフォルト値にリセットします。通常は、このオブジェクトの構築直後の状態にリセットします。ただし、正確なセマンティックスはプラグインによって異なります。 オブジェクトを作成した方法によって、多数のデフォルト値が存在する可能性があります。 -
setController
public void setController(IIOMetadataController controller)activateController
メソッドを呼び出して、すべてのデフォルト・コントローラをオーバーライドするときに、このIIOMetadata
オブジェクトの設定値を指定するために使用するIIOMetadataController
を設定します。 引数がnull
の場合は、デフォルトのコントローラを含め、どのコントローラも使用されません。 デフォルトのコントローラを復元するには、setController(getDefaultController())
を使用します。デフォルトの実装は、
controller
インスタンス変数を、指定された値に設定します。- パラメータ:
controller
- 適切なIIOMetadataController
、またはnull
。- 関連項目:
IIOMetadataController
,getController()
,getDefaultController()
,hasController()
,activateController()
-
getController
public IIOMetadataController getController()現在インストールされているIIOMetadataController
を返します。 返される値は、デフォルトが存在する場合はデフォルトであり、null
、または最後のsetController
呼出しの引数である場合もあります。デフォルトの実装では、
controller
インスタンス変数の値が返されます。- 戻り値:
- 現在インストールされている
IIOMetadataController
、またはnull
。 - 関連項目:
IIOMetadataController
,setController(javax.imageio.metadata.IIOMetadataController)
,getDefaultController()
,hasController()
,activateController()
-
getDefaultController
public IIOMetadataController getDefaultController()デフォルトのIIOMetadataController
がある場合は、現在インストールされているコントローラとは関係なく、これを返します。 デフォルト・コントローラがない場合は、null
を返します。デフォルトの実装では、
defaultController
インスタンス変数の値が返されます。- 戻り値:
- デフォルトの
IIOMetadataController
、またはnull
。 - 関連項目:
IIOMetadataController
,setController(IIOMetadataController)
,getController()
,hasController()
,activateController()
-
hasController
public boolean hasController()このIIOMetadata
オブジェクトにインストールされたコントローラがある場合はtrue
を返します。デフォルトの実装は、
getController
メソッドがnull
以外の値を返す場合、true
を返します。- 戻り値:
- コントローラがインストールされている場合は
true
。 - 関連項目:
IIOMetadataController
,setController(IIOMetadataController)
,getController()
,getDefaultController()
,activateController()
-
activateController
public boolean activateController()このIIOMetadata
オブジェクトに対してインストールされているIIOMetadataController
をアクティブにし、結果の値を返します。 このメソッドがtrue
を返す場合、このIIOMetadata
オブジェクトのすべての値は次の書込み操作で使用する準備ができています。false
が返される場合は、このオブジェクト内の設定値への影響はありません。つまり、ユーザーにより操作が取り消されました。通常、コントローラは、特定のプラグインに対する
IIOMetadata
のサブクラスのユーザー・インタフェースを提供するGUIです。 ただし、コントローラはGUIである必要はありません。デフォルトの実装は
getController
を呼び出し、hasController
がtrue
を返す場合は、返されたオブジェクトでactivate
を呼び出します。- 戻り値:
- コントローラが通常どおり完了した場合は
true
。 - 例外:
IllegalStateException
- コントローラが現在インストールされていない場合。- 関連項目:
IIOMetadataController
,setController(IIOMetadataController)
,getController()
,getDefaultController()
,hasController()
-