org.alfresco.service.cmr.repository

Interface TransformationSourceOptions

All Known Implementing Classes:

AbstractTransformationSourceOptions, CropSourceOptions, ImageCropOptions, PagedSourceOptions, TemporalSourceOptions

@AlfrescoPublicApi
public interface TransformationSourceOptions

Defines options and demarcations needed to describe the details of how the source should be transformed, independent of the target requirements.

See PagedSourceOptions for an example implementation that describes the page number that should be used from the source content.

Author:

Ray Gauss II

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TransformationSourceOptions.TransformationSourceOptionsSerializer Defines methods for serializing the source options into a parameter map and deserializing from a serialized options accessor.

Method Summary

Modifier and Type	Method and Description
List<String>	getApplicabledMimetypes() Deprecated. Use getApplicableMimetypes() instead.
List<String>	getApplicableMimetypes() Gets the list of applicable mimetypes
TransformationSourceOptions.TransformationSourceOptionsSerializer	getSerializer() Gets the serializer for the source options.
boolean	isApplicableForMimetype(String mimetype) Gets whether or not these transformation source options apply for the given mimetype
TransformationSourceOptions	mergedOptions(TransformationSourceOptions overridingOptions) Creates a new TransformationSourceOptions object from this one, merging any non-null overriding fields in the given overridingOptions

Method Detail

getApplicabledMimetypes

List<String> getApplicabledMimetypes()

Deprecated. Use getApplicableMimetypes() instead.

Gets the list of applicable mimetypes

Returns:

the applicable mimetypes

getApplicableMimetypes

List<String> getApplicableMimetypes()

Gets the list of applicable mimetypes

Returns:

the applicable mimetypes

isApplicableForMimetype

boolean isApplicableForMimetype(String mimetype)

Gets whether or not these transformation source options apply for the given mimetype

Parameters:

mimetype - the mimetype of the source

Returns:

if these transformation source options apply

mergedOptions

TransformationSourceOptions mergedOptions(TransformationSourceOptions overridingOptions)

Creates a new TransformationSourceOptions object from this one, merging any non-null overriding fields in the given overridingOptions

Parameters:

overridingOptions - TransformationSourceOptions

Returns:

a merged TransformationSourceOptions object

getSerializer

TransformationSourceOptions.TransformationSourceOptionsSerializer getSerializer()

Gets the serializer for the source options.

Returns:

the serializer