org.gytheio.content.transform

Interface ContentTransformerWorker

All Superinterfaces:

org.gytheio.content.ContentWorker

All Known Implementing Classes:

AbstractContentTransformerWorker, AbstractFileContentTransformerWorker, AbstractRuntimeExecContentTransformerWorker

public interface ContentTransformerWorker
extends org.gytheio.content.ContentWorker

Defines the methods responsible for doing the work of transformation of a content reference

Author:

Ray Gauss II

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isTransformable(List<String> sourceMediaTypes, String targetMediaType, TransformationOptions options) Determines whether or not the worker can handle the transformation from the given source media types to the given target media type with the given options.
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.

Methods inherited from interface org.gytheio.content.ContentWorker

getVersionDetailsString, getVersionString, isAvailable

Method Detail

transform

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

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

options -

progressReporter -

Returns:

the final target references

Throws:

Exception

transform

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

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.

Parameters:

sources -

targetMediaType -

options -

progressReporter -

Returns:

the final target references

Throws:

Exception

isTransformable

boolean isTransformable(List<String> sourceMediaTypes,
                      String targetMediaType,
                      TransformationOptions options)

Determines whether or not the worker can handle the transformation from the given source media types to the given target media type with the given options.

Parameters:

sourceMediaTypes -

targetMediaType -

options -

Returns:

if the worker can perform the transformation