org.gytheio.content.transform

Class AbstractRuntimeExecContentTransformerWorker

java.lang.Object

org.gytheio.content.AbstractContentWorker

org.gytheio.content.transform.AbstractContentTransformerWorker

org.gytheio.content.transform.AbstractFileContentTransformerWorker

org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker

All Implemented Interfaces:

org.gytheio.content.ContentWorker, ContentTransformerWorker

public abstract class AbstractRuntimeExecContentTransformerWorker
extends AbstractFileContentTransformerWorker

Base class that uses a command line RuntimeExec to perform the transform

Author:

Ray Gauss II

Nested Class Summary

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

AbstractFileContentTransformerWorker.FileContentReferencePair

Field Summary

Fields

Modifier and Type	Field and Description
protected org.gytheio.util.exec.RuntimeExec	executer the system command executer
protected org.gytheio.util.exec.RuntimeExec	fileDetailsExecuter optional file details executer
protected static String	VAR_SOURCE source variable name
protected static String	VAR_TARGET target variable name
protected org.gytheio.util.exec.RuntimeExec	versionDetailsExecuter the check command executer

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
AbstractRuntimeExecContentTransformerWorker() Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
String	getDetails(File file) Optional method for implementations able to return details of a file which will vary greatly depending on the file type and implementation.
protected abstract void	initializationTest() Perform a transformation that verifies the executer is installed and configured correctly
void	initialize() Checks for the JMagick and ImageMagick dependencies, using the common transformation method to check that the sample image can be converted.
protected abstract void	initializeExecuter() Perform any initialization needed for the primary executer including creating if null
protected abstract void	initializeFileDetailsExecuter() Perform any initialization needed for the file details executer including creating if null
protected abstract void	initializeVersionDetailsExecuter() Perform any initialization needed for the version details executer including creating if null
protected void	initializeVersionDetailsString()
void	setExecuter(org.gytheio.util.exec.RuntimeExec executer) Set the runtime command executer that must be executed.
void	setVersionDetailsExecuter(org.gytheio.util.exec.RuntimeExec versionDetailsExecuter) Sets the command that must be executed in order to retrieve version information from the converting executable and thus test that the executable itself is present.

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

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

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.transform.ContentTransformerWorker

isTransformable

Methods inherited from interface org.gytheio.content.ContentWorker

getVersionDetailsString, getVersionString, isAvailable

Field Detail

VAR_SOURCE

protected static final String VAR_SOURCE

source variable name

See Also:

Constant Field Values

VAR_TARGET

protected static final String VAR_TARGET

target variable name

See Also:

Constant Field Values

executer

protected org.gytheio.util.exec.RuntimeExec executer

the system command executer

versionDetailsExecuter

protected org.gytheio.util.exec.RuntimeExec versionDetailsExecuter

the check command executer

fileDetailsExecuter

protected org.gytheio.util.exec.RuntimeExec fileDetailsExecuter

optional file details executer

Constructor Detail

AbstractRuntimeExecContentTransformerWorker

public AbstractRuntimeExecContentTransformerWorker()

Default constructor

Method Detail

setExecuter

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

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

Parameters:

executer - the system command executer

setVersionDetailsExecuter

public void setVersionDetailsExecuter(org.gytheio.util.exec.RuntimeExec versionDetailsExecuter)

Sets the command that must be executed in order to retrieve version information from the converting executable and thus test that the executable itself is present.

Parameters:

versionDetailsExecuter - command executer to retrieve version information

initializeExecuter

protected abstract void initializeExecuter()

Perform any initialization needed for the primary executer including creating if null

initializeVersionDetailsExecuter

protected abstract void initializeVersionDetailsExecuter()

Perform any initialization needed for the version details executer including creating if null

initializeFileDetailsExecuter

protected abstract void initializeFileDetailsExecuter()

Perform any initialization needed for the file details executer including creating if null

initializationTest

protected abstract void initializationTest()

Perform a transformation that verifies the executer is installed and configured correctly

initialize

public void initialize()

Checks for the JMagick and ImageMagick dependencies, using the common transformation method to check that the sample image can be converted.

Overrides:

initialize in class AbstractContentTransformerWorker

initializeVersionDetailsString

protected void initializeVersionDetailsString()

Overrides:

initializeVersionDetailsString in class org.gytheio.content.AbstractContentWorker

getDetails

public String getDetails(File file)
                  throws Exception

Optional method for implementations able to return details of a file which will vary greatly depending on the file type and implementation.

Parameters:

file -

Returns:

a simple string of file detail output

Throws:

Exception