モジュール java.desktop

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

クラスTIFFField

java.lang.Object

javax.imageio.plugins.tiff.TIFFField

すべての実装されたインタフェース:

Cloneable

public final class TIFFField
extends Object
implements Cloneable

TIFF 6.0イメージ・ファイル・ディレクトリのフィールドを表すクラスです。

TIFFイメージ・ファイル・ディレクトリ(IFD)のフィールドは、同じデータ型の値のシーケンスを伴うタグ番号として定義されます。 TIFF 6.0では12タイプのデータ型が定義されています。13番目の型IFDは、TIFF仕様補足1のTIFFテクニカル・ノート1で定義されています。 これらのTIFFデータ型はJava定数によって参照され、Java言語のデータ型と型名に内部的に次のようにマップされます:

TIFFデータ型からJavaデータ型へのマッピング

TIFFデータ型	Java定数	Javaのデータ型	Javaの型名
BYTE	TIFFTag.TIFF_BYTE	byte	"Byte"
ASCII	TIFFTag.TIFF_ASCII	String	"Ascii"
SHORT	TIFFTag.TIFF_SHORT	char	"Short"
LONG	TIFFTag.TIFF_LONG	long	"Long"
RATIONAL	TIFFTag.TIFF_RATIONAL	long[2] {numerator, denominator}	"Rational"
SBYTE	TIFFTag.TIFF_SBYTE	byte	"SByte"
UNDEFINED	TIFFTag.TIFF_UNDEFINED	byte	"Undefined"
SSHORT	TIFFTag.TIFF_SSHORT	short	"SShort"
SLONG	TIFFTag.TIFF_SLONG	int	"SLong"
SRATIONAL	TIFFTag.TIFF_SRATIONAL	int[2] {numerator, denominator}	"SRational"
FLOAT	TIFFTag.TIFF_FLOAT	float	"Float"
DOUBLE	TIFFTag.TIFF_DOUBLE	double	"Double"
IFD	TIFFTag.TIFF_IFD_POINTER	long	"IFDPointer"

導入されたバージョン:

9

関連項目:

TIFFDirectory, TIFFTag

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

コンストラクタ

コンストラクタ	説明
TIFFField(TIFFTag tag, int type, int count)	createArrayForType()を使用してデータ配列を構築し、指定されたパラメータと作成された配列でTIFFField(TIFFTag,int,int,Object)を呼び出します。
TIFFField(TIFFTag tag, int type, int count, Object data)	任意のデータを持つTIFFFieldを構築します。
TIFFField(TIFFTag tag, int type, long offset, TIFFDirectory dir)	IFDのオフセットと内容を持つTIFFFieldを構築します。
TIFFField(TIFFTag tag, long value)	単一の負の整数値を持つTIFFFieldを構築します。

メソッドのサマリー

修飾子と型	メソッド	説明
TIFFField	clone()	フィールドとそこに含まれるすべての情報をクローンします。
static Object	createArrayForType(int dataType, int count)	指定されたデータ型に適した配列を作成します。
static TIFFField	createFromMetadataNode(TIFFTagSet tagSet, Node node)	TIFFネイティブ・イメージ・メタデータ・ノードからTIFFFieldを作成します。
byte[]	getAsBytes()	byteの未解釈の配列としてデータを返します。
char[]	getAsChars()	TIFFTag.TIFF_SHORTデータをchar s (符号なし16ビット整数)の配列として返します。
double	getAsDouble(int index)	任意の形式のデータをdoubleとして返します。
double[]	getAsDoubles()	TIFFTag.TIFF_DOUBLEデータをdouble s (64ビット浮動小数点値)の配列として返します。
float	getAsFloat(int index)	任意の形式のデータをfloatとして返します。
float[]	getAsFloats()	TIFFTag.TIFF_FLOATデータをfloat s (32ビット浮動小数点値)の配列として返します。
int	getAsInt(int index)	任意の形式のデータをintとして返します。
int[]	getAsInts()	TIFFTag.TIFF_SLONGデータをint s (符号付き32ビット整数)の配列として返します。
long	getAsLong(int index)	任意の形式のデータをlongとして返します。
long[]	getAsLongs()	TIFFTag.TIFF_LONGまたはTIFF_IFD_POINTERデータをlong s (符号付き64ビット整数)の配列として返します。
Node	getAsNativeNode()	TIFFFieldを、"TIFFField"または"TIFFIFD"という名前のノードとして返します(TIFFネイティブ・イメージ・メタデータ仕様で説明されています)。
long[]	getAsRational(int index)	TIFFTag.TIFF_RATIONALデータ・アイテムをintの2要素配列として返します。
long[][]	getAsRationals()	TIFFTag.TIFF_RATIONALデータをlongの2要素配列の配列として返します。
short[]	getAsShorts()	TIFFTag.TIFF_SSHORTデータをshort s (符号付き16ビット整数)の配列として返します。
int[]	getAsSRational(int index)	TIFFTag.TIFF_SRATIONALデータ・アイテムをintの2要素配列として返します。
int[][]	getAsSRationals()	TIFFTag.TIFF_SRATIONALデータをintの2要素配列の配列として返します。
String	getAsString(int index)	TIFFTag.TIFF_ASCIIの値をStringとして返します。
int	getCount()	フィールドに存在するデータ・アイテムの数を返します。
Object	getData()	フィールドに関連付けられたデータ・オブジェクトへの参照を返します。
TIFFDirectory	getDirectory()	利用可能であれば、関連するTIFFDirectoryを返します。
TIFFTag	getTag()	このフィールドに関連付けられたタグを取得します。
int	getTagNumber()	[0,65535]の範囲のタグ番号を取得します。
int	getType()	フィールドに格納されているデータの型を返します。
static int	getTypeByName(String typeName)	指定されたデータ型名に対応するデータ型定数を返します。
static String	getTypeName(int dataType)	指定されたデータ型定数の名前を返します。
String	getValueAsString(int index)	人間が判読可能なバージョンのデータ・アイテムを含むStringを返します。
boolean	hasDirectory()	フィールドにTIFFDirectoryがあるかどうかを返します。
boolean	isIntegral()	フィールドに関連付けられた値が整数データ型であるかどうかを示します。

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

equals、finalize、getClass、hashCode、notify、notifyAll、toString、wait、wait、wait

コンストラクタの詳細

TIFFField

public TIFFField(TIFFTag tag,
                 int type,
                 int count,
                 Object data)

任意のデータを持つTIFFFieldを構築します。 typeパラメータは、tag.isDataTypeOK()がtrueを返す値でなければなりません。 dataパラメータは、TIFFフィールドの型に適したJava型の配列でなければなりません。

TIFFFieldの値(data)は、その値に必要なバイト数に関係なく、常に実際のフィールド値になります。 これは、フィールドに対応するTIFF 「IFDエントリ」が、実際に値(後者は、値が4バイトに収まる場合にのみ発生)ではなくフィールドの値へのオフセットを実際に含んでいる可能性があるにもかかわらず、このケースです。 つまり、フィールドの値は既にTIFFストリームから読み込まれています。 (フィールドが非ベースラインIFDの内容を表すときは、この場合の例外が発生することがあります。 その場合、データはIFDへのオフセットを含むlong[]になり、getDirectory()によって返されるTIFFDirectoryはその内容になります。)

パラメータ:

tag - このフィールドに関連付けられるタグ。

type - TIFFTag.TIFF_*定数の1つ.TIFFストリームに書き込まれたフィールドのデータ型を示します。

count - データ値の数。

data - フィールドの実際のデータ内容。

例外:

NullPointerException - tag == nullの場合。

IllegalArgumentException - typeがTIFFTag.TIFF_*データ型定数の1つでない場合。

IllegalArgumentException - typeが、指定されたTIFFTagの許容できないデータ型である場合。

IllegalArgumentException - count < 0の場合。

IllegalArgumentException - count < 1とtypeがTIFF_RATIONALまたはTIFF_SRATIONALの場合。

IllegalArgumentException - count != 1とtypeがTIFF_IFD_POINTERの場合。

NullPointerException - data == nullの場合。

IllegalArgumentException - dataが、指定された型と互換性のないクラスのインスタンスである場合。

IllegalArgumentException - データ配列のサイズが間違っている場合。

IllegalArgumentException - データ配列の型がTIFF_LONG、TIFF_RATIONAL、またはTIFF_IFD_POINTERであり、いずれかの要素が負であるか0xffffffffより大きい場合。

TIFFField

public TIFFField(TIFFTag tag,
                 int type,
                 int count)

createArrayForType()を使用してデータ配列を構築し、指定されたパラメータと作成された配列でTIFFField(TIFFTag,int,int,Object)を呼び出します。

パラメータ:

tag - このフィールドに関連付けられるタグ。

type - TIFFTag.TIFF_*定数の1つ.TIFFストリームに書き込まれたフィールドのデータ型を示します。

count - データ値の数。

例外:

NullPointerException - tag == nullの場合。

IllegalArgumentException - typeがTIFFTag.TIFF_*データ型定数の1つでない場合。

IllegalArgumentException - typeが、指定されたTIFFTagの許容できないデータ型である場合。

IllegalArgumentException - count < 0の場合。

IllegalArgumentException - count < 1とtypeがTIFF_RATIONALまたはTIFF_SRATIONALの場合。

IllegalArgumentException - count != 1とtypeがTIFF_IFD_POINTERの場合。

関連項目:

TIFFField(TIFFTag,int,int,Object)

TIFFField

public TIFFField(TIFFTag tag,
                 long value)

単一の負の整数値を持つTIFFFieldを構築します。 valueが[0,0xffff]の場合、フィールドの型はTIFF_SHORT、valueが[0x10000,0xffffffff]の場合はTIFF_LONGと入力します。 フィールドのカウントは1になります。

パラメータ:

tag - このフィールドに関連付けるタグ。

value - このフィールドに関連付ける値。

例外:

NullPointerException - tag == nullの場合。

IllegalArgumentException - valueが[0,0xffffffff]にない場合。

IllegalArgumentException - valueが[0,0xffff]にあり、TIFF_SHORTがTIFFTagのために受け入れられない型である場合、またはvalueが[0x10000,0xffffffff]にあり、TIFF_LONGがTIFFTagのために受け入れがたい型である場合。

TIFFField

public TIFFField(TIFFTag tag,
                 int type,
                 long offset,
                 TIFFDirectory dir)

IFDのオフセットと内容を持つTIFFFieldを構築します。 オフセットは、このフィールドのデータとしてlong[] {offset}として保存されます。 ディレクトリはクローンされません。 フィールドのカウントは1になります。

パラメータ:

tag - このフィールドに関連付けられるタグ。

type - 定数TIFFTag.TIFF_LONGまたはTIFFTag.TIFF_IFD_POINTERの1つ。

offset - IFDオフセット。

dir - ディレクトリ。

例外:

NullPointerException - tag == nullの場合。

IllegalArgumentException - typeが、指定されたTIFFTagの許容できないデータ型である場合。

IllegalArgumentException - typeがTIFFTag.TIFF_LONGでもTIFFTag.TIFF_IFD_POINTERでもない場合。

IllegalArgumentException - offset <= 0の場合。

NullPointerException - dir == nullの場合。

関連項目:

TIFFField(TIFFTag,int,int,Object)

メソッドの詳細

createFromMetadataNode

public static TIFFField createFromMetadataNode(TIFFTagSet tagSet,
                                               Node node)

TIFFネイティブ・イメージ・メタデータ・ノードからTIFFFieldを作成します。 ノードの"number"属性の値がtagSetに見つからない場合、名前TIFFTag.UNKNOWN_TAG_NAMEを持つ新しいTIFFTagが作成され、フィールドに割り当てられます。

パラメータ:

tagSet - フィールドのTIFFTagが属するTIFFTagSet。

node - ネイティブTIFFイメージ・メタデータTIFFFieldノード。

戻り値:

新しいTIFFField。

例外:

IllegalArgumentException - Nodeパラメータの内容が「TIFFネイティブ・イメージ・メタデータ・フォーマット仕様」によって定義されたTIFFField要素構造に従わない場合、またはノード属性とデータの組み合わせがTIFFField(TIFFTag,int,int,Object)コンストラクタ仕様に従って合法でない場合。 このような例外に対しては、原因が設定される可能性があります。

getTag

public TIFFTag getTag()

このフィールドに関連付けられたタグを取得します。

戻り値:

関連するTIFFTag。

getTagNumber

public int getTagNumber()

[0,65535]の範囲のタグ番号を取得します。

戻り値:

タグ番号。

getType

public int getType()

フィールドに格納されているデータの型を返します。 TIFF 6.0ストリームの場合、値はTIFFTag.TIFF_*定数の1つと等しくなります。 TIFFの今後の改訂版では、より高い値が可能です。

戻り値:

フィールド値のデータ型。

getTypeName

public static String getTypeName(int dataType)

指定されたデータ型定数の名前を返します。

パラメータ:

dataType - TIFFTag.TIFF_*定数の1つ.TIFFストリームに書き込まれたフィールドのデータ型を示します。

戻り値:

指定された型定数に対応する型名。

例外:

IllegalArgumentException - dataTypeがTIFFTag.TIFF_*データ型定数の1つでない場合。

getTypeByName

public static int getTypeByName(String typeName)

指定されたデータ型名に対応するデータ型定数を返します。 名前が不明の場合は-1が返されます。

パラメータ:

typeName - 型名です。

戻り値:

名前が認識されない場合は、TIFFTag.TIFF_*定数または-1の1つ。

createArrayForType

public static Object createArrayForType(int dataType,
                                        int count)

指定されたデータ型に適した配列を作成します。

パラメータ:

dataType - TIFFTag.TIFF_*データ型定数の1つ。

count - 配列内の値の数。

戻り値:

指定されたデータ型に適した配列。

例外:

IllegalArgumentException - dataTypeがTIFFTag.TIFF_*データ型定数の1つでない場合。

IllegalArgumentException - count < 0の場合。

IllegalArgumentException - count < 1とtypeがTIFF_RATIONALまたはTIFF_SRATIONALの場合。

IllegalArgumentException - count != 1とtypeがTIFF_IFD_POINTERの場合。

getAsNativeNode

public Node getAsNativeNode()

TIFFFieldを、"TIFFField"または"TIFFIFD"という名前のノードとして返します(TIFFネイティブ・イメージ・メタデータ仕様で説明されています)。 hasDirectory()がtrueを返し、フィールド型がTIFFTag.TIFF_LONGまたはTIFFTag.TIFF_IFD_POINTERの場合にのみ、ノードの名前は"TIFFIFD"になります。

戻り値:

"TIFFField"または"TIFFIFD"と名付けられたNode。

isIntegral

public boolean isIntegral()

フィールドに関連付けられた値が整数データ型であるかどうかを示します。

戻り値:

フィールド型が整数かどうか。

getCount

public int getCount()

フィールドに存在するデータ・アイテムの数を返します。 TIFFTag.TIFF_ASCIIフィールドの場合、返される値は、ファイル表現のようなデータの合計長ではなく、Stringの数です。

戻り値:

フィールドに存在するデータ・アイテムの数。

getData

public Object getData()

フィールドに関連付けられたデータ・オブジェクトへの参照を返します。

戻り値:

フィールドのデータ・オブジェクト。

getAsBytes

public byte[] getAsBytes()

byteの未解釈の配列としてデータを返します。 フィールドの型は、TIFFTag.TIFF_BYTE、TIFF_SBYTE、またはTIFF_UNDEFINEDのいずれかでなければなりません。

TIFFTag.TIFF_BYTE形式のデータの場合、符号拡張を避けるために、データをより長い積分型に昇格させるときにアプリケーションは注意が必要です。

戻り値:

データは未解釈のバイト配列です。

例外:

ClassCastException - フィールドが型TIFF_BYTE、TIFF_SBYTE、またはTIFF_UNDEFINEDでない場合。

getAsChars

public char[] getAsChars()

TIFFTag.TIFF_SHORTデータをchar s (符号なし16ビット整数)の配列として返します。

戻り値:

charの配列としてのデータ。

例外:

ClassCastException - フィールドの型がTIFF_SHORTではない場合。

getAsShorts

public short[] getAsShorts()

TIFFTag.TIFF_SSHORTデータをshort s (符号付き16ビット整数)の配列として返します。

戻り値:

shortの配列としてのデータ。

例外:

ClassCastException - フィールドの型がTIFF_SSHORTではない場合。

getAsInts

public int[] getAsInts()

TIFFTag.TIFF_SLONGデータをint s (符号付き32ビット整数)の配列として返します。

戻り値:

intの配列としてのデータ。

例外:

ClassCastException - フィールドが型TIFF_SHORT、TIFF_SSHORT、またはTIFF_SLONGでない場合。

getAsLongs

public long[] getAsLongs()

TIFFTag.TIFF_LONGまたはTIFF_IFD_POINTERデータをlong s (符号付き64ビット整数)の配列として返します。

戻り値:

longの配列としてのデータ。

例外:

ClassCastException - フィールドが型TIFF_LONGまたはTIFF_IFD_POINTERでない場合。

getAsFloats

public float[] getAsFloats()

TIFFTag.TIFF_FLOATデータをfloat s (32ビット浮動小数点値)の配列として返します。

戻り値:

floatの配列としてのデータ。

例外:

ClassCastException - フィールドの型がTIFF_FLOATではない場合。

getAsDoubles

public double[] getAsDoubles()

TIFFTag.TIFF_DOUBLEデータをdouble s (64ビット浮動小数点値)の配列として返します。

戻り値:

doubleの配列としてのデータ。

例外:

ClassCastException - フィールドの型がTIFF_DOUBLEではない場合。

getAsSRationals

public int[][] getAsSRationals()

TIFFTag.TIFF_SRATIONALデータをintの2要素配列の配列として返します。

戻り値:

署名された有理数の配列としてのデータ。

例外:

ClassCastException - フィールドの型がTIFF_SRATIONALではない場合。

getAsRationals

public long[][] getAsRationals()

TIFFTag.TIFF_RATIONALデータをlongの2要素配列の配列として返します。

戻り値:

署名されていないrationalsの配列としてのデータ。

例外:

ClassCastException - フィールドの型がTIFF_RATIONALではない場合。

getAsInt

public int getAsInt(int index)

任意の形式のデータをintとして返します。

TIFFTag.TIFF_BYTEの値は符号なしとして扱われます。つまり、符号の拡張は行われず、返される値は[0, 255]の範囲になります。 TIFF_SBYTEデータは[-128, 127]の範囲で返されます。

TIFF_UNDEFINEDの値は、TIFF_BYTEのように扱われます。

TIFF_SLONG、TIFF_LONG、TIFF_FLOAT、TIFF_DOUBLEまたはTIFF_IFD_POINTER形式のデータは、単にintにキャストされ、切り捨てられる可能性があります。

TIFF_SRATIONALまたはTIFF_RATIONAL形式のデータは、倍精度算術を使用して分子を分母に分割し、次にintにキャストすることによって評価されます。 精度の低下や切り捨てが発生することがあります。

TIFF_ASCII形式のデータは、Double.parseDoubleメソッドのように解析され、結果ケースはintに解析されます。

パラメータ:

index - データのインデックス。

戻り値:

指定されたインデックスにあるデータをintとして返します。

getAsLong

public long getAsLong(int index)

任意の形式のデータをlongとして返します。

TIFFTag.TIFF_BYTEおよびTIFF_UNDEFINEDデータは符号なしとして扱われます。つまり、符号の拡張は行われず、戻り値は[0, 255]の範囲になります。 TIFF_SBYTEデータは[-128, 127]の範囲で返されます。

TIFF_FLOATとTIFF_DOUBLEのデータは単にlongにキャストされ、切り捨てられます。

TIFF_SRATIONALまたはTIFF_RATIONAL形式のデータは、倍精度算術を使用して分子を分母に分割し、次にlongにキャストすることによって評価されます。 精度の低下や切り捨てが発生することがあります。

TIFF_ASCII形式のデータはDouble.parseDoubleメソッドのように解析され、結果はlongにキャストされます。

パラメータ:

index - データのインデックス。

戻り値:

指定されたインデックスにあるデータをlongとして返します。

getAsFloat

public float getAsFloat(int index)

任意の形式のデータをfloatとして返します。

TIFFTag.TIFF_BYTEおよびTIFF_UNDEFINEDデータは符号なしとして扱われます。つまり、符号の拡張は行われず、戻り値は[0, 255]の範囲になります。 TIFF_SBYTEデータは[-128, 127]の範囲で返されます。

TIFF_SLONG、TIFF_LONG、TIFF_DOUBLE、またはTIFF_IFD_POINTER形式のデータは単にfloatにキャストされ、切り捨てられます。

TIFF_SRATIONALまたはTIFF_RATIONAL形式のデータは、倍精度算術を使用して分子を分母に分割し、次にfloatにキャストすることによって評価されます。

TIFF_ASCII形式のデータはDouble.parseDoubleメソッドのように解析され、結果はfloatにキャストされます。

パラメータ:

index - データのインデックス。

戻り値:

指定されたインデックスにあるデータをfloatとして返します。

getAsDouble

public double getAsDouble(int index)

任意の形式のデータをdoubleとして返します。

TIFFTag.TIFF_BYTEおよびTIFF_UNDEFINEDデータは符号なしとして扱われます。つまり、符号の拡張は行われず、戻り値は[0, 255]の範囲になります。 TIFF_SBYTEデータは[-128, 127]の範囲で返されます。

TIFF_SRATIONALまたはTIFF_RATIONAL形式のデータは、倍精度算術を使用して分子を分母に分割することによって評価されます。

TIFF_ASCII形式のデータは、Double.parseDoubleメソッドのように解析されます。

パラメータ:

index - データのインデックス。

戻り値:

指定されたインデックスにあるデータをdoubleとして返します。

getAsString

public String getAsString(int index)

TIFFTag.TIFF_ASCIIの値をStringとして返します。

パラメータ:

index - データのインデックス。

戻り値:

指定されたインデックスにあるデータをStringとして返します。

例外:

ClassCastException - フィールドの型がTIFF_ASCIIではない場合。

getAsSRational

public int[] getAsSRational(int index)

TIFFTag.TIFF_SRATIONALデータ・アイテムをintの2要素配列として返します。

パラメータ:

index - データのインデックス。

戻り値:

指定されたインデックスのデータは、署名付きの合理的なものです。

例外:

ClassCastException - フィールドの型がTIFF_SRATIONALではない場合。

getAsRational

public long[] getAsRational(int index)

TIFFTag.TIFF_RATIONALデータ・アイテムをintの2要素配列として返します。

パラメータ:

index - データのインデックス。

戻り値:

指定されたインデックスのデータは、符号なしの合理的なものです。

例外:

ClassCastException - フィールドの型がTIFF_RATIONALではない場合。

getValueAsString

public String getValueAsString(int index)

人間が判読可能なバージョンのデータ・アイテムを含むStringを返します。 型TIFFTag.TIFF_RATIONALまたはTIFF_SRATIONALのデータは、'/'文字で区切られた整数のペアとして表されます。 TIFFTag.TIFF_RATIONALまたはTIFF_SRATIONALの分子が分母の整数倍である場合、その値は"q/1"として表されます。ここで、qは分子と分母の商です。

パラメータ:

index - データのインデックス。

戻り値:

指定されたインデックスにあるデータをStringとして返します。

例外:

ClassCastException - フィールドが正当なフィールド型のいずれかでない場合。

hasDirectory

public boolean hasDirectory()

フィールドにTIFFDirectoryがあるかどうかを返します。

戻り値:

getDirectory()が非nullを返す場合にのみtrue。

getDirectory

public TIFFDirectory getDirectory()

利用可能であれば、関連するTIFFDirectoryを返します。 ディレクトリが設定されていない場合は、nullが返されます。

戻り値:

TIFFDirectoryインスタンスまたはnull。

clone

public TIFFField clone()
                throws CloneNotSupportedException

フィールドとそこに含まれるすべての情報をクローンします。

オーバーライド:

clone、クラス: Object

戻り値:

このTIFFFieldのクローン。

例外:

CloneNotSupportedException - インスタンスをクローン化できない場合。

関連項目:

Cloneable