Class TIFFTag
- java.lang.Object
-
- com.github.jaiimageio.plugins.tiff.TIFFTag
-
- Direct Known Subclasses:
BaselineTIFFTagSet.Artist
,BaselineTIFFTagSet.BitsPerSample
,BaselineTIFFTagSet.CellLength
,BaselineTIFFTagSet.CellWidth
,BaselineTIFFTagSet.ColorMap
,BaselineTIFFTagSet.Compression
,BaselineTIFFTagSet.Copyright
,BaselineTIFFTagSet.DateTime
,BaselineTIFFTagSet.DocumentName
,BaselineTIFFTagSet.DotRange
,BaselineTIFFTagSet.ExtraSamples
,BaselineTIFFTagSet.FillOrder
,BaselineTIFFTagSet.FreeByteCounts
,BaselineTIFFTagSet.FreeOffsets
,BaselineTIFFTagSet.GrayResponseCurve
,BaselineTIFFTagSet.GrayResponseUnit
,BaselineTIFFTagSet.HalftoneHints
,BaselineTIFFTagSet.HostComputer
,BaselineTIFFTagSet.ICCProfile
,BaselineTIFFTagSet.ImageDescription
,BaselineTIFFTagSet.ImageLength
,BaselineTIFFTagSet.ImageWidth
,BaselineTIFFTagSet.InkNames
,BaselineTIFFTagSet.InkSet
,BaselineTIFFTagSet.JPEGACTables
,BaselineTIFFTagSet.JPEGDCTables
,BaselineTIFFTagSet.JPEGInterchangeFormat
,BaselineTIFFTagSet.JPEGInterchangeFormatLength
,BaselineTIFFTagSet.JPEGLosslessPredictors
,BaselineTIFFTagSet.JPEGPointTransforms
,BaselineTIFFTagSet.JPEGProc
,BaselineTIFFTagSet.JPEGQTables
,BaselineTIFFTagSet.JPEGRestartInterval
,BaselineTIFFTagSet.JPEGTables
,BaselineTIFFTagSet.Make
,BaselineTIFFTagSet.MaxSampleValue
,BaselineTIFFTagSet.MinSampleValue
,BaselineTIFFTagSet.Model
,BaselineTIFFTagSet.NewSubfileType
,BaselineTIFFTagSet.NumberOfInks
,BaselineTIFFTagSet.Orientation
,BaselineTIFFTagSet.PageName
,BaselineTIFFTagSet.PageNumber
,BaselineTIFFTagSet.PhotometricInterpretation
,BaselineTIFFTagSet.PlanarConfiguration
,BaselineTIFFTagSet.Predictor
,BaselineTIFFTagSet.PrimaryChromaticities
,BaselineTIFFTagSet.ReferenceBlackWhite
,BaselineTIFFTagSet.ResolutionUnit
,BaselineTIFFTagSet.RowsPerStrip
,BaselineTIFFTagSet.SampleFormat
,BaselineTIFFTagSet.SamplesPerPixel
,BaselineTIFFTagSet.SMaxSampleValue
,BaselineTIFFTagSet.SMinSampleValue
,BaselineTIFFTagSet.Software
,BaselineTIFFTagSet.StripByteCounts
,BaselineTIFFTagSet.StripOffsets
,BaselineTIFFTagSet.SubfileType
,BaselineTIFFTagSet.T4Options
,BaselineTIFFTagSet.T6Options
,BaselineTIFFTagSet.TargetPrinter
,BaselineTIFFTagSet.Threshholding
,BaselineTIFFTagSet.TileByteCounts
,BaselineTIFFTagSet.TileLength
,BaselineTIFFTagSet.TileOffsets
,BaselineTIFFTagSet.TileWidth
,BaselineTIFFTagSet.TransferFunction
,BaselineTIFFTagSet.TransferRange
,BaselineTIFFTagSet.WhitePoint
,BaselineTIFFTagSet.XPosition
,BaselineTIFFTagSet.XResolution
,BaselineTIFFTagSet.YCbCrCoefficients
,BaselineTIFFTagSet.YCbCrPositioning
,BaselineTIFFTagSet.YCbCrSubSampling
,BaselineTIFFTagSet.YPosition
,BaselineTIFFTagSet.YResolution
,EXIFGPSTagSet.GPSAltitude
,EXIFGPSTagSet.GPSAltitudeRef
,EXIFGPSTagSet.GPSAreaInformation
,EXIFGPSTagSet.GPSDateStamp
,EXIFGPSTagSet.GPSDestBearing
,EXIFGPSTagSet.GPSDestBearingRef
,EXIFGPSTagSet.GPSDestDistance
,EXIFGPSTagSet.GPSDestDistanceRef
,EXIFGPSTagSet.GPSDestLatitude
,EXIFGPSTagSet.GPSDestLatitudeRef
,EXIFGPSTagSet.GPSDestLongitude
,EXIFGPSTagSet.GPSDestLongitudeRef
,EXIFGPSTagSet.GPSDifferential
,EXIFGPSTagSet.GPSDOP
,EXIFGPSTagSet.GPSImgDirection
,EXIFGPSTagSet.GPSImgDirectionRef
,EXIFGPSTagSet.GPSLatitude
,EXIFGPSTagSet.GPSLatitudeRef
,EXIFGPSTagSet.GPSLongitude
,EXIFGPSTagSet.GPSLongitudeRef
,EXIFGPSTagSet.GPSMapDatum
,EXIFGPSTagSet.GPSMeasureMode
,EXIFGPSTagSet.GPSProcessingMethod
,EXIFGPSTagSet.GPSSatellites
,EXIFGPSTagSet.GPSSpeed
,EXIFGPSTagSet.GPSSpeedRef
,EXIFGPSTagSet.GPSStatus
,EXIFGPSTagSet.GPSTimeStamp
,EXIFGPSTagSet.GPSTrack
,EXIFGPSTagSet.GPSTrackRef
,EXIFGPSTagSet.GPSVersionID
,EXIFInteroperabilityTagSet.InteroperabilityIndex
,EXIFParentTIFFTagSet.EXIFIFDPointer
,EXIFParentTIFFTagSet.GPSInfoIFDPointer
,EXIFTIFFTagSet.ApertureValue
,EXIFTIFFTagSet.BrightnessValue
,EXIFTIFFTagSet.CFAPattern
,EXIFTIFFTagSet.ColorSpace
,EXIFTIFFTagSet.ComponentsConfiguration
,EXIFTIFFTagSet.CompressedBitsPerPixel
,EXIFTIFFTagSet.Contrast
,EXIFTIFFTagSet.CustomRendered
,EXIFTIFFTagSet.DateTimeDigitized
,EXIFTIFFTagSet.DateTimeOriginal
,EXIFTIFFTagSet.DeviceSettingDescription
,EXIFTIFFTagSet.DigitalZoomRatio
,EXIFTIFFTagSet.EXIFVersion
,EXIFTIFFTagSet.ExposureBiasValue
,EXIFTIFFTagSet.ExposureIndex
,EXIFTIFFTagSet.ExposureMode
,EXIFTIFFTagSet.ExposureProgram
,EXIFTIFFTagSet.ExposureTime
,EXIFTIFFTagSet.FileSource
,EXIFTIFFTagSet.Flash
,EXIFTIFFTagSet.FlashEnergy
,EXIFTIFFTagSet.FlashPixVersion
,EXIFTIFFTagSet.FNumber
,EXIFTIFFTagSet.FocalLength
,EXIFTIFFTagSet.FocalLengthIn35mmFilm
,EXIFTIFFTagSet.FocalPlaneResolutionUnit
,EXIFTIFFTagSet.FocalPlaneXResolution
,EXIFTIFFTagSet.FocalPlaneYResolution
,EXIFTIFFTagSet.GainControl
,EXIFTIFFTagSet.ImageUniqueID
,EXIFTIFFTagSet.InteroperabilityIFD
,EXIFTIFFTagSet.ISOSpeedRatings
,EXIFTIFFTagSet.LightSource
,EXIFTIFFTagSet.MakerNote
,EXIFTIFFTagSet.MaxApertureValue
,EXIFTIFFTagSet.MeteringMode
,EXIFTIFFTagSet.OECF
,EXIFTIFFTagSet.PixelXDimension
,EXIFTIFFTagSet.PixelYDimension
,EXIFTIFFTagSet.RelatedSoundFile
,EXIFTIFFTagSet.Saturation
,EXIFTIFFTagSet.SceneCaptureType
,EXIFTIFFTagSet.SceneType
,EXIFTIFFTagSet.SensingMethod
,EXIFTIFFTagSet.Sharpness
,EXIFTIFFTagSet.ShutterSpeedValue
,EXIFTIFFTagSet.SpatialFrequencyResponse
,EXIFTIFFTagSet.SpectralSensitivity
,EXIFTIFFTagSet.SubjectArea
,EXIFTIFFTagSet.SubjectDistance
,EXIFTIFFTagSet.SubjectDistanceRange
,EXIFTIFFTagSet.SubjectLocation
,EXIFTIFFTagSet.SubSecTime
,EXIFTIFFTagSet.SubSecTimeDigitized
,EXIFTIFFTagSet.SubSecTimeOriginal
,EXIFTIFFTagSet.UserComment
,EXIFTIFFTagSet.WhiteBalance
,FaxTIFFTagSet.BadFaxLines
,FaxTIFFTagSet.CleanFaxData
,FaxTIFFTagSet.ConsecutiveBadFaxLines
,GeoTIFFTagSet.GeoAsciiParams
,GeoTIFFTagSet.GeoDoubleParams
,GeoTIFFTagSet.GeoKeyDirectory
,GeoTIFFTagSet.ModelPixelScale
,GeoTIFFTagSet.ModelTiePoint
,GeoTIFFTagSet.ModelTransformation
public class TIFFTag extends java.lang.Object
A class defining the notion of a TIFF tag. A TIFF tag is a key that may appear in an Image File Directory (IFD). In the IFD each tag has some data associated with it, which may consist of zero or more values of a given data type. The combination of a tag and a value is known as an IFD Entry or TIFF Field.The actual tag values used in the root IFD of a standard ("baseline") tiff stream are defined in the
class.BaselineTIFFTagSet
- See Also:
BaselineTIFFTagSet
,TIFFField
,TIFFTagSet
-
-
Field Summary
Fields Modifier and Type Field Description (package private) int
dataTypes
static int
MAX_DATATYPE
The numerically largest constant representing a TIFF data type.static int
MIN_DATATYPE
The numerically smallest constant representing a TIFF data type.(package private) java.lang.String
name
(package private) int
number
private static int[]
sizeOfType
(package private) TIFFTagSet
tagSet
static int
TIFF_ASCII
Flag for null-terminated ASCII strings.static int
TIFF_BYTE
Flag for 8 bit unsigned integers.static int
TIFF_DOUBLE
Flag for 64 bit IEEE doubles.static int
TIFF_FLOAT
Flag for 32 bit IEEE floats.static int
TIFF_IFD_POINTER
Flag for IFD pointer defined in TIFF Tech Note 1 in TIFF Specification Supplement 1.static int
TIFF_LONG
Flag for 32 bit unsigned integers.static int
TIFF_RATIONAL
Flag for pairs of 32 bit unsigned integers.static int
TIFF_SBYTE
Flag for 8 bit signed integers.static int
TIFF_SHORT
Flag for 16 bit unsigned integers.static int
TIFF_SLONG
Flag for 32 bit signed integers.static int
TIFF_SRATIONAL
Flag for pairs of 32 bit signed integers.static int
TIFF_SSHORT
Flag for 16 bit signed integers.static int
TIFF_UNDEFINED
Flag for 8 bit uninterpreted bytes.(package private) java.util.Map
valueNames
-
Constructor Summary
Constructors Constructor Description TIFFTag(java.lang.String name, int number, int dataTypes)
Constructs aTIFFTag
with a given name, tag number, and set of legal data types.TIFFTag(java.lang.String name, int number, int dataTypes, TIFFTagSet tagSet)
Constructs aTIFFTag
with a given name, tag number, set of legal data types, andTIFFTagSet
to which it refers.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addValueName(int value, java.lang.String name)
Adds a mnemonic name for a particular value that this tag's data may take on.int
getDataTypes()
Returns a bit mask indicating the set of data types that may be used to store the data associated with the tag.java.lang.String
getName()
Returns the name of the tag, as it will appear in image metadata.int
getNumber()
Returns the integer used to represent the tag.static int
getSizeOfType(int dataType)
Returns the number of bytes used to store a value of the given data type.TIFFTagSet
getTagSet()
Returns theTIFFTagSet
of which this tag is a part.java.lang.String
getValueName(int value)
Returns the mnemonic name associated with a particular value that this tag's data may take on, ornull
if no name is present.boolean
hasValueNames()
Returnstrue
if there are mnemonic names associated with the set of legal values for the data associated with this tag.boolean
isDataTypeOK(int dataType)
Returnstrue
if the given data type may be used for the data associated with this tag.boolean
isIFDPointer()
Returnstrue
if this tag is used to point to an IFD structure containing additional tags.
-
-
-
Field Detail
-
TIFF_BYTE
public static final int TIFF_BYTE
Flag for 8 bit unsigned integers.- See Also:
- Constant Field Values
-
TIFF_ASCII
public static final int TIFF_ASCII
Flag for null-terminated ASCII strings.- See Also:
- Constant Field Values
-
TIFF_SHORT
public static final int TIFF_SHORT
Flag for 16 bit unsigned integers.- See Also:
- Constant Field Values
-
TIFF_LONG
public static final int TIFF_LONG
Flag for 32 bit unsigned integers.- See Also:
- Constant Field Values
-
TIFF_RATIONAL
public static final int TIFF_RATIONAL
Flag for pairs of 32 bit unsigned integers.- See Also:
- Constant Field Values
-
TIFF_SBYTE
public static final int TIFF_SBYTE
Flag for 8 bit signed integers.- See Also:
- Constant Field Values
-
TIFF_UNDEFINED
public static final int TIFF_UNDEFINED
Flag for 8 bit uninterpreted bytes.- See Also:
- Constant Field Values
-
TIFF_SSHORT
public static final int TIFF_SSHORT
Flag for 16 bit signed integers.- See Also:
- Constant Field Values
-
TIFF_SLONG
public static final int TIFF_SLONG
Flag for 32 bit signed integers.- See Also:
- Constant Field Values
-
TIFF_SRATIONAL
public static final int TIFF_SRATIONAL
Flag for pairs of 32 bit signed integers.- See Also:
- Constant Field Values
-
TIFF_FLOAT
public static final int TIFF_FLOAT
Flag for 32 bit IEEE floats.- See Also:
- Constant Field Values
-
TIFF_DOUBLE
public static final int TIFF_DOUBLE
Flag for 64 bit IEEE doubles.- See Also:
- Constant Field Values
-
TIFF_IFD_POINTER
public static final int TIFF_IFD_POINTER
Flag for IFD pointer defined in TIFF Tech Note 1 in TIFF Specification Supplement 1.- See Also:
- Constant Field Values
-
MIN_DATATYPE
public static final int MIN_DATATYPE
The numerically smallest constant representing a TIFF data type.- See Also:
- Constant Field Values
-
MAX_DATATYPE
public static final int MAX_DATATYPE
The numerically largest constant representing a TIFF data type.- See Also:
- Constant Field Values
-
sizeOfType
private static final int[] sizeOfType
-
number
int number
-
name
java.lang.String name
-
dataTypes
int dataTypes
-
tagSet
TIFFTagSet tagSet
-
valueNames
java.util.Map valueNames
-
-
Constructor Detail
-
TIFFTag
public TIFFTag(java.lang.String name, int number, int dataTypes, TIFFTagSet tagSet)
Constructs aTIFFTag
with a given name, tag number, set of legal data types, andTIFFTagSet
to which it refers. ThetagSet
parameter will generally be non-null
only if thisTIFFTag
corresponds to a pointer to a TIFF IFD. In this casetagSet
will represent the set ofTIFFTag
s which appear in the IFD pointed to. ATIFFTag
represents an IFD pointer if and only iftagSet
is non-null
or the data typeTIFF_IFD_POINTER
is legal.If there are mnemonic names to be associated with the legal data values for the tag,
should be called on the new instance for each name.addValueName()
See the documentation for
for an explanation of how the set of data types is to be converted into a bit mask.getDataTypes()
- Parameters:
name
- the name of the tag; may benull
.number
- the number used to represent the tag.dataTypes
- a bit mask indicating the set of legal data types for this tag.tagSet
- theTIFFTagSet
to which this tag belongs; may benull
.
-
TIFFTag
public TIFFTag(java.lang.String name, int number, int dataTypes)
Constructs aTIFFTag
with a given name, tag number, and set of legal data types. The tag will have no associatedTIFFTagSet
.- Parameters:
name
- the name of the tag; may benull
.number
- the number used to represent the tag.dataTypes
- a bit mask indicating the set of legal data types for this tag.- See Also:
TIFFTag(String, int, int, TIFFTagSet)
-
-
Method Detail
-
getSizeOfType
public static int getSizeOfType(int dataType)
Returns the number of bytes used to store a value of the given data type.- Parameters:
dataType
- the data type to be queried.- Returns:
- the number of bytes used to store the given data type.
- Throws:
java.lang.IllegalArgumentException
- ifdatatype
is less thanMIN_DATATYPE
or greater thanMAX_DATATYPE
.
-
getName
public java.lang.String getName()
Returns the name of the tag, as it will appear in image metadata.- Returns:
- the tag name, as a
String
.
-
getNumber
public int getNumber()
Returns the integer used to represent the tag.- Returns:
- the tag number, as an
int
.
-
getDataTypes
public int getDataTypes()
Returns a bit mask indicating the set of data types that may be used to store the data associated with the tag. For example, a tag that can store both SHORT and LONG values would return a value of:(1 << TIFFTag.TIFF_SHORT) | (1 << TIFFTag.TIFF_LONG)
- Returns:
- an
int
containing a bitmask encoding the set of valid data types.
-
isDataTypeOK
public boolean isDataTypeOK(int dataType)
Returnstrue
if the given data type may be used for the data associated with this tag.- Parameters:
dataType
- the data type to be queried, one ofTIFF_BYTE
,TIFF_SHORT
, etc.- Returns:
- a
boolean
indicating whether the given data type may be used with this tag. - Throws:
java.lang.IllegalArgumentException
- ifdatatype
is less thanMIN_DATATYPE
or greater thanMAX_DATATYPE
.
-
getTagSet
public TIFFTagSet getTagSet()
Returns theTIFFTagSet
of which this tag is a part.- Returns:
- the containing
TIFFTagSet
.
-
isIFDPointer
public boolean isIFDPointer()
Returnstrue
if this tag is used to point to an IFD structure containing additional tags. This condition will be satisfied if and only if eithergetTagSet() != null
orisDataTypeOK(TIFF_IFD_POINTER) == true
.Many TIFF extensions use this mechanism in order to limit the number of new tags that may appear in the root IFD.
- Returns:
true
if this tag points to an IFD.
-
hasValueNames
public boolean hasValueNames()
Returnstrue
if there are mnemonic names associated with the set of legal values for the data associated with this tag.- Returns:
true
if mnemonic value names are available.
-
addValueName
protected void addValueName(int value, java.lang.String name)
Adds a mnemonic name for a particular value that this tag's data may take on.- Parameters:
value
- the data value.name
- the name to associate with the value.
-
getValueName
public java.lang.String getValueName(int value)
Returns the mnemonic name associated with a particular value that this tag's data may take on, ornull
if no name is present.- Parameters:
value
- the data value.- Returns:
- the mnemonic name associated with the value, as a
String
.
-
-