Package org.alfresco.service.cmr.repository

Class PagedSourceOptions

java.lang.Object

org.alfresco.service.cmr.repository.AbstractTransformationSourceOptions

org.alfresco.service.cmr.repository.PagedSourceOptions

All Implemented Interfaces:

java.lang.Cloneable, TransformationSourceOptions

public class PagedSourceOptions
extends 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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	PagedSourceOptions.PagedSourceOptionsSerializer	Serializer for paged source options

Nested classes/interfaces inherited from interface org.alfresco.service.cmr.repository.TransformationSourceOptions

TransformationSourceOptions.TransformationSourceOptionsSerializer

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.Integer	PAGE_1

Constructor Summary

Constructors

Constructor	Description
PagedSourceOptions()

Method Summary

Modifier and Type	Method	Description
static TransformationSourceOptions.TransformationSourceOptionsSerializer	createSerializerInstance()	Creates an instance of the options serializer
protected static java.util.List<java.lang.String>	getDefaultApplicableMimetypes()
java.lang.Integer	getEndPageNumber()	Gets the page number to end at in the source document
static PagedSourceOptions	getPage1Instance()	Gets paged source options which specify just the first page.
TransformationSourceOptions.TransformationSourceOptionsSerializer	getSerializer()	Gets the serializer for the source options.
java.lang.Integer	getStartPageNumber()	Gets the page number to start from in the source document
TransformationSourceOptions	mergedOptions(TransformationSourceOptions overridingOptions)	Creates a new TransformationSourceOptions object from this one, merging any non-null overriding fields in the given overridingOptions
void	setEndPageNumber(java.lang.Integer endPageNumber)	Sets the page number to end at in the source document
void	setStartPageNumber(java.lang.Integer startPageNumber)	Sets the page number to start from in the source document

Methods inherited from class org.alfresco.service.cmr.repository.AbstractTransformationSourceOptions

clone, getApplicabledMimetypes, getApplicableMimetypes, isApplicableForMimetype, putParameterIfNotNull, setApplicableMimetypes

Methods inherited from class java.lang.Object

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

Field Detail

PAGE_1

public static final java.lang.Integer PAGE_1

Constructor Detail

PagedSourceOptions

public PagedSourceOptions()

Method Detail

getDefaultApplicableMimetypes

protected static java.util.List<java.lang.String> getDefaultApplicableMimetypes()

getStartPageNumber

public java.lang.Integer getStartPageNumber()

Gets the page number to start from in the source document

Returns:

the start page number

setStartPageNumber

public void setStartPageNumber(java.lang.Integer startPageNumber)

Sets the page number to start from in the source document

Parameters:

startPageNumber - the start page number

getEndPageNumber

public java.lang.Integer getEndPageNumber()

Gets the page number to end at in the source document

Returns:

the start page number

setEndPageNumber

public void setEndPageNumber(java.lang.Integer endPageNumber)

Sets the page number to end at in the source document

Parameters:

endPageNumber - the end page number

mergedOptions

public TransformationSourceOptions mergedOptions(TransformationSourceOptions overridingOptions)

Description copied from class: AbstractTransformationSourceOptions

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

Specified by:

mergedOptions in interface TransformationSourceOptions

Overrides:

mergedOptions in class AbstractTransformationSourceOptions

Parameters:

overridingOptions - TransformationSourceOptions

Returns:

a merged TransformationSourceOptions object

getPage1Instance

public static PagedSourceOptions getPage1Instance()

Gets paged source options which specify just the first page.

Returns:

the page one source options

getSerializer

public TransformationSourceOptions.TransformationSourceOptionsSerializer getSerializer()

Description copied from interface: TransformationSourceOptions

Gets the serializer for the source options.

Returns:

the serializer

createSerializerInstance

public static TransformationSourceOptions.TransformationSourceOptionsSerializer createSerializerInstance()

Creates an instance of the options serializer

Returns:

the options serializer