org.gytheio.content.transform.options

Class TransformationOptionsImpl

java.lang.Object

org.gytheio.content.transform.options.TransformationOptionsImpl

All Implemented Interfaces:

Serializable, TransformationOptions, org.gytheio.util.Mergable<TransformationOptions>

Direct Known Subclasses:

AudioTransformationOptions, ImageTransformationOptions

public class TransformationOptionsImpl
extends Object
implements TransformationOptions, org.gytheio.util.Mergable<TransformationOptions>

Concrete implementation of transformation options

Author:

Ray Gauss II

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TransformationOptionsImpl()
TransformationOptionsImpl(TransformationOptionsImpl origOptions)

Method Summary

Methods

Modifier and Type	Method and Description
void	addSourceOptions(TransformationSourceOptions sourceOptions) Adds the given sourceOptions to the sourceOptionsMap.
protected Map<Class<? extends TransformationSourceOptions>,TransformationSourceOptions>	deepCopySourceOptionsMap(Map<Class<? extends TransformationSourceOptions>,TransformationSourceOptions> origMap)
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	merge(TransformationOptions override)
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.
String	toString()
protected String	toStringSourceOptions() Builds the source options to string.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformationOptionsImpl

public TransformationOptionsImpl()

TransformationOptionsImpl

public TransformationOptionsImpl(TransformationOptionsImpl origOptions)

Method Detail

merge

public void merge(TransformationOptions override)

Specified by:

merge in interface org.gytheio.util.Mergable<TransformationOptions>

deepCopySourceOptionsMap

protected Map<Class<? extends TransformationSourceOptions>,TransformationSourceOptions> deepCopySourceOptionsMap(Map<Class<? extends TransformationSourceOptions>,TransformationSourceOptions> origMap)

getSourceOptionsMap

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

Description copied from interface: TransformationOptions

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

Specified by:

getSourceOptionsMap in interface TransformationOptions

Returns:

the source options map

setSourceOptionsMap

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

Description copied from interface: TransformationOptions

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

Specified by:

setSourceOptionsMap in interface TransformationOptions

setSourceOptionsList

public void setSourceOptionsList(Collection<TransformationSourceOptions> sourceOptionsList)

Description copied from interface: TransformationOptions

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

Specified by:

setSourceOptionsList in interface TransformationOptions

Parameters:

sourceOptionsList - the source options list

getSourceOptions

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

Description copied from interface: TransformationOptions

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

Specified by:

getSourceOptions in interface TransformationOptions

Returns:

the source options for the mimetype

addSourceOptions

public void addSourceOptions(TransformationSourceOptions sourceOptions)

Description copied from interface: TransformationOptions

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.

Specified by:

addSourceOptions in interface TransformationOptions

getTimeoutMs

public long getTimeoutMs()

Description copied from interface: TransformationOptions

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

Specified by:

getTimeoutMs in interface TransformationOptions

Returns:

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

setTimeoutMs

public void setTimeoutMs(long timeoutMs)

Description copied from interface: TransformationOptions

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

Specified by:

setTimeoutMs in interface TransformationOptions

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

public int getPageLimit()

Description copied from interface: TransformationOptions

Get the page limit before returning EOF.

Specified by:

getPageLimit in interface TransformationOptions

Returns:

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

setPageLimit

public void setPageLimit(int pageLimit)

Description copied from interface: TransformationOptions

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

Specified by:

setPageLimit in interface TransformationOptions

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

public void setIncludeEmbedded(Boolean includeEmbedded)

Description copied from interface: TransformationOptions

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.

Specified by:

setIncludeEmbedded in interface TransformationOptions

Parameters:

includeEmbedded - the include embedded flag.

getIncludeEmbedded

public Boolean getIncludeEmbedded()

Description copied from interface: TransformationOptions

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.

Specified by:

getIncludeEmbedded in interface TransformationOptions

Returns:

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

getAdditionalOptions

public Map<String,Serializable> getAdditionalOptions()

Description copied from interface: TransformationOptions

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

Specified by:

getAdditionalOptions in interface TransformationOptions

Returns:

the additional options map

setAdditionalOptions

public void setAdditionalOptions(Map<String,Serializable> additionalOptions)

Description copied from interface: TransformationOptions

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

Specified by:

setAdditionalOptions in interface TransformationOptions

Parameters:

additionalOptions - the additional options map

toStringSourceOptions

protected String toStringSourceOptions()

Builds the source options to string.

We can't rely on a framework here because we need full serialization for messaging.

Returns:

the source options toString

toString

public String toString()

Overrides:

toString in class Object