クラスIIOMetadata

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

    クラスオブジェクトで宣言されたメソッド

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    修飾子と型
    メソッド
    説明
    protected Object
    clone()
    このオブジェクトのコピーを作成して、返します。
    boolean
    equals(Object obj)
    このオブジェクトと他のオブジェクトが等しいかどうかを示します。
    protected void
    finalize()
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    最終決定は非推奨であり、将来のリリースで削除される可能性があります。
    final Class<?>
    getClass()
    このObjectの実行時クラスを返します。
    int
    hashCode()
    このオブジェクトに対するハッシュ・コード値を返します。
    final void
    notify()
    このオブジェクトのモニターで待機中のスレッドを1つ再開します。
    final void
    notifyAll()
    このオブジェクトのモニターで待機中のすべてのスレッドを再開します。
    String
    toString()
    オブジェクトの文字列表現を返します。
    final void
    wait()
    現在のスレッドが目覚めるまで待機します。通常、notifiedまたはinterruptedです。
    final void
    wait(long timeoutMillis)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。
    final void
    wait(long timeoutMillis, int nanos)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

  • フィールド詳細

    • 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)を提供するサブクラスで設定する必要があります。
      関連項目:

    • controller

      protected IIOMetadataController controller
      activateControllerメソッドが呼び出されたときに、この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。
      関連項目:

    • isReadOnly

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

    • getNativeMetadataFormatName

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

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

      デフォルトの実装では、nativeMetadataFormatNameインスタンス変数の値が返されます。

      戻り値:
      ネイティブ形式の名前、またはnull。
      関連項目:

    • getExtraMetadataFormatNames

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

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

      戻り値:
      少なくとも長さ1のStringの配列、またはnull。
      関連項目:

    • getMetadataFormatNames

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

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

      戻り値:
      Stringの配列。
      関連項目:

    • 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から返された名前でない場合。
      関連項目:

    • 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 - 指定された形式のルールを使用してツリーを正常に構文解析できない場合。
      関連項目:

    • getStandardChromaNode

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

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

      サブクラスは、標準のメタデータ形式をサポートする場合は、このメソッドをオーバーライドして適切なサブツリーを生成する必要があります。

      戻り値:
      IIOMetadataNode、またはnull。
      関連項目:

    • getStandardCompressionNode

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

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

      サブクラスは、標準のメタデータ形式をサポートする場合は、このメソッドをオーバーライドして適切なサブツリーを生成する必要があります。

      戻り値:
      IIOMetadataNode、またはnull。
      関連項目:

    • getStandardDataNode

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

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

      サブクラスは、標準のメタデータ形式をサポートする場合は、このメソッドをオーバーライドして適切なサブツリーを生成する必要があります。

      戻り値:
      IIOMetadataNode、またはnull。
      関連項目:

    • getStandardDimensionNode

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

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

      サブクラスは、標準のメタデータ形式をサポートする場合は、このメソッドをオーバーライドして適切なサブツリーを生成する必要があります。

      戻り値:
      IIOMetadataNode、またはnull。
      関連項目:

    • getStandardDocumentNode

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

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

      サブクラスは、標準のメタデータ形式をサポートする場合は、このメソッドをオーバーライドして適切なサブツリーを生成する必要があります。

      戻り値:
      IIOMetadataNode、またはnull。
      関連項目:

    • getStandardTextNode

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

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

      サブクラスは、標準のメタデータ形式をサポートする場合は、このメソッドをオーバーライドして適切なサブツリーを生成する必要があります。

      戻り値:
      IIOMetadataNode、またはnull。
      関連項目:

    • getStandardTileNode

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

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

      サブクラスは、標準のメタデータ形式をサポートする場合は、このメソッドをオーバーライドして適切なサブツリーを生成する必要があります。

      戻り値:
      IIOMetadataNode、またはnull。
      関連項目:

    • 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。
      関連項目:

    • setFromTree

      public void setFromTree(String formatName, Node root) throws IIOInvalidTreeException
      指定されたメタデータ形式で構文が定義されるXML DOM Nodeのツリーから、このIIOMetadataオブジェクトの内部状態を設定します。 以前の状態は破棄されます。 ツリーの構造または内容が無効である場合は、IIOInvalidTreeExceptionがスローされます。

      デフォルトの実装では、あとにmergeTree(formatName, root)が続くresetを呼び出します。

      パラメータ:
      formatName - 目的のメタデータ形式。
      root - ツリーのルートを形成するXML DOM Nodeオブジェクト。
      スロー:
      IllegalStateException - このオブジェクトが読込み専用の場合。
      IllegalArgumentException - formatNameがnullであるか、getMetadataFormatNamesから返された名前でない場合。
      IllegalArgumentException - rootがnullの場合。
      IIOInvalidTreeException - 指定された形式のルールを使用してツリーを正常に構文解析できない場合。
      関連項目:

    • reset

      public abstract void reset()
      このオブジェクトに格納されているすべてのデータをデフォルト値にリセットします。通常は、このオブジェクトの構築直後の状態にリセットします。ただし、正確なセマンティックスはプラグインによって異なります。 オブジェクトを作成した方法によって、多数のデフォルト値が存在する可能性があります。
      スロー:
      IllegalStateException - このオブジェクトが読込み専用の場合。
      関連項目:

    • setController

      public void setController(IIOMetadataController controller)
      activateControllerメソッドを呼び出して、すべてのデフォルト・コントローラをオーバーライドするときに、このIIOMetadataオブジェクトの設定値を指定するために使用するIIOMetadataControllerを設定します。 引数がnullの場合は、デフォルトのコントローラを含め、どのコントローラも使用されません。 デフォルトのコントローラを復元するには、setController(getDefaultController())を使用します。

      デフォルトの実装は、controllerインスタンス変数を、指定された値に設定します。

      パラメータ:
      controller - 適切なIIOMetadataController、またはnull。
      関連項目:

    • getController

      public IIOMetadataController getController()
      現在インストールされているIIOMetadataControllerを返します。 返される値は、デフォルトが存在する場合はデフォルトであり、null、または最後のsetController呼出しの引数である場合もあります。

      デフォルトの実装では、controllerインスタンス変数の値が返されます。

      戻り値:
      現在インストールされているIIOMetadataController、またはnull。
      関連項目:

    • getDefaultController

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

      デフォルトの実装では、defaultControllerインスタンス変数の値が返されます。

      戻り値:
      デフォルトのIIOMetadataController、またはnull。
      関連項目:

    • hasController

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

      デフォルトの実装は、getControllerメソッドがnull以外の値を返す場合、trueを返します。

      戻り値:
      コントローラがインストールされている場合はtrue。
      関連項目:

    • activateController

      public boolean activateController()
      このIIOMetadataオブジェクトに対してインストールされているIIOMetadataControllerをアクティブにし、結果の値を返します。 このメソッドがtrueを返す場合、このIIOMetadataオブジェクトのすべての値は次の書込み操作で使用する準備ができています。 falseが返される場合は、このオブジェクト内の設定値への影響はありません。つまり、ユーザーにより操作が取り消されました。

      通常、コントローラは、特定のプラグインに対するIIOMetadataのサブクラスのユーザー・インタフェースを提供するGUIです。 ただし、コントローラはGUIである必要はありません。

      デフォルトの実装はgetControllerを呼び出し、hasControllerがtrueを返す場合は、返されたオブジェクトでactivateを呼び出します。

      戻り値:
      コントローラが通常どおり完了した場合はtrue。
      スロー:
      IllegalStateException - コントローラが現在インストールされていない場合。
      関連項目: