org.gytheio.content.transform.options

Interface TransformationOptions

All Superinterfaces:

Serializable

All Known Implementing Classes:

AudioTransformationOptions, ImageTransformationOptions, TransformationOptionsImpl, VideoTransformationOptions

public interface TransformationOptions
extends Serializable

Interface defining values of options that are passed to content transformers. These options are used during the transformation process to provide context or parameter values.

Author:

Roy Wetherall, Ray Gauss II

Method Summary

Methods

Modifier and Type	Method and Description
void	addSourceOptions(TransformationSourceOptions sourceOptions) Adds the given sourceOptions to the sourceOptionsMap.
Map<String,Serializable>	getAdditionalOptions() Gets the additional transformation options not explicitly modeled in an implementation.
Boolean	getIncludeEmbedded() If the source content includes embedded resources, should the transformer attempt to transform these as well? Not many transformers do support embedded resources, so this option will only affect those that can.
int	getPageLimit() Get the page limit before returning EOF.
<T extends TransformationSourceOptions> T	getSourceOptions(Class<T> clazz) Gets the appropriate source options for the given mimetype if available.
Map<Class<? extends TransformationSourceOptions>,TransformationSourceOptions>	getSourceOptionsMap() Gets the map of TransformationSourceOptions class to an object of that class holding the source options values.
long	getTimeoutMs() Gets the timeout (ms) on the InputStream after which an IOExecption is thrown to terminate very slow transformations or a subprocess is terminated (killed).
void	setAdditionalOptions(Map<String,Serializable> additionalOptions) Sets the additional transformation options not explicitly modeled in an implementation.
void	setIncludeEmbedded(Boolean includeEmbedded) If the source content includes embedded resources, should the transformer attempt to transform these as well? Not many transformers do support embedded resources, so this option will only affect those that can.
void	setPageLimit(int pageLimit) Set the number of pages read from the source before returning EOF.
void	setSourceOptionsList(Collection<TransformationSourceOptions> sourceOptionsList) Sets the list of source options further describing how the source should be transformed based on its mimetype.
void	setSourceOptionsMap(Map<Class<? extends TransformationSourceOptions>,TransformationSourceOptions> sourceOptionsMap) Sets the map of TransformationSourceOptions class to an object of that class holding the source options values.
void	setTimeoutMs(long timeoutMs) Sets a timeout (ms) on the InputStream after which an IOExecption is thrown to terminate very slow transformations or to terminate (kill) a subprocess.

Method Detail

getSourceOptionsMap

Map<Class<? extends TransformationSourceOptions>,TransformationSourceOptions> getSourceOptionsMap()

Gets the map of TransformationSourceOptions class to an object of that class holding the source options values.

Returns:

the source options map

setSourceOptionsMap

void setSourceOptionsMap(Map<Class<? extends TransformationSourceOptions>,TransformationSourceOptions> sourceOptionsMap)

Sets the map of TransformationSourceOptions class to an object of that class holding the source options values.

Parameters:

sourceOptionsMap -

setSourceOptionsList

void setSourceOptionsList(Collection<TransformationSourceOptions> sourceOptionsList)

Sets the list of source options further describing how the source should be transformed based on its mimetype.

Parameters:

sourceOptionsList - the source options list

getSourceOptions

<T extends TransformationSourceOptions> T getSourceOptions(Class<T> clazz)

Gets the appropriate source options for the given mimetype if available.

Parameters:

sourceMimetype -

Returns:

the source options for the mimetype

addSourceOptions

void addSourceOptions(TransformationSourceOptions sourceOptions)

Adds the given sourceOptions to the sourceOptionsMap.

Note that if source options of the same class already exists a new merged source options object is added.

Parameters:

sourceOptions -

getTimeoutMs

long getTimeoutMs()

Gets the timeout (ms) on the InputStream after which an IOExecption is thrown to terminate very slow transformations or a subprocess is terminated (killed).

Returns:

timeoutMs in milliseconds. If less than or equal to zero (the default) there is no timeout.

setTimeoutMs

void setTimeoutMs(long timeoutMs)

Sets a timeout (ms) on the InputStream after which an IOExecption is thrown to terminate very slow transformations or to terminate (kill) a subprocess.

Parameters:

timeoutMs - in milliseconds. If less than or equal to zero (the default) there is no timeout. If greater than zero the readLimitTimeMs must not be set.

getPageLimit

int getPageLimit()

Get the page limit before returning EOF.

Returns:

If less than or equal to zero (the default) no limit should be applied.

setPageLimit

void setPageLimit(int pageLimit)

Set the number of pages read from the source before returning EOF.

Parameters:

pageLimit - the number of pages to be read from the source. If less than or equal to zero (the default) no limit is applied.

setIncludeEmbedded

void setIncludeEmbedded(Boolean includeEmbedded)

If the source content includes embedded resources, should the transformer attempt to transform these as well? Not many transformers do support embedded resources, so this option will only affect those that can.

Parameters:

includeEmbedded - the include embedded flag.

getIncludeEmbedded

Boolean getIncludeEmbedded()

If the source content includes embedded resources, should the transformer attempt to transform these as well? Not many transformers do support embedded resources, so this option will only affect those that can.

Returns:

true, false, or null for the default for the transformer

getAdditionalOptions

Map<String,Serializable> getAdditionalOptions()

Gets the additional transformation options not explicitly modeled in an implementation.

Returns:

the additional options map

setAdditionalOptions

void setAdditionalOptions(Map<String,Serializable> additionalOptions)

Sets the additional transformation options not explicitly modeled in an implementation.

Parameters:

additionalOptions - the additional options map