org.gytheio.content.transform

Class AbstractFileContentTransformerWorker

java.lang.Object

org.gytheio.content.AbstractContentWorker

org.gytheio.content.transform.AbstractContentTransformerWorker

org.gytheio.content.transform.AbstractFileContentTransformerWorker

All Implemented Interfaces:

org.gytheio.content.ContentWorker, ContentTransformerWorker

Direct Known Subclasses:

AbstractRuntimeExecContentTransformerWorker

public abstract class AbstractFileContentTransformerWorker
extends AbstractContentTransformerWorker

Extension of AbstractContentTransformerWorker for dealing with file content references

Author:

Ray Gauss II

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractFileContentTransformerWorker.FileContentReferencePair Wrapper for a content reference and a File, useful for passing around an already instantiated File object with a related content reference.

Field Summary

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
AbstractFileContentTransformerWorker()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.gytheio.content.ContentReference	createTargetContentReference(String mediaType) Creates a target content references using the targetContentReferenceHandler
protected File	createTempFile(org.gytheio.content.ContentReference contentReference) Creates a temp file from the given content reference
protected List<AbstractFileContentTransformerWorker.FileContentReferencePair>	getSourcePairs(List<org.gytheio.content.ContentReference> sources) Creates source pairs from the given source content references
protected List<AbstractFileContentTransformerWorker.FileContentReferencePair>	getTargetPairs(List<org.gytheio.content.ContentReference> targets) Creates target pairs from the given target content references
protected void	initializationTest(String sourcePath, String targetMediaType, TransformationOptions options) Tests that the worker is configured and working as expected.
protected boolean	isTempTargetUsed() Determines if the target content references must be managed via local temp file copies or can be managed directly.
List<org.gytheio.content.ContentWorkResult>	transform(List<org.gytheio.content.ContentReference> sources, List<org.gytheio.content.ContentReference> targets, TransformationOptions options, ContentTransformerWorkerProgressReporter progressReporter) Transforms the given source content references into the given target content references with the given options, reporting back via the given progress reporter.
List<org.gytheio.content.ContentWorkResult>	transform(List<org.gytheio.content.ContentReference> sources, String targetMediaType, TransformationOptions options, ContentTransformerWorkerProgressReporter progressReporter) Transforms the given source content references into target content references created by the worker based on the given media type with the given options, reporting back via the given progress reporter.
protected abstract List<File>	transformInternal(List<AbstractFileContentTransformerWorker.FileContentReferencePair> sources, List<AbstractFileContentTransformerWorker.FileContentReferencePair> targets, TransformationOptions options, ContentTransformerWorkerProgressReporter progressReporter) Transforms the given source file to the given target file and media type using the given transformation options and reports progress via the given progress reporter.

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

getExtension, initialize, setTargetContentReferenceHandler, toString

Methods inherited from class org.gytheio.content.AbstractContentWorker

getProperties, getVersionDetailsString, getVersionString, initializeVersionDetailsString, 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

Constructor Detail

AbstractFileContentTransformerWorker

public AbstractFileContentTransformerWorker()

Method Detail

getSourcePairs

protected List<AbstractFileContentTransformerWorker.FileContentReferencePair> getSourcePairs(List<org.gytheio.content.ContentReference> sources)
                                                                                      throws org.gytheio.content.ContentIOException,
                                                                                             InterruptedException,
                                                                                             IOException

Creates source pairs from the given source content references

Parameters:

sources -

Returns:

the source pairs

Throws:

org.gytheio.content.ContentIOException

InterruptedException

IOException

getTargetPairs

protected List<AbstractFileContentTransformerWorker.FileContentReferencePair> getTargetPairs(List<org.gytheio.content.ContentReference> targets)
                                                                                      throws org.gytheio.content.ContentIOException,
                                                                                             InterruptedException,
                                                                                             IOException

Creates target pairs from the given target content references

Parameters:

targets -

Returns:

the target pairs

Throws:

org.gytheio.content.ContentIOException

InterruptedException

IOException

isTempTargetUsed

protected boolean isTempTargetUsed()

Determines if the target content references must be managed via local temp file copies or can be managed directly.

Returns:

whether or not temp target files are used

transform

public List<org.gytheio.content.ContentWorkResult> transform(List<org.gytheio.content.ContentReference> sources,
                                                    List<org.gytheio.content.ContentReference> targets,
                                                    TransformationOptions options,
                                                    ContentTransformerWorkerProgressReporter progressReporter)
                                                      throws Exception

Description copied from interface: ContentTransformerWorker

Transforms the given source content references into the given target content references with the given options, reporting back via the given progress reporter.

Depending on the transformation being requested, multiple sources may be merged into a single target, a single source may be split into multiple targets, multiple sources may be transformed to multiple targets, etc. It is up to the caller to know what type of targets to expect.

Additionally, some implementations may not be able to transform into the targets specified or the number of targets may not be known before hand so implementations must return the final target references.

Use {@link #transform(List, String, TransformationOptions, ContentTransformerWorkerProgressReporter) to have the worker create the target content references.

Parameters:

sources - the list of source content references

targets - the list of target content references

Returns:

the final target references

Throws:

Exception

transform

public List<org.gytheio.content.ContentWorkResult> transform(List<org.gytheio.content.ContentReference> sources,
                                                    String targetMediaType,
                                                    TransformationOptions options,
                                                    ContentTransformerWorkerProgressReporter progressReporter)
                                                      throws Exception

Description copied from interface: ContentTransformerWorker

Transforms the given source content references into target content references created by the worker based on the given media type with the given options, reporting back via the given progress reporter.

Depending on the transformation being requested, multiple sources may be merged into a single target, a single source may be split into multiple targets, multiple sources may be transformed to multiple targets, etc. It is up to the caller to know what type of targets to expect.

Returns:

the final target references

Throws:

Exception

createTempFile

protected File createTempFile(org.gytheio.content.ContentReference contentReference)

Creates a temp file from the given content reference

Parameters:

contentReference -

Returns:

the temp file

transformInternal

protected abstract List<File> transformInternal(List<AbstractFileContentTransformerWorker.FileContentReferencePair> sources,
                           List<AbstractFileContentTransformerWorker.FileContentReferencePair> targets,
                           TransformationOptions options,
                           ContentTransformerWorkerProgressReporter progressReporter)
                                         throws Exception

Transforms the given source file to the given target file and media type using the given transformation options and reports progress via the given progress reporter.

Parameters:

sourceFiles -

sourceRefs -

targetFiles -

targetRefs -

options -

progressReporter -

Throws:

Exception

createTargetContentReference

protected org.gytheio.content.ContentReference createTargetContentReference(String mediaType)

Creates a target content references using the targetContentReferenceHandler

Parameters:

mediaType -

Returns:

the target content reference

initializationTest

protected void initializationTest(String sourcePath,
                      String targetMediaType,
                      TransformationOptions options)
                           throws Exception

Tests that the worker is configured and working as expected.

Parameters:

sourcePath -

targetMediaType -

options -

Throws:

Exception