params)
+ {
+ if (paramValue != null)
+ {
+ params.put(paramName, paramValue);
+ }
+ }
+
+}
diff --git a/source/java/org/alfresco/service/cmr/repository/PagedSourceOptions.java b/source/java/org/alfresco/service/cmr/repository/PagedSourceOptions.java
new file mode 100644
index 0000000000..ca48a47878
--- /dev/null
+++ b/source/java/org/alfresco/service/cmr/repository/PagedSourceOptions.java
@@ -0,0 +1,203 @@
+/*
+ * Copyright (C) 2005-2013 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see .
+ */
+package org.alfresco.service.cmr.repository;
+
+import java.io.Serializable;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+import org.alfresco.repo.content.MimetypeMap;
+import org.alfresco.service.cmr.repository.AbstractTransformationSourceOptions;
+
+/**
+ * Paged content conversion options to specify a page number range.
+ *
+ * The page numbering index starts with 1.
+ *
+ * If only the start page number is specified transformers should attempt
+ * a page range from that page number to the end if possible.
+ *
+ * If only an end page number is specified transformers should attempt
+ * a page range from the start to that page if possible.
+ *
+ * @author Ray Gauss II
+ */
+public class PagedSourceOptions extends AbstractTransformationSourceOptions
+{
+ public static final Integer PAGE_1 = new Integer(1);
+
+ /** The start of the page range in the source document */
+ private Integer startPageNumber;
+
+ /** The end of the page range in the source document */
+ private Integer endPageNumber;
+
+ protected static List getDefaultApplicableMimetypes()
+ {
+ List defaults = new ArrayList(17);
+ defaults.add(MimetypeMap.MIMETYPE_PDF);
+ defaults.add(MimetypeMap.MIMETYPE_WORD);
+ defaults.add(MimetypeMap.MIMETYPE_PPT);
+ defaults.add(MimetypeMap.MIMETYPE_IMAGE_TIFF);
+ defaults.add(MimetypeMap.MIMETYPE_OPENDOCUMENT_PRESENTATION);
+ defaults.add(MimetypeMap.MIMETYPE_OPENDOCUMENT_PRESENTATION_TEMPLATE);
+ defaults.add(MimetypeMap.MIMETYPE_OPENDOCUMENT_TEXT_TEMPLATE);
+ defaults.add(MimetypeMap.MIMETYPE_OPENOFFICE1_WRITER);
+ defaults.add(MimetypeMap.MIMETYPE_OPENOFFICE1_IMPRESS);
+ defaults.add(MimetypeMap.MIMETYPE_OPENXML_PRESENTATION);
+ defaults.add(MimetypeMap.MIMETYPE_OPENXML_WORDPROCESSING);
+ defaults.add(MimetypeMap.MIMETYPE_STAROFFICE5_IMPRESS);
+ defaults.add(MimetypeMap.MIMETYPE_STAROFFICE5_IMPRESS_PACKED);
+ defaults.add(MimetypeMap.MIMETYPE_STAROFFICE5_WRITER);
+ defaults.add(MimetypeMap.MIMETYPE_STAROFFICE5_WRITER_GLOBAL);
+ defaults.add(MimetypeMap.MIMETYPE_IWORK_KEYNOTE);
+ defaults.add(MimetypeMap.MIMETYPE_IWORK_PAGES);
+ defaults.add(MimetypeMap.MIMETYPE_WORDPERFECT);
+ return defaults;
+ }
+
+ public PagedSourceOptions()
+ {
+ super();
+ setApplicableMimetypes(PagedSourceOptions.getDefaultApplicableMimetypes());
+ }
+
+ /**
+ * Gets the page number to start from in the source document
+ *
+ * @return the start page number
+ */
+ public Integer getStartPageNumber()
+ {
+ return startPageNumber;
+ }
+
+ /**
+ * Sets the page number to start from in the source document
+ *
+ * @param startPageNumber the start page number
+ */
+ public void setStartPageNumber(Integer startPageNumber)
+ {
+ this.startPageNumber = startPageNumber;
+ }
+
+ /**
+ * Gets the page number to end at in the source document
+ *
+ * @return the start page number
+ */
+ public Integer getEndPageNumber()
+ {
+ return endPageNumber;
+ }
+
+ /**
+ * Sets the page number to end at in the source document
+ *
+ * @param endPageNumber the end page number
+ */
+ public void setEndPageNumber(Integer endPageNumber)
+ {
+ this.endPageNumber = endPageNumber;
+ }
+
+ @Override
+ public TransformationSourceOptions mergedOptions(TransformationSourceOptions overridingOptions)
+ {
+ if (overridingOptions instanceof PagedSourceOptions)
+ {
+ PagedSourceOptions mergedOptions = (PagedSourceOptions) super.mergedOptions(overridingOptions);
+
+ if (((PagedSourceOptions) overridingOptions).getStartPageNumber() != null)
+ {
+ mergedOptions.setStartPageNumber(((PagedSourceOptions) overridingOptions).getStartPageNumber());
+ }
+ if (((PagedSourceOptions) overridingOptions).getEndPageNumber() != null)
+ {
+ mergedOptions.setEndPageNumber(((PagedSourceOptions) overridingOptions).getEndPageNumber());
+ }
+ return mergedOptions;
+ }
+ return null;
+ }
+
+ /**
+ * Gets paged source options which specify just the first page.
+ *
+ * @return the page one source options
+ */
+ public static PagedSourceOptions getPage1Instance() {
+ PagedSourceOptions sourceOptions = new PagedSourceOptions();
+ sourceOptions.setStartPageNumber(PAGE_1);
+ sourceOptions.setEndPageNumber(PAGE_1);
+ return sourceOptions;
+ }
+
+ @Override
+ public TransformationSourceOptionsSerializer getSerializer()
+ {
+ return PagedSourceOptions.createSerializerInstance();
+ }
+
+ /**
+ * Creates an instance of the options serializer
+ *
+ * @return the options serializer
+ */
+ public static TransformationSourceOptionsSerializer createSerializerInstance()
+ {
+ return (new PagedSourceOptions()).new PagedSourceOptionsSerializer();
+ }
+
+ /**
+ * Serializer for paged source options
+ */
+ public class PagedSourceOptionsSerializer implements TransformationSourceOptionsSerializer
+ {
+ public static final String PARAM_SOURCE_START_PAGE = "source_start_page";
+ public static final String PARAM_SOURCE_END_PAGE = "source_end_page";
+
+ @Override
+ public TransformationSourceOptions deserialize(SerializedTransformationOptionsAccessor serializedOptions)
+ {
+ int startPageNumber = serializedOptions.getIntegerParam(PARAM_SOURCE_START_PAGE, 1);
+ int endPageNumber = serializedOptions.getIntegerParam(PARAM_SOURCE_END_PAGE, 1);
+
+ PagedSourceOptions sourceOptions = new PagedSourceOptions();
+ sourceOptions.setStartPageNumber(startPageNumber);
+ sourceOptions.setEndPageNumber(endPageNumber);
+ return sourceOptions;
+ }
+
+ @Override
+ public void serialize(TransformationSourceOptions sourceOptions,
+ Map parameters)
+ {
+ if (parameters == null || sourceOptions == null)
+ {
+ return;
+ }
+ PagedSourceOptions pagedSourceOptions = (PagedSourceOptions) sourceOptions;
+ parameters.put(PARAM_SOURCE_START_PAGE, pagedSourceOptions.getStartPageNumber());
+ parameters.put(PARAM_SOURCE_END_PAGE, pagedSourceOptions.getEndPageNumber());
+ }
+ }
+}
diff --git a/source/java/org/alfresco/service/cmr/repository/SerializedTransformationOptionsAccessor.java b/source/java/org/alfresco/service/cmr/repository/SerializedTransformationOptionsAccessor.java
new file mode 100644
index 0000000000..4b16d24872
--- /dev/null
+++ b/source/java/org/alfresco/service/cmr/repository/SerializedTransformationOptionsAccessor.java
@@ -0,0 +1,66 @@
+/*
+ * Copyright (C) 2005-2013 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see .
+ */
+package org.alfresco.service.cmr.repository;
+
+import org.alfresco.service.cmr.rendition.RenditionServiceException;
+
+/**
+ * Defines methods for retrieving parameter values for use in building
+ * transformation options.
+ *
+ * @author Ray Gauss II
+ */
+public interface SerializedTransformationOptionsAccessor
+{
+
+ /**
+ * Gets the value for the named parameter. Checks the type of
+ * the parameter is correct and throws and Exception if it isn't.
+ * Returns null if the parameter value is null
+ *
+ * @param paramName the name of the parameter being checked.
+ * @param clazz the expected {@link Class} of the parameter value.
+ * @return the parameter value or null.
+ */
+ public T getCheckedParam(String paramName, Class clazz);
+
+ /**
+ * Gets the value for the named parameter. Checks the type of the
+ * parameter is the same as the type of defaultValue and
+ * throws a {@link RenditionServiceException} if it isn't. Returns
+ * defaultValue if the parameter value is null
+ *
+ * @param
+ * @param paramName
+ * @param defaultValue
+ * @return
+ */
+ public T getParamWithDefault(String paramName, T defaultValue);
+
+ /**
+ * Gets the int value for the named parameter. Returns
+ * defaultValue if the parameter value is null.
+ *
+ * @param key
+ * @param defaultValue
+ * @return
+ */
+ public int getIntegerParam(String key, int defaultValue);
+
+}
diff --git a/source/java/org/alfresco/service/cmr/repository/TemporalSourceOptions.java b/source/java/org/alfresco/service/cmr/repository/TemporalSourceOptions.java
new file mode 100644
index 0000000000..2a419ae185
--- /dev/null
+++ b/source/java/org/alfresco/service/cmr/repository/TemporalSourceOptions.java
@@ -0,0 +1,173 @@
+/*
+ * Copyright (C) 2005-2013 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see .
+ */
+package org.alfresco.service.cmr.repository;
+
+import java.io.Serializable;
+import java.util.Map;
+
+import org.alfresco.service.cmr.repository.AbstractTransformationSourceOptions;
+
+/**
+ * Time-based content conversion options to specify an offset and duration.
+ * Useful for audio and video.
+ *
+ * If only the offset is specified transformers should attempt
+ * a transform from that offset to the end if possible.
+ *
+ * If only a duration is specified transformers should attempt
+ * a transform from the start until that duration is reached if possible.
+ *
+ * @author Ray Gauss II
+ */
+public class TemporalSourceOptions extends AbstractTransformationSourceOptions
+{
+
+ /** The offset time code from which to start the transformation */
+ private String offset;
+
+ /** The duration of the target video after the transformation */
+ private String duration;
+
+ public boolean isApplicableForMimetype(String sourceMimetype)
+ {
+ return ((sourceMimetype != null &&
+ sourceMimetype.startsWith(MIMETYPE_VIDEO_PREFIX) ||
+ sourceMimetype.startsWith(MIMETYPE_AUDIO_PREFIX)) ||
+ super.isApplicableForMimetype(sourceMimetype));
+ }
+
+ /**
+ * Gets the offset time code from which to start the transformation
+ * with a format of hh:mm:ss[.xxx]
+ *
+ * @return the offset
+ */
+ public String getOffset()
+ {
+ return offset;
+ }
+
+ /**
+ * Sets the offset time code from which to start the transformation
+ * with a format of hh:mm:ss[.xxx]
+ *
+ * @param offset
+ */
+ public void setOffset(String offset)
+ {
+ this.offset = offset;
+ }
+
+ /**
+ * Gets the duration of the source to read
+ * with a format of hh:mm:ss[.xxx]
+ *
+ * @return
+ */
+ public String getDuration()
+ {
+ return duration;
+ }
+
+ /**
+ * Sets the duration of the source to read
+ * with a format of hh:mm:ss[.xxx]
+ *
+ * @param duration
+ */
+ public void setDuration(String duration)
+ {
+ this.duration = duration;
+ }
+
+ @Override
+ public TransformationSourceOptions mergedOptions(TransformationSourceOptions overridingOptions)
+ {
+ if (overridingOptions instanceof TemporalSourceOptions)
+ {
+ TemporalSourceOptions mergedOptions = (TemporalSourceOptions) super.mergedOptions(overridingOptions);
+
+ if (((TemporalSourceOptions) overridingOptions).getOffset() != null)
+ {
+ mergedOptions.setOffset(((TemporalSourceOptions) overridingOptions).getOffset());
+ }
+ if (((TemporalSourceOptions) overridingOptions).getDuration() != null)
+ {
+ mergedOptions.setDuration(((TemporalSourceOptions) overridingOptions).getDuration());
+ }
+ return mergedOptions;
+ }
+ return null;
+ }
+
+ @Override
+ public TransformationSourceOptionsSerializer getSerializer()
+ {
+ return TemporalSourceOptions.createSerializerInstance();
+ }
+
+ /**
+ * Creates an instance of the options serializer
+ *
+ * @return the options serializer
+ */
+ public static TransformationSourceOptionsSerializer createSerializerInstance()
+ {
+ return (new TemporalSourceOptions()).new TemporalSourceOptionsSerializer();
+ }
+
+ /**
+ * Serializer for temporal source options
+ */
+ public class TemporalSourceOptionsSerializer implements TransformationSourceOptionsSerializer
+ {
+ public static final String PARAM_SOURCE_TIME_OFFSET = "source_time_offset";
+ public static final String PARAM_SOURCE_TIME_DURATION = "source_time_duration";
+
+ @Override
+ public TransformationSourceOptions deserialize(SerializedTransformationOptionsAccessor serializedOptions)
+ {
+ String offset = serializedOptions.getCheckedParam(PARAM_SOURCE_TIME_OFFSET, String.class);
+ String duration = serializedOptions.getCheckedParam(PARAM_SOURCE_TIME_DURATION, String.class);
+
+ if (offset == null && duration == null)
+ {
+ return null;
+ }
+
+ TemporalSourceOptions sourceOptions = new TemporalSourceOptions();
+ sourceOptions.setOffset(offset);
+ sourceOptions.setDuration(duration);
+ return sourceOptions;
+ }
+
+ @Override
+ public void serialize(TransformationSourceOptions sourceOptions,
+ Map parameters)
+ {
+ if (parameters == null || sourceOptions == null)
+ return;
+ TemporalSourceOptions temporalSourceOptions = (TemporalSourceOptions) sourceOptions;
+ parameters.put(PARAM_SOURCE_TIME_OFFSET, temporalSourceOptions.getOffset());
+ parameters.put(PARAM_SOURCE_TIME_DURATION, temporalSourceOptions.getDuration());
+ }
+ }
+
+
+}
diff --git a/source/java/org/alfresco/service/cmr/repository/TransformationOptions.java b/source/java/org/alfresco/service/cmr/repository/TransformationOptions.java
index 209bf55f15..7d7de3691c 100644
--- a/source/java/org/alfresco/service/cmr/repository/TransformationOptions.java
+++ b/source/java/org/alfresco/service/cmr/repository/TransformationOptions.java
@@ -18,11 +18,16 @@
*/
package org.alfresco.service.cmr.repository;
+import java.util.ArrayList;
+import java.util.Collection;
import java.util.HashMap;
+import java.util.List;
import java.util.Map;
import org.alfresco.service.cmr.repository.datatype.TypeConverter;
import org.alfresco.service.namespace.QName;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
/**
* Class containing values of options that are passed to content transformers. These options
@@ -37,6 +42,8 @@ import org.alfresco.service.namespace.QName;
*/
public class TransformationOptions implements Cloneable
{
+ private static final Log logger = LogFactory.getLog(TransformationOptions.class);
+
/** Option map names to preserve backward compatibility */
public static final String OPT_SOURCE_NODEREF = "contentReaderNodeRef";
public static final String OPT_SOURCE_CONTENT_PROPERTY = "sourceContentProperty";
@@ -61,6 +68,9 @@ public class TransformationOptions implements Cloneable
/** Time, KBytes and page limits */
private TransformationOptionLimits limits = new TransformationOptionLimits();
+
+ /** Source options based on its mimetype */
+ private Map, TransformationSourceOptions> sourceOptionsMap;
/**
* Default constructor
@@ -124,6 +134,7 @@ public class TransformationOptions implements Cloneable
public void copyFrom(TransformationOptions otherOptions)
{
this.set(otherOptions.toMap());
+ this.setSourceOptionsList(otherOptions.getSourceOptionsList());
}
/**
@@ -419,7 +430,87 @@ public class TransformationOptions implements Cloneable
{
this.limits = limits;
}
-
+
+ /**
+ * Gets the map of source options further describing how the source should
+ * be transformed based on its mimetype
+ *
+ * @return the source mimetype to source options map
+ */
+ protected Map, TransformationSourceOptions> getSourceOptionsMap()
+ {
+ return sourceOptionsMap;
+ }
+
+ /**
+ * Gets the immutable list of source options further describing how the source should
+ * be transformed based on its mimetype.
+ * Use {@link TransformationOptions#addSourceOptions(TransformationSourceOptions)}
+ * to add source options.
+ *
+ * @return the source options list
+ */
+ public Collection getSourceOptionsList()
+ {
+ if (sourceOptionsMap == null)
+ return null;
+ return sourceOptionsMap.values();
+ }
+
+ /**
+ * Sets the list of source options further describing how the source should
+ * be transformed based on its mimetype.
+ *
+ * @param sourceOptionsList the source options list
+ */
+ public void setSourceOptionsList(Collection sourceOptionsList)
+ {
+ if (sourceOptionsList != null)
+ {
+ for (TransformationSourceOptions sourceOptions : sourceOptionsList)
+ {
+ addSourceOptions(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.
+ *
+ * @param sourceOptions
+ */
+ public void addSourceOptions(TransformationSourceOptions sourceOptions)
+ {
+ if (sourceOptionsMap == null)
+ {
+ sourceOptionsMap = new HashMap, TransformationSourceOptions>(1);
+ }
+ TransformationSourceOptions newOptions = sourceOptions;
+ TransformationSourceOptions existingOptions = sourceOptionsMap.get(sourceOptions.getClass());
+ if (existingOptions != null)
+ {
+ newOptions = existingOptions.mergedOptions(sourceOptions);
+ }
+ sourceOptionsMap.put(sourceOptions.getClass(), newOptions);
+ }
+
+ /**
+ * Gets the appropriate source options for the given mimetype if available.
+ *
+ * @param sourceMimetype
+ * @return the source options for the mimetype
+ */
+ @SuppressWarnings("unchecked")
+ public T getSourceOptions(Class clazz)
+ {
+ if (sourceOptionsMap == null)
+ return null;
+ return (T) sourceOptionsMap.get(clazz);
+ }
+
/**
* Convert the transformation options into a map.
*
diff --git a/source/java/org/alfresco/service/cmr/repository/TransformationSourceOptions.java b/source/java/org/alfresco/service/cmr/repository/TransformationSourceOptions.java
new file mode 100644
index 0000000000..40f4e3af05
--- /dev/null
+++ b/source/java/org/alfresco/service/cmr/repository/TransformationSourceOptions.java
@@ -0,0 +1,105 @@
+/*
+ * Copyright (C) 2005-2013 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see .
+ */
+package org.alfresco.service.cmr.repository;
+
+import java.io.Serializable;
+import java.util.List;
+import java.util.Map;
+
+import org.alfresco.repo.rendition.executer.AbstractRenderingEngine;
+import org.alfresco.service.cmr.rendition.RenditionService;
+import org.alfresco.service.cmr.repository.PagedSourceOptions;
+
+/**
+ * Defines options and demarcations needed to describe the details of how
+ * the source should be transformed, independent of the target requirements.
+ *
+ * See {@link PagedSourceOptions} for an example implementation that
+ * describes the page number that should be used from the source content.
+ *
+ * @author Ray Gauss II
+ */
+public interface TransformationSourceOptions
+{
+
+ /**
+ * Gets the list of applicable mimetypes
+ *
+ * @return the applicable mimetypes
+ */
+ public List getApplicabledMimetypes();
+
+ /**
+ * Gets whether or not these transformation source options apply for the
+ * given mimetype
+ *
+ * @param mimetype the mimetype of the source
+ * @return if these transformation source options apply
+ */
+ public boolean isApplicableForMimetype(String mimetype);
+
+ /**
+ * Creates a new TransformationSourceOptions object from this
+ * one, merging any non-null overriding fields in the given
+ * overridingOptions
+ *
+ * @param overridingOptions
+ * @return a merged TransformationSourceOptions object
+ */
+ public TransformationSourceOptions mergedOptions(TransformationSourceOptions overridingOptions);
+
+ /**
+ * Gets the serializer for the source options.
+ *
+ * @return the serializer
+ */
+ public TransformationSourceOptionsSerializer getSerializer();
+
+ /**
+ * Defines methods for serializing the source options into a parameter map and
+ * deserializing from a serialized options accessor.
+ *
+ * This is primarily used when interacting with the {@link RenditionService}
+ * with {@link AbstractRenderingEngine}'s RenderContext being an implementer
+ * of this interface.
+ */
+ public interface TransformationSourceOptionsSerializer
+ {
+
+ /**
+ * Serializes the given transformation source options into the given parameter map.
+ *
+ * @param transformationSourceOptions
+ * @param parameters
+ */
+ public void serialize(TransformationSourceOptions transformationSourceOptions, Map parameters);
+
+ /**
+ * Gets the parameters from the serialized options accessor and builds a source options object.
+ *
+ * @param serializedOptions
+ * @return the deserialized source options
+ */
+ public TransformationSourceOptions deserialize(SerializedTransformationOptionsAccessor serializedOptions);
+
+ }
+
+}
+
+