com.highqsoft.moma.rules.mapping

Class ExiftoolSupport

java.lang.Object

com.highqsoft.moma.rules.mapping.ExiftoolSupport

public class ExiftoolSupport
extends java.lang.Object

Class used to provide a Java-like interface to Phil Harvey's excellent, Perl-based ExifTool.

This class was created on bases of class ExifTool from Riyad Kalla (software@thebuzzmedia.com). The wrapper from Riyad Kalla was not used, because the wrapper only supports a fixed list of file properties. A test with 'avi' files returned only the attributes: 'ImageWidth' and 'ImageHeight'. The exiftool retrieves much more attributes.

Usage

Assuming ExifTool is installed on the host system correctly and either in the system path or pointed to by EXIF_TOOL_PATH, using this class to communicate with ExifTool is as simple as creating an instance ( ExifToolSupport tool = new ExifToolSupport()) and then making calls to getImageMeta(File), a map with key / value pairs will be returned.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExiftoolSupport.Format Enum used to define the 2 different output formats that Tag values can be returned in: numeric or human-readable text.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXIF_TOOL_PATH The absolute path to the ExifTool executable on the host system running this class as defined by the "exiftool.path" system property.
protected java.util.logging.Logger	log
protected static java.util.regex.Pattern	TAG_VALUE_PATTERN Compiled Pattern of ": " used to split compact output from ExifTool evenly into name/value pairs.

Constructor Summary

Constructors

Constructor and Description
ExiftoolSupport(java.util.logging.Logger logger) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getImageMeta(java.io.File filename)
java.util.Map<java.lang.String,java.lang.String>	getImageMeta(java.io.File filename, ExiftoolSupport.Format exiftoolOutputFormat)
protected com.highqsoft.moma.rules.mapping.ExiftoolSupport.IOStream	startExifToolProcess(java.util.List<java.lang.String> args)

Methods inherited from class java.lang.Object

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

Field Detail

EXIF_TOOL_PATH

public static final java.lang.String EXIF_TOOL_PATH

The absolute path to the ExifTool executable on the host system running this class as defined by the "exiftool.path" system property.

If ExifTool is on your system path and running the command "exiftool" successfully executes it, leaving this value unchanged will work fine on any platform. If the ExifTool executable is named something else or not in the system path, then this property will need to be set to point at it before using this class.

This system property can be set on startup with:
-Dexiftool.path=/path/to/exiftool or by calling System.setProperty(String, String) before this class is loaded.

On Windows be sure to double-escape the path to the tool, for example: -Dexiftool.path=C:\\Tools\\exiftool.exe

Default value is "exiftool".

Relative Paths

Relative path values (e.g. "bin/tools/exiftool") are executed with relation to the base directory the VM process was started in. Essentially the directory that new File(".").getAbsolutePath() points at during runtime.

TAG_VALUE_PATTERN

protected static final java.util.regex.Pattern TAG_VALUE_PATTERN

Compiled Pattern of ": " used to split compact output from ExifTool evenly into name/value pairs.

log

protected java.util.logging.Logger log

Constructor Detail

ExiftoolSupport

public ExiftoolSupport(java.util.logging.Logger logger)

Constructor

Parameters:

logger, - instance of the Logger class

Method Detail

startExifToolProcess

protected com.highqsoft.moma.rules.mapping.ExiftoolSupport.IOStream startExifToolProcess(java.util.List<java.lang.String> args)
                                                                                  throws java.lang.RuntimeException

Throws:

java.lang.RuntimeException

getImageMeta

public java.util.Map<java.lang.String,java.lang.String> getImageMeta(java.io.File filename)
                                                              throws java.lang.IllegalArgumentException,
                                                                     java.lang.SecurityException,
                                                                     java.io.IOException

Parameters:

filename - of the file, which attributes should be read

Returns:

a map with the found attributes.

Throws:

java.lang.IllegalArgumentException

java.lang.SecurityException

java.io.IOException

getImageMeta

public java.util.Map<java.lang.String,java.lang.String> getImageMeta(java.io.File filename,
                                                            ExiftoolSupport.Format exiftoolOutputFormat)
                                                              throws java.lang.IllegalArgumentException,
                                                                     java.lang.SecurityException,
                                                                     java.io.IOException

Parameters:

filename - of the file, which attributes should be read

exiftoolOutputFormat - the format, which sould exiftool user for output. valid: Format.NUMERIC or Format.HUMAN_READABLE

Returns:

a map with the found attributes.

Throws:

java.lang.IllegalArgumentException

java.lang.SecurityException

java.io.IOException