com.github.geko444.im4java.core

Class Info

java.lang.Object

com.github.geko444.im4java.core.Info

public class Info
extends Object

This class implements an image-information object. The one-argument constructor expects a filename and parses the output of the "identify -verbose" command to create a hashtable of properties. This is the so called complete information. The two-argument constructor has a boolean flag as second argument. If you pass true, the Info-object only creates a set of so called basic information. This is more efficient since only a subset of the attributes of the image are requested and parsed.

Since the output of "identify -verbose" is meant as a human-readable interface and not for parsing, this class is inherently flawed. This implementation interprets every line with a colon as a key-value-pair. This is not necessarely correct, e.g. the comment-field could be multi-line with colons within the comment.

An alternative to the Info-class is to use the exiftool-command and the wrapper for it provided by im4java.

Since:

0.95

Version:

$Revision: 1.15 $

Author:

$Author: bablokb $

Constructor Summary

Constructors

Constructor and Description
Info(String pImage) This contstructor will automatically parse the full output of identify -verbose.
Info(String pImage, boolean basic) This constructor creates an Info-object with basic or complete image-information (depending on the second argument).
Info(String pImage, InputStream pInput) This contstructor will automatically parse the full output of identify -verbose.
Info(String pImage, InputStream pInput, boolean basic) This constructor creates an Info-object with basic or complete image-information (depending on the third argument).

Method Summary

Modifier and Type	Method and Description
String	getImageClass() Return the image class.
String	getImageClass(int pSceneNr) Return the image class for the given scene.
int	getImageDepth() Return the image depth.
int	getImageDepth(int pSceneNr) Return the image depth.
String	getImageFormat() Return the image format.
String	getImageFormat(int pSceneNr) Return the image format for the given scene.
String	getImageGeometry() Return the image geometry.
String	getImageGeometry(int pSceneNr) Return the image geometry for the given scene.
int	getImageHeight() Return the image height.
int	getImageHeight(int pSceneNr) Return the image height for the given scene.
int	getImageWidth() Return the image width.
int	getImageWidth(int pSceneNr) Return the image width for the given scene.
String	getPageGeometry() Return the page geometry.
String	getPageGeometry(int pSceneNr) Return the page geometry for the given scene.
int	getPageHeight() Return the page height.
int	getPageHeight(int pSceneNr) Return the page height for the given scene.
int	getPageWidth() Return the page width.
int	getPageWidth(int pSceneNr) Return the page width for the given scene.
String	getProperty(String pPropertyName) Return the given property.
String	getProperty(String pPropertyName, int pSceneNr) Return the given property of the given scene.
Enumeration<String>	getPropertyNames() Return an enumeration of all properties.
int	getSceneCount() Return the number of scenes.

Methods inherited from class java.lang.Object

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

Constructor Detail

Info

public Info(String pImage)
     throws InfoException

This contstructor will automatically parse the full output of identify -verbose.

Parameters:

pImage - Source image

Throws:

InfoException

Since:

0.95

Info

public Info(String pImage,
            InputStream pInput)
     throws InfoException

This contstructor will automatically parse the full output of identify -verbose. This version of the constructor expects an InputStream as an additional parameter. The source image-name should be either "-" or "format:-".

Parameters:

pImage - Name of the source-image

pInput - Image provided as an InputStream

Throws:

InfoException

Since:

1.4.0

Info

public Info(String pImage,
            boolean basic)
     throws InfoException

This constructor creates an Info-object with basic or complete image-information (depending on the second argument).

Parameters:

pImage - Source image

basic - Set to true for basic information, to false for complete info

Throws:

InfoException

Since:

1.2.0

Info

public Info(String pImage,
            InputStream pInput,
            boolean basic)
     throws InfoException

This constructor creates an Info-object with basic or complete image-information (depending on the third argument). This version of the constructor expects an InputStream as an additional parameter. The source image-name should be either "-" or "format:-".

Parameters:

pImage - Source image

basic - Set to true for basic information, to false for complete info

pInput - Image provided as an InputStream

Throws:

InfoException

Since:

1.4.0

Method Detail

getImageFormat

public String getImageFormat()

Return the image format.

getImageFormat

public String getImageFormat(int pSceneNr)

Return the image format for the given scene.

Parameters:

pSceneNr - Scene-number (zero-based)

Since:

1.3.0

getImageWidth

public int getImageWidth()
                  throws InfoException

Return the image width.

Throws:

InfoException

getImageWidth

public int getImageWidth(int pSceneNr)
                  throws InfoException

Return the image width for the given scene.

Parameters:

pSceneNr - Scene-number (zero-based)

Throws:

InfoException

Since:

1.3.0

getImageHeight

public int getImageHeight()
                   throws InfoException

Return the image height.

Throws:

InfoException

getImageHeight

public int getImageHeight(int pSceneNr)
                   throws InfoException

Return the image height for the given scene.

Parameters:

pSceneNr - Scene-number (zero-based)

Throws:

InfoException

Since:

1.3.0

getImageGeometry

public String getImageGeometry()

Return the image geometry.

getImageGeometry

public String getImageGeometry(int pSceneNr)

Return the image geometry for the given scene.

Parameters:

pSceneNr - Scene-number (zero-based)

Since:

1.3.0

getImageDepth

public int getImageDepth()
                  throws InfoException

Return the image depth. Note that this method just returns an integer (e.g. 8 or 16), and not a string ("8-bit") like getProperty("Depth") does.

Throws:

InfoException

Since:

1.3.0

getImageDepth

public int getImageDepth(int pSceneNr)
                  throws InfoException

Return the image depth. Note that this method just returns an integer (e.g. 8 or 16), and not a string ("8-bit") like getProperty("Depth") does.

Parameters:

pSceneNr - Scene-number (zero-based)

Throws:

InfoException

Since:

1.3.0

getImageClass

public String getImageClass()

Return the image class.

getImageClass

public String getImageClass(int pSceneNr)

Return the image class for the given scene.

Parameters:

pSceneNr - Scene-number (zero-based)

Since:

1.3.0

getPageWidth

public int getPageWidth()
                 throws InfoException

Return the page width.

Throws:

InfoException

Since:

1.3.0

getPageWidth

public int getPageWidth(int pSceneNr)
                 throws InfoException

Return the page width for the given scene.

Parameters:

pSceneNr - Scene-number (zero-based)

Throws:

InfoException

Since:

1.3.0

getPageHeight

public int getPageHeight()
                  throws InfoException

Return the page height.

Throws:

InfoException

Since:

1.3.0

getPageHeight

public int getPageHeight(int pSceneNr)
                  throws InfoException

Return the page height for the given scene.

Parameters:

pSceneNr - Scene-number (zero-based)

Throws:

InfoException

Since:

1.3.0

getPageGeometry

public String getPageGeometry()

Return the page geometry.

Since:

1.3.0

getPageGeometry

public String getPageGeometry(int pSceneNr)

Return the page geometry for the given scene.

Parameters:

pSceneNr - Scene-number (zero-based)

Since:

1.3.0

getProperty

public String getProperty(String pPropertyName)

Return the given property.

getProperty

public String getProperty(String pPropertyName,
                          int pSceneNr)

Return the given property of the given scene.

Parameters:

pPropertyName - Name of the property

pSceneNr - Scene-number (zero-based)

Since:

1.3.0

getSceneCount

public int getSceneCount()

Return the number of scenes.

Since:

1.3.0

getPropertyNames

public Enumeration<String> getPropertyNames()

Return an enumeration of all properties.