モジュール java.desktop

パッケージ javax.imageio.plugins.tiff

クラスTIFFTag

java.lang.Object

javax.imageio.plugins.tiff.TIFFTag

public class TIFFTag extends Object

TIFFタグの概念を定義するクラス。 TIFFタグは、イメージ・ファイル・ディレクトリ(IFD)に表示されるキーです。 IFDでは、各タグには、特定のデータ型の0個以上の値で構成されるいくつかのデータが関連付けられています。 タグと値の組合せは、IFDエントリまたはTIFFフィールドと呼ばれます。

標準の("baseline") tiffストリームのルートIFDで使用される実際のタグ値は、BaselineTIFFTagSetクラスで定義されます。

導入されたバージョン:

9

関連項目:

• BaselineTIFFTagSet
• TIFFField
• TIFFTagSet

フィールドのサマリー

フィールド

修飾子と型	フィールド	説明
static final int	MAX_DATATYPE	TIFFデータ型を表す最大定数。
static final int	MIN_DATATYPE	TIFFデータ型を表す最小の数値定数。
static final int	TIFF_ASCII	NULLで終了するASCII文字列のフラグ。
static final int	TIFF_BYTE	8ビットの符号なし整数のフラグ。
static final int	TIFF_DOUBLE	64ビットのIEEE倍数のフラグ。
static final int	TIFF_FLOAT	32ビットIEEE浮動小数点数のフラグ。
static final int	TIFF_IFD_POINTER	TIFF仕様補足1のTIFF Tech Note 1で定義されているIFDポインタのフラグ。
static final int	TIFF_LONG	32ビットの符号なし整数のフラグ。
static final int	TIFF_RATIONAL	32ビットの符号なし整数のペアのフラグ。
static final int	TIFF_SBYTE	8ビット符号付き整数のフラグ。
static final int	TIFF_SHORT	16ビットの符号なし整数のフラグ。
static final int	TIFF_SLONG	32ビット符号付き整数のフラグ。
static final int	TIFF_SRATIONAL	32ビット符号付き整数のペアのフラグ。
static final int	TIFF_SSHORT	16ビット符号付き整数のフラグ。
static final int	TIFF_UNDEFINED	8ビットの未解釈バイトのフラグ。
static final String	UNKNOWN_TAG_NAME	タグ番号が不明なタグに割り当てられた名前。

コンストラクタのサマリー

コンストラクタ

コンストラクタ	説明
TIFFTag(String name, int number, int dataTypes)	指定された名前、タグ番号および有効なデータ型のセットを持つTIFFTagを構築します。
TIFFTag(String name, int number, int dataTypes, int count)	指定された名前、タグ番号、有効なデータ型のセットおよび値数を持つTIFFTagを構築します。
TIFFTag(String name, int number, TIFFTagSet tagSet)	指定された名前、タグ番号および参照先TIFFTagSetを持つTIFFTagを構築します。

メソッドのサマリー

修飾子と型	メソッド	説明
protected void	addValueName(int value, String name)	このタグのデータが取得できる特定の値のニーモニック名を追加します。
int	getCount()	このタグの値カウントを返します。
int	getDataTypes()	タグに関連付けられたデータの格納に使用できるデータ型のセットを示すビット・マスクを返します。
String	getName()	イメージ・メタデータに表示されるタグの名前を返します。
int[]	getNamedValues()	ニーモニック名が定義されている値の配列を返します。
int	getNumber()	タグを表すために使用される整数を返します。
static int	getSizeOfType(int dataType)	指定されたデータ型の値の格納に使用されるバイト数を返します。
TIFFTagSet	getTagSet()	このタグが一部であるTIFFTagSetを返します。
String	getValueName(int value)	このタグのデータが取得できる特定の値に関連付けられているニーモニック名、または名前が存在しない場合はnullを返します。
boolean	hasValueNames()	このタグに関連付けられたデータの有効な値のセットに関連付けられているニーモニック名がある場合は、trueを返します。
boolean	isDataTypeOK(int dataType)	指定されたデータ型をこのタグに関連付けられたデータに使用できる場合は、trueを返します。
boolean	isIFDPointer()	このタグを使用して、追加タグを含むIFD構造体を指し示す場合は、trueを返します。

クラスjava.lang.Objectで宣言されたメソッド

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

フィールド詳細

TIFF_BYTE

public static final int TIFF_BYTE

8ビットの符号なし整数のフラグ。

関連項目:

• 定数フィールド値

TIFF_ASCII

public static final int TIFF_ASCII

NULLで終了するASCII文字列のフラグ。

関連項目:

