org.gytheio.content.transform.imagemagick

Class ImageMagickContentTransformerWorker

java.lang.Object

org.gytheio.content.AbstractContentWorker

org.gytheio.content.transform.AbstractContentTransformerWorker

org.gytheio.content.transform.AbstractFileContentTransformerWorker

org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker

org.gytheio.content.transform.imagemagick.ImageMagickContentTransformerWorker

All Implemented Interfaces:

org.gytheio.content.ContentWorker, org.gytheio.content.transform.ContentTransformerWorker

public class ImageMagickContentTransformerWorker
extends org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker

Executes a statement to implement

Author:

Derek Hulley

Nested Class Summary

Nested classes/interfaces inherited from class org.gytheio.content.transform.AbstractFileContentTransformerWorker

org.gytheio.content.transform.AbstractFileContentTransformerWorker.FileContentReferencePair

Field Summary

Fields inherited from class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker

executer, fileDetailsExecuter, VAR_SOURCE, VAR_TARGET, versionDetailsExecuter

Fields inherited from class org.gytheio.content.transform.AbstractContentTransformerWorker

targetContentReferenceHandler

Fields inherited from class org.gytheio.content.AbstractContentWorker

FRAMEWORK_PROPERTY_NAME, FRAMEWORK_PROPERTY_VERSION, sourceContentReferenceHandler, versionDetailsString, versionString

Constructor Summary

Constructors

Constructor and Description
ImageMagickContentTransformerWorker() Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected List<File>	getMultipleTargetSiblings(File targetFile) Gets the any siblings in the same directory as the targetFile with the same name prefix used by ImageMagick for multiple outputs.
protected void	initializationTest()
protected void	initializeExecuter()
protected void	initializeFileDetailsExecuter()
protected void	initializeVersionDetailsExecuter()
protected boolean	isSupported(String mediaType) Some image formats are not supported by ImageMagick, or at least appear not to work.
boolean	isTransformable(List<String> sourceMediaTypes, String targetMediaType, org.gytheio.content.transform.options.TransformationOptions options)
void	setExecuter(org.gytheio.util.exec.RuntimeExec executer) Set the runtime command executer that must be executed in order to run ImageMagick.
protected void	singleTransformInternal(org.gytheio.content.transform.AbstractFileContentTransformerWorker.FileContentReferencePair sourcePair, org.gytheio.content.transform.AbstractFileContentTransformerWorker.FileContentReferencePair targetPair, org.gytheio.content.transform.options.TransformationOptions options, org.gytheio.content.transform.ContentTransformerWorkerProgressReporter progressReporter) Transform the image content from the source file to the target file.
protected List<File>	transformInternal(List<org.gytheio.content.transform.AbstractFileContentTransformerWorker.FileContentReferencePair> sourcePairs, List<org.gytheio.content.transform.AbstractFileContentTransformerWorker.FileContentReferencePair> targetPairs, org.gytheio.content.transform.options.TransformationOptions options, org.gytheio.content.transform.ContentTransformerWorkerProgressReporter progressReporter)

Methods inherited from class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker

getDetails, initialize, initializeVersionDetailsString, setVersionDetailsExecuter

Methods inherited from class org.gytheio.content.transform.AbstractFileContentTransformerWorker

createTargetContentReference, createTempFile, getSourcePairs, getTargetPairs, initializationTest, isTempTargetUsed, transform, transform

Methods inherited from class org.gytheio.content.transform.AbstractContentTransformerWorker

getExtension, setTargetContentReferenceHandler, toString

Methods inherited from class org.gytheio.content.AbstractContentWorker

getProperties, getVersionDetailsString, getVersionString, initializeVersionString, isAvailable, loadProperties, setIsAvailable, setSourceContentReferenceHandler

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gytheio.content.ContentWorker

getVersionDetailsString, getVersionString, isAvailable

Constructor Detail

ImageMagickContentTransformerWorker

public ImageMagickContentTransformerWorker()

Default constructor

Method Detail

setExecuter

public void setExecuter(org.gytheio.util.exec.RuntimeExec executer)

Set the runtime command executer that must be executed in order to run ImageMagick. Whether or not this is the full path to the convertCommand or just the convertCommand itself depends the environment setup.

The command must contain the variables ${source} and ${target}, which will be replaced by the names of the file to be transformed and the name of the output file respectively.

    convert ${source} ${target}
 

Overrides:

setExecuter in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker

Parameters:

executer - the system command executer

initializeExecuter

protected void initializeExecuter()

Specified by:

initializeExecuter in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker

initializeVersionDetailsExecuter

protected void initializeVersionDetailsExecuter()

Specified by:

initializeVersionDetailsExecuter in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker

initializeFileDetailsExecuter

protected void initializeFileDetailsExecuter()

Specified by:

initializeFileDetailsExecuter in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker

initializationTest

protected void initializationTest()

Specified by:

initializationTest in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker

isSupported

protected boolean isSupported(String mediaType)

Some image formats are not supported by ImageMagick, or at least appear not to work.

Parameters:

mediaType - the mimetype to check

Returns:

Returns true if ImageMagic can handle the given image format

isTransformable

public boolean isTransformable(List<String> sourceMediaTypes,
                      String targetMediaType,
                      org.gytheio.content.transform.options.TransformationOptions options)

transformInternal

protected List<File> transformInternal(List<org.gytheio.content.transform.AbstractFileContentTransformerWorker.FileContentReferencePair> sourcePairs,
                           List<org.gytheio.content.transform.AbstractFileContentTransformerWorker.FileContentReferencePair> targetPairs,
                           org.gytheio.content.transform.options.TransformationOptions options,
                           org.gytheio.content.transform.ContentTransformerWorkerProgressReporter progressReporter)
                                throws Exception

Specified by:

transformInternal in class org.gytheio.content.transform.AbstractFileContentTransformerWorker

Throws:

Exception

singleTransformInternal

protected void singleTransformInternal(org.gytheio.content.transform.AbstractFileContentTransformerWorker.FileContentReferencePair sourcePair,
                           org.gytheio.content.transform.AbstractFileContentTransformerWorker.FileContentReferencePair targetPair,
                           org.gytheio.content.transform.options.TransformationOptions options,
                           org.gytheio.content.transform.ContentTransformerWorkerProgressReporter progressReporter)
                                throws Exception

Transform the image content from the source file to the target file.

Note that ImageMagick may create multiple outputs for paged file types if no page limit or paged source options are present in the transformation options to constrain that behavior.

Parameters:

sourcePair -

targetPair -

options -

progressReporter -

Throws:

Exception

getMultipleTargetSiblings

protected List<File> getMultipleTargetSiblings(File targetFile)

Gets the any siblings in the same directory as the targetFile with the same name prefix used by ImageMagick for multiple outputs.

For example, when requesting a conversion of a 2 page PDF to JPEG: convert source.pdf result.jpg ImageMagick will create: result-0.jpg result-1.jpg

Parameters:

targetFile -

Returns:

the list of siblings with the same name prefix as the target file