TransformationOptions (Alfresco 5.0.3 Public API)

org.alfresco.service.cmr.repository

Class TransformationOptions

org.alfresco.service.cmr.repository.TransformationOptions

All Implemented Interfaces:

Direct Known Subclasses:

public class TransformationOptions

Class containing values of options that are passed to content transformers. These options are used to determine the applicability of a content transformer and also during the transformation process to provide context or parameter values.

This base class provides some common, optional contextual information about the source and target nodes and properties used by the transformation.

Constructor Summary
TransformationOptions() Default constructor
TransformationOptions(Map<String,Object> optionsMap) Constructor.
TransformationOptions(NodeRef sourceNodeRef, QName sourceContentProperty, NodeRef targetNodeRef, QName targetContentProperty) Constructor
TransformationOptions(TransformationOptions options) Deep clone constructor

Method Summary
void	addSourceOptions(TransformationSourceOptions sourceOptions) Adds the given sourceOptions to the sourceOptionsMap.
protected TransformationOptions	clone()
void	copyFrom(TransformationOptions otherOptions) Does the work of copying the given other TransformationOptions values to this one
TransformationOptions	deepCopy() Creates a clone of the TransformationOptions
boolean	equals(Object obj)
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.
TransformationOptionLimits	getLimits() Returns max and limit values for time, size and pages in a single operation.
int	getMaxPages() Get the maximum number of pages read before an exception is thrown.
long	getMaxSourceSizeKBytes() Gets the maximum source content size, to skip transformations where the source is just too large to expect it to perform.
int	getPageLimit() Get the page limit before returning EOF.
long	getReadLimitKBytes() Gets the limit in terms of the about of data read to limit transformations where only the start of the content is needed.
long	getReadLimitTimeMs() Gets the limit in terms of the amount of data read (by time) to limit transformations where only the start of the content is needed.
QName	getSourceContentProperty() Get the source content property
NodeRef	getSourceNodeRef() Gets the source node reference
<T extends TransformationSourceOptions> T	getSourceOptions(Class<T> clazz) Gets the appropriate source options for the given mimetype if available.
Collection<TransformationSourceOptions>	getSourceOptionsList() Gets the immutable list of source options further describing how the source should be transformed based on its mimetype.
protected Map<Class<? extends TransformationSourceOptions>,TransformationSourceOptions>	getSourceOptionsMap() Gets the map of source options further describing how the source should be transformed based on its mimetype
QName	getTargetContentProperty() Get the target content property
NodeRef	getTargetNodeRef() Get the target node reference
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).
String	getUse() The use to which the transform will be put.
int	hashCode()
void	set(Map<String,Object> optionsMap) Sets options from the supplied map.
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	setLimits(TransformationOptionLimits limits) Sets max and limit values for time, size and pages in a single operation.
void	setMaxPages(int maxPages) Set the number of pages read from the source before an exception is thrown.
void	setMaxSourceSizeKBytes(long maxSourceSizeKBytes) Sets a maximum source content size, to skip transformations where the source is just too large to expect it to perform.
void	setPageLimit(int pageLimit) Set the number of pages read from the source before returning EOF.
void	setReadLimitKBytes(long readLimitKBytes) Sets a limit in terms of the about of data read to limit transformations where only the start of the content is needed.
void	setReadLimitTimeMs(long readLimitTimeMs) Sets a limit in terms of the amount of data read (by time) to limit transformations where only the start of the content is needed.
void	setSourceContentProperty(QName sourceContentProperty) Set the source content property
void	setSourceNodeRef(NodeRef sourceNodeRef) Set the source node reference
void	setSourceOptionsList(Collection<TransformationSourceOptions> sourceOptionsList) Sets the list of source options further describing how the source should be transformed based on its mimetype.
void	setTargetContentProperty(QName targetContentProperty) Set the target content property
void	setTargetNodeRef(NodeRef targetNodeRef) Set the taget node reference
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.
void	setUse(String use) The use to which the transform will be put.
Map<String,Object>	toMap() Convert the transformation options into a map.
String	toString()
String	toString(boolean includeLimits)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

OPT_INCLUDE_EMBEDDED

public static final String OPT_INCLUDE_EMBEDDED

OPT_SOURCE_CONTENT_PROPERTY

public static final String OPT_SOURCE_CONTENT_PROPERTY

public static final String OPT_SOURCE_NODEREF

Option map names to preserve backward compatibility

OPT_TARGET_CONTENT_PROPERTY

public static final String OPT_TARGET_CONTENT_PROPERTY

public static final String OPT_TARGET_NODEREF

public static final String OPT_USE

relaxedBooleanTypeConverter

public static TypeConverter.Converter<String,Boolean> relaxedBooleanTypeConverter

TransformationOptions

public TransformationOptions()

TransformationOptions

public TransformationOptions(TransformationOptions options)

Deep clone constructor

TransformationOptions

public TransformationOptions(NodeRef sourceNodeRef,
                             QName sourceContentProperty,
                             NodeRef targetNodeRef,
                             QName targetContentProperty)

sourceNodeRef - the source node reference

sourceContentProperty - the source content property

targetNodeRef - the target node reference

targetContentProperty - the target content property

TransformationOptions

public TransformationOptions(Map<String,Object> optionsMap)

Constructor. Creates a transformation options object from a map. Provided for back ward compatibility.

optionsMap - options map

clone in class Object

public void copyFrom(TransformationOptions otherOptions)

Does the work of copying the given other TransformationOptions values to this one

otherOptions - the options to copy

public TransformationOptions deepCopy()

Creates a clone of the TransformationOptions

a copy of the options

public void set(Map<String,Object> optionsMap)

Sets options from the supplied map.

public void setSourceNodeRef(NodeRef sourceNodeRef)

Set the source node reference

sourceNodeRef - the source node reference

public NodeRef getSourceNodeRef()

Gets the source node reference

NodeRef the source node reference

setSourceContentProperty

public void setSourceContentProperty(QName sourceContentProperty)

Set the source content property

sourceContentProperty - the source content property

getSourceContentProperty

public QName getSourceContentProperty()

Get the source content property

the source content property

public void setTargetNodeRef(NodeRef targetNodeRef)

Set the taget node reference

targetNodeRef - the target node reference

public NodeRef getTargetNodeRef()

Get the target node reference

the target node reference

setTargetContentProperty

public void setTargetContentProperty(QName targetContentProperty)

Set the target content property

targetContentProperty - the target content property

getTargetContentProperty

public QName getTargetContentProperty()

Get the target content property

public 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.

includeEmbedded - the include embedded flag.

public Boolean getIncludeEmbedded()

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

public void setUse(String use)

The use to which the transform will be put. Initially used to select different transformation limits depending on the use: "Index", "Preview"...

use - to which the transform will be put.

public String getUse()

The use to which the transform will be put. Initially used to select different transformation limits depending on the use: "Index", "Preview"...

the use - may be null

public 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).

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

public 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.

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.

public long getReadLimitTimeMs()

Gets the limit in terms of the amount of data read (by time) to limit transformations where only the start of the content is needed. After this limit is reached the InputStream reports end of file.

readLimitBytes if less than or equal to zero (the default) there is no limit.

public void setReadLimitTimeMs(long readLimitTimeMs)

Sets a limit in terms of the amount of data read (by time) to limit transformations where only the start of the content is needed. After this limit is reached the InputStream reports end of file.

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

getMaxSourceSizeKBytes

public long getMaxSourceSizeKBytes()

Gets the maximum source content size, to skip transformations where the source is just too large to expect it to perform. If the source is larger the transformer indicates it is not available.

maxSourceSizeKBytes if less than or equal to zero (the default) there is no limit.

setMaxSourceSizeKBytes

public void setMaxSourceSizeKBytes(long maxSourceSizeKBytes)

Sets a maximum source content size, to skip transformations where the source is just too large to expect it to perform. If the source is larger the transformer indicates it is not available.

maxSourceSizeKBytes - if less than or equal to zero (the default) there is no limit. If greater than zero the readLimitKBytes must not be set.

public long getReadLimitKBytes()

Gets the limit in terms of the about of data read to limit transformations where only the start of the content is needed. After this limit is reached the InputStream reports end of file.

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

public void setReadLimitKBytes(long readLimitKBytes)

Sets a limit in terms of the about of data read to limit transformations where only the start of the content is needed. After this limit is reached the InputStream reports end of file.

readLimitKBytes - if less than or equal to zero (the default) there is no limit. If greater than zero the maxSourceSizeKBytes must not be set.

public int getMaxPages()

Get the maximum number of pages read before an exception is thrown.

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

public void setMaxPages(int maxPages)

Set the number of pages read from the source before an exception is thrown.

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

public int getPageLimit()

Get the page limit before returning EOF.

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

public void setPageLimit(int pageLimit)

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

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

public TransformationOptionLimits getLimits()

Returns max and limit values for time, size and pages in a single operation.

public void setLimits(TransformationOptionLimits limits)

Sets max and limit values for time, size and pages in a single operation.

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

Gets the map of source options further describing how the source should be transformed based on its mimetype

the source mimetype to source options map

getSourceOptionsList

public Collection<TransformationSourceOptions> getSourceOptionsList()

Gets the immutable list of source options further describing how the source should be transformed based on its mimetype. Use addSourceOptions(TransformationSourceOptions) to add source options.

the source options list

setSourceOptionsList

public void setSourceOptionsList(Collection<TransformationSourceOptions> sourceOptionsList)

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

sourceOptionsList - the source options list

public 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.

sourceOptions - TransformationSourceOptions

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

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

the source options for the mimetype

public Map<String,Object> toMap()

public String toString(boolean includeLimits)

public String toString()

toString in class Object

public int hashCode()

hashCode in class Object

public boolean equals(Object obj)

equals in class Object

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.

Field Summary
static String	OPT_INCLUDE_EMBEDDED
static String	OPT_SOURCE_CONTENT_PROPERTY
static String	OPT_SOURCE_NODEREF Option map names to preserve backward compatibility
static String	OPT_TARGET_CONTENT_PROPERTY
static String	OPT_TARGET_NODEREF
static String	OPT_USE
static TypeConverter.Converter<String,Boolean>	relaxedBooleanTypeConverter