com.easyinnova.tiff.model

Class TiffDocument

java.lang.Object

com.easyinnova.tiff.model.TiffDocument

All Implemented Interfaces:

Serializable

public class TiffDocument
extends Object
implements Serializable

Modeling of the TIFF file with methods to access its IFDs and metadata.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TiffDocument() Instantiates a new tiff file.

Method Summary

Modifier and Type	Method and Description
void	addIfd0(IFD ifd) Adds an IFD to the model.
boolean	addTag(String tagName, String tagValue) Adds the tag.
void	createMetadataDictionary() Creates the metadata dictionary.
ByteOrder	getEndianess() Gets the endianess.
boolean	getFatalError()
String	getFatalErrorMEssage()
IFD	getFirstIFD() Returns the first image of the file.
int	getFirstIFDOffset() Gets the first ifd offset.
IccProfile	getIccProfile()
int	getIfdAndSubIfdCount() Gets the count of IFDs and SubIFDs.
int	getIfdCount() Gets the ifd count.
int	getIfdImagesCount() Gets the images count (main images and thumbnails).
List<TiffObject>	getIfds() Returns a list of ifds including exifds.
List<TiffObject>	getIfdsAndSubIfds() Returns a list of subifds.
List<TiffObject>	getImageIfds() Returns a list of ifds representing Images.
int	getMagicNumber() Gets the magic number of the Tiff file.
int	getMainImagesCount() Gets the main images count.
Metadata	getMetadata() Gets the metadata.
List<TiffObject>	getMetadataList(String name) Gets the metadata ok a given class name.
String	getMetadataSingleString(String name) Gets an string with the value of the first tag matching the given tag name.
long	getSize() Gets the size.
int	getSubIfdCount() Gets the Subifd count.
List<TiffObject>	getSubIfds() Returns a list of subifds.
int	getThumbnailsImagesCount() Gets the thumbnails images count.
void	printMetadata() Prints the metadata.
boolean	removeTag(String tagName) Removes the tag.
void	setByteOrder(ByteOrder byteOrder) Sets the magic number of the Tiff file.
void	setFatalError(boolean error, String message)
void	setFirstIFDOffset(int offset) Sets the first ifd offset.
void	setMagicNumber(int magic) Sets the magic number of the Tiff file.
void	setSize(long size) Sets the size.

Methods inherited from class java.lang.Object

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

Constructor Detail

TiffDocument

public TiffDocument()

Instantiates a new tiff file.

Method Detail

addIfd0

public void addIfd0(IFD ifd)

Adds an IFD to the model.

Parameters:

ifd - the ifd

setFirstIFDOffset

public void setFirstIFDOffset(int offset)

Sets the first ifd offset.

Parameters:

offset - the new first ifd offset

getFirstIFDOffset

public int getFirstIFDOffset()

Gets the first ifd offset.

Returns:

the first ifd offset

setSize

public void setSize(long size)

Sets the size.

Parameters:

size - the new size

getFatalError

public boolean getFatalError()

getFatalErrorMEssage

public String getFatalErrorMEssage()

setFatalError

public void setFatalError(boolean error,
                          String message)

getIccProfile

public IccProfile getIccProfile()

getSize

public long getSize()

Gets the size.

Returns:

the size

getIfdCount

public int getIfdCount()

Gets the ifd count.

Returns:

the ifd count

getIfdImagesCount

public int getIfdImagesCount()

Gets the images count (main images and thumbnails).

Returns:

the ifd count

getMainImagesCount

public int getMainImagesCount()

Gets the main images count.

Returns:

the ifd count

getThumbnailsImagesCount

public int getThumbnailsImagesCount()

Gets the thumbnails images count.

Returns:

the ifd count

getSubIfdCount

public int getSubIfdCount()

Gets the Subifd count.

Returns:

the Subifd count

getIfdAndSubIfdCount

public int getIfdAndSubIfdCount()

Gets the count of IFDs and SubIFDs.

Returns:

the ifd count

getIfds

public List<TiffObject> getIfds()

Returns a list of ifds including exifds.

Returns:

the ifds list

getImageIfds

public List<TiffObject> getImageIfds()

Returns a list of ifds representing Images.

Returns:

the ifds list

getSubIfds

public List<TiffObject> getSubIfds()

Returns a list of subifds.

Returns:

the subifds list

getEndianess

public ByteOrder getEndianess()

Gets the endianess.

Returns:

the endianess

getIfdsAndSubIfds

public List<TiffObject> getIfdsAndSubIfds()

Returns a list of subifds.

Returns:

the subifds list

getFirstIFD

public IFD getFirstIFD()

Returns the first image of the file.

Returns:

image file d

getMagicNumber

public int getMagicNumber()

Gets the magic number of the Tiff file.

Returns:

the magic number

setMagicNumber

public void setMagicNumber(int magic)

Sets the magic number of the Tiff file.

Parameters:

magic - the new magic number

setByteOrder

public void setByteOrder(ByteOrder byteOrder)

Sets the magic number of the Tiff file.

Parameters:

byteOrder - the byte order

getMetadataSingleString

public String getMetadataSingleString(String name)

Gets an string with the value of the first tag matching the given tag name.

Parameters:

name - the tag name

Returns:

the metadata single string

getMetadataList

public List<TiffObject> getMetadataList(String name)

Gets the metadata ok a given class name.

Parameters:

name - the class name

Returns:

the list of metadata that matches with the class name

createMetadataDictionary

public void createMetadataDictionary()

Creates the metadata dictionary.

printMetadata

public void printMetadata()

Prints the metadata.

getMetadata

public Metadata getMetadata()

Gets the metadata.

Returns:

the metadata

removeTag

public boolean removeTag(String tagName)

Removes the tag.

Parameters:

tagName - the tag name

Returns:

true, if successful

addTag

public boolean addTag(String tagName,
                      String tagValue)

Adds the tag.

Parameters:

tagName - the tag name

tagValue - the tag value

Returns:

true, if successful