org.alfresco.service.cmr.repository

Class TransformationOptions

java.lang.Object

org.alfresco.service.cmr.repository.TransformationOptions

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

ImageTransformationOptions, RuntimeExecutableContentTransformerOptions, SWFTransformationOptions

public class TransformationOptions
extends java.lang.Object
implements java.lang.Cloneable

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.

Since:

3.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPT_INCLUDE_EMBEDDED
static java.lang.String	OPT_SOURCE_CONTENT_PROPERTY
static java.lang.String	OPT_SOURCE_NODEREF Option map names to preserve backward compatibility
static java.lang.String	OPT_TARGET_CONTENT_PROPERTY
static java.lang.String	OPT_TARGET_NODEREF
static org.alfresco.service.cmr.repository.datatype.TypeConverter.Converter	relaxedBooleanTypeConverter

Constructor Summary

Constructors

Constructor and Description
TransformationOptions() Default constructor
TransformationOptions(java.util.Map optionsMap) Constructor.
TransformationOptions(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, org.alfresco.service.namespace.QName sourceContentProperty, org.alfresco.service.cmr.repository.NodeRef targetNodeRef, org.alfresco.service.namespace.QName targetContentProperty) Constructor
TransformationOptions(TransformationOptions options) Deep clone constructor

Method Summary

Methods

Modifier and Type	Method and Description
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
java.lang.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.
org.alfresco.service.namespace.QName	getSourceContentProperty() Get the source content property
org.alfresco.service.cmr.repository.NodeRef	getSourceNodeRef() Gets the source node reference
org.alfresco.service.namespace.QName	getTargetContentProperty() Get the target content property
org.alfresco.service.cmr.repository.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).
void	set(java.util.Map optionsMap) Sets options from the supplied map.
void	setIncludeEmbedded(java.lang.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(org.alfresco.service.namespace.QName sourceContentProperty) Set the source content property
void	setSourceNodeRef(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef) Set the source node reference
void	setTargetContentProperty(org.alfresco.service.namespace.QName targetContentProperty) Set the target content property
void	setTargetNodeRef(org.alfresco.service.cmr.repository.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.
java.util.Map	toMap() Convert the transformation options into a map.
java.lang.String	toString()
java.lang.String	toString(boolean includeLimits)

Methods inherited from class java.lang.Object

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

Field Detail

OPT_SOURCE_NODEREF

public static final java.lang.String OPT_SOURCE_NODEREF

Option map names to preserve backward compatibility

See Also:

Constant Field Values

OPT_SOURCE_CONTENT_PROPERTY

public static final java.lang.String OPT_SOURCE_CONTENT_PROPERTY

See Also:

Constant Field Values

OPT_TARGET_NODEREF

public static final java.lang.String OPT_TARGET_NODEREF

See Also:

Constant Field Values

OPT_TARGET_CONTENT_PROPERTY

public static final java.lang.String OPT_TARGET_CONTENT_PROPERTY

See Also:

Constant Field Values

OPT_INCLUDE_EMBEDDED

public static final java.lang.String OPT_INCLUDE_EMBEDDED

See Also:

Constant Field Values

relaxedBooleanTypeConverter

public static org.alfresco.service.cmr.repository.datatype.TypeConverter.Converter relaxedBooleanTypeConverter

Constructor Detail

TransformationOptions

public TransformationOptions()

Default constructor

TransformationOptions

public TransformationOptions(TransformationOptions options)

Deep clone constructor

TransformationOptions

public TransformationOptions(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
                     org.alfresco.service.namespace.QName sourceContentProperty,
                     org.alfresco.service.cmr.repository.NodeRef targetNodeRef,
                     org.alfresco.service.namespace.QName targetContentProperty)

Constructor

Parameters:

sourceNodeRef - the source node reference

sourceContentProperty - the source content property

targetNodeRef - the target node reference

targetContentProperty - the target content property

TransformationOptions

public TransformationOptions(java.util.Map optionsMap)

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

Parameters:

optionsMap - options map

Method Detail

clone

protected TransformationOptions clone()
                               throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

copyFrom

public void copyFrom(TransformationOptions otherOptions)

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

Parameters:

otherOptions - the options to copy

deepCopy

public TransformationOptions deepCopy()

Creates a clone of the TransformationOptions

Returns:

a copy of the options

set

public void set(java.util.Map optionsMap)

Sets options from the supplied map.

Parameters:

optionsMap -

setSourceNodeRef

public void setSourceNodeRef(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef)

Set the source node reference

Parameters:

sourceNodeRef - the source node reference

getSourceNodeRef

public org.alfresco.service.cmr.repository.NodeRef getSourceNodeRef()

Gets the source node reference

Returns:

NodeRef the source node reference

setSourceContentProperty

public void setSourceContentProperty(org.alfresco.service.namespace.QName sourceContentProperty)

Set the source content property

Parameters:

sourceContentProperty - the source content property

getSourceContentProperty

public org.alfresco.service.namespace.QName getSourceContentProperty()

Get the source content property

Returns:

the source content property

setTargetNodeRef

public void setTargetNodeRef(org.alfresco.service.cmr.repository.NodeRef targetNodeRef)

Set the taget node reference

Parameters:

targetNodeRef - the target node reference

getTargetNodeRef

public org.alfresco.service.cmr.repository.NodeRef getTargetNodeRef()

Get the target node reference

Returns:

the target node reference

setTargetContentProperty

public void setTargetContentProperty(org.alfresco.service.namespace.QName targetContentProperty)

Set the target content property

Parameters:

targetContentProperty - the target content property

getTargetContentProperty

public org.alfresco.service.namespace.QName getTargetContentProperty()

Get the target content property

Returns:

the target property

setIncludeEmbedded

public void setIncludeEmbedded(java.lang.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

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

getTimeoutMs

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

Returns:

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

setTimeoutMs

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.

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.

getReadLimitTimeMs

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.

Returns:

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

setReadLimitTimeMs

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.

Parameters:

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

Returns:

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.

Parameters:

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

getReadLimitKBytes

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.

Returns:

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

setReadLimitKBytes

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.

Parameters:

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

getMaxPages

public int getMaxPages()

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

Returns:

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

setMaxPages

public void setMaxPages(int maxPages)

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

Parameters:

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

getPageLimit

public 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

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

getLimits

public TransformationOptionLimits getLimits()

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

setLimits

public void setLimits(TransformationOptionLimits limits)

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

toMap

public java.util.Map toMap()

Convert the transformation options into a map.

Basic options (optional) are:

• TransformationOptions.OPT_SOURCE_NODEREF
• TransformationOptions.OPT_SOURCE_CONTENT_PROPERTY
• TransformationOptions.OPT_TARGET_NODEREF
• TransformationOptions.OPT_TARGET_CONTENT_PROPERTY
• TransformationOptions.OPT_INCLUDE_EMBEDDED
• TransformationOptionLimits.OPT_TIMEOUT_MS
• TransformationOptionLimits.OPT_READ_LIMIT_TIME_MS
• TransformationOptionLimits#OPT_MAX_SOURCE_SIZE_K_BYTES = "maxSourceSizeKBytes";
• {@link TransformationOptionLimits#OPT_READ_LIMIT_K_BYTES}
• {@link TransformationOptionLimits#OPT_MAX_PAGES}
• {@link TransformationOptionLimits#OPT_PAGE_LIMIT}

Override this method to append option values to the map. Derived classes should call the base class before appending further values and returning the result.

toString

public java.lang.String toString(boolean includeLimits)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object