• 定数フィールド値

TIFF_SHORT

public static final int TIFF_SHORT

16ビットの符号なし整数のフラグ。

関連項目:

• 定数フィールド値

TIFF_LONG

public static final int TIFF_LONG

32ビットの符号なし整数のフラグ。

関連項目:

• 定数フィールド値

TIFF_RATIONAL

public static final int TIFF_RATIONAL

32ビットの符号なし整数のペアのフラグ。

関連項目:

• 定数フィールド値

TIFF_SBYTE

public static final int TIFF_SBYTE

8ビット符号付き整数のフラグ。

関連項目:

• 定数フィールド値

TIFF_UNDEFINED

public static final int TIFF_UNDEFINED

8ビットの未解釈バイトのフラグ。

関連項目:

• 定数フィールド値

TIFF_SSHORT

public static final int TIFF_SSHORT

16ビット符号付き整数のフラグ。

関連項目:

• 定数フィールド値

TIFF_SLONG

public static final int TIFF_SLONG

32ビット符号付き整数のフラグ。

関連項目:

• 定数フィールド値

TIFF_SRATIONAL

public static final int TIFF_SRATIONAL

32ビット符号付き整数のペアのフラグ。

関連項目:

• 定数フィールド値

TIFF_FLOAT

public static final int TIFF_FLOAT

32ビットIEEE浮動小数点数のフラグ。

関連項目:

• 定数フィールド値

TIFF_DOUBLE

public static final int TIFF_DOUBLE

64ビットのIEEE倍数のフラグ。

関連項目:

• 定数フィールド値

TIFF_IFD_POINTER

public static final int TIFF_IFD_POINTER

TIFF仕様補足1のTIFF Tech Note 1で定義されているIFDポインタのフラグ。

関連項目:

• 定数フィールド値

MIN_DATATYPE

public static final int MIN_DATATYPE

TIFFデータ型を表す最小の数値定数。

関連項目:

• 定数フィールド値

MAX_DATATYPE

public static final int MAX_DATATYPE

TIFFデータ型を表す最大定数。

関連項目:

• 定数フィールド値

UNKNOWN_TAG_NAME

public static final String UNKNOWN_TAG_NAME

タグ番号が不明なタグに割り当てられた名前。 このようなタグは、たとえばIFDの読取り時に作成され、リーダーが認識しているTIFFTagSetのいずれにもないタグ番号が検出される場合があります。

関連項目:

• 定数フィールド値

コンストラクタの詳細

TIFFTag

public TIFFTag(String name, int number, int dataTypes, int count)

指定された名前、タグ番号、有効なデータ型のセットおよび値数を持つTIFFTagを構築します。 負の値の数は、任意の値の数が正当であるか、または必要な数がIFD内の他のフィールドの値によって決定されることを示します。 負でないカウントは、関連付けられたフィールドに含める必要がある値の数を指定します。 このタグにはTIFFTagSetは関連付けられていません。

タグの有効なデータ値に関連付けるニーモニック名がある場合は、名前ごとに新しいインスタンスでaddValueName()をコールする必要があります。 ニーモニック名は、整数データ型のタグにのみ適用されます。

データ型のセットをビット・マスクに変換する方法については、getDataTypes()のドキュメントを参照してください。

パラメータ:

name - タグの名前。

number - タグを表すために使用される番号。

dataTypes - このタグの有効なデータ型のセットを示すビット・マスク。

count - このタグの値数。

例外:

NullPointerException - nameがnullの場合。

IllegalArgumentException - 数値に負の値を指定するか、dataTypesに負の値を指定するか、範囲外のタイプを指定します。

TIFFTag

public TIFFTag(String name, int number, TIFFTagSet tagSet)

指定された名前、タグ番号および参照先TIFFTagSetを持つTIFFTagを構築します。 有効なデータ型は、TIFF_LONGおよびTIFF_IFD_POINTERを含むように設定され、値カウントはunityです。 TIFFTagSetは、指定されたIFDに表示されるTIFFTagのセットを表します。 TIFFTagは、tagSetがnull以外の場合、またはデータ型TIFF_IFD_POINTERが有効な場合のみ、IFDポインタを表します。

パラメータ:

name - タグの名前。

number - タグを表すために使用される番号。

tagSet - このタグが属するTIFFTagSet。

例外:

NullPointerException - nameまたはtagSetがnullの場合。

IllegalArgumentException - 数値が負の場合。

関連項目:

• TIFFTag(String, int, int, int)

TIFFTag

public TIFFTag(String name, int number, int dataTypes)

指定された名前、タグ番号および有効なデータ型のセットを持つTIFFTagを構築します。 タグの値のカウントは未定義で、関連するTIFFTagSetはありません。

パラメータ:

name - タグの名前。

number - タグを表すために使用される番号。

dataTypes - このタグの有効なデータ型のセットを示すビット・マスク。

例外:

NullPointerException - nameがnullの場合。

IllegalArgumentException - 数値に負の値を指定するか、dataTypesに負の値を指定するか、範囲外のタイプを指定します。

関連項目:

• TIFFTag(String, int, int, int)

メソッドの詳細

getSizeOfType

public static int getSizeOfType(int dataType)

指定されたデータ型の値の格納に使用されるバイト数を返します。

パラメータ:

dataType - 問い合せるデータ型。

戻り値:

指定されたデータ型の格納に使用されるバイト数。

例外:

IllegalArgumentException - datatypeがMIN_DATATYPEより小さいか、MAX_DATATYPEより大きい場合。

getName

public String getName()

イメージ・メタデータに表示されるタグの名前を返します。

戻り値:

タグ名をStringとして指定します。

getNumber

public int getNumber()

タグを表すために使用される整数を返します。

戻り値:

タグ番号(int)。

getDataTypes

public int getDataTypes()

タグに関連付けられたデータの格納に使用できるデータ型のセットを示すビット・マスクを返します。 たとえば、SHORTとLONGの両方の値を格納できるタグは、次の値を返します:

 (1 << TIFFTag.TIFF_SHORT) | (1 << TIFFTag.TIFF_LONG)
 

戻り値:

有効なデータ型のセットをエンコードするビット・マスクを含むint。

getCount

public int getCount()

このタグの値カウントを返します。 この値が正の場合、このタグを持つTIFFFieldに必要な値の数を表します。 値が負の場合、カウントは未定義です。 後者の場合、カウントを導出できます。たとえば、BitsPerSampleフィールドの値の数はSamplesPerPixelです。または、ほとんどのUS-ASCIIフィールドの場合と同様に変数にすることもできます。

戻り値:

このタグの値数。

isDataTypeOK

public boolean isDataTypeOK(int dataType)

指定されたデータ型をこのタグに関連付けられたデータに使用できる場合は、trueを返します。

パラメータ:

dataType - 問い合せるデータ型、TIFF_BYTE、TIFF_SHORTなど。

戻り値:

指定されたデータ型がこのタグで使用できるかどうかを示すboolean。

例外:

IllegalArgumentException - datatypeがMIN_DATATYPEより小さいか、MAX_DATATYPEより大きい場合。

getTagSet

public TIFFTagSet getTagSet()

このタグが一部であるTIFFTagSetを返します。

戻り値:

TIFFTagSetを含む。

isIFDPointer

public boolean isIFDPointer()

このタグを使用して、追加タグを含むIFD構造体を指し示す場合は、trueを返します。 TIFFTagは、そのTIFFTagSetがnull以外の場合、またはデータ型TIFF_IFD_POINTERが有効な場合のみ、IFDポインタを表します。 この条件は、getTagSet() != nullまたはisDataTypeOK(TIFF_IFD_POINTER) == trueのいずれかの場合にのみ満たされます。

多くのTIFF拡張では、ルートIFDに表示される可能性のある新しいタグの数を制限するためにIFDメカニズムが使用されます。

戻り値:

このタグがIFDを指している場合、true。

hasValueNames

public boolean hasValueNames()

このタグに関連付けられたデータの有効な値のセットに関連付けられているニーモニック名がある場合は、trueを返します。 ニーモニック名は、整数データ型のタグにのみ適用されます。

戻り値:

ニーモニック値名が使用可能な場合はtrue。

addValueName

protected void addValueName(int value, String name)

このタグのデータが取得できる特定の値のニーモニック名を追加します。 ニーモニック名は、整数データ型のタグにのみ適用されます。

パラメータ:

value - データ値。

name - 値に関連付ける名前。

getValueName

public String getValueName(int value)

このタグのデータが取得できる特定の値に関連付けられているニーモニック名、または名前が存在しない場合はnullを返します。 ニーモニック名は、整数データ型のタグにのみ適用されます。

パラメータ:

value - データ値。

戻り値:

値に関連付けられたニーモニック名をStringとして指定します。

getNamedValues

public int[] getNamedValues()

ニーモニック名が定義されている値の配列を返します。 メソッドgetValueName()は、戻された配列に含まれる値に対してのみ、null以外を返します。 ニーモニック名は、整数データ型のタグにのみ適用されます。

戻り値:

ニーモニック名が存在する値。