org.sejda.model.parameter

Class ExtractPagesParameters

java.lang.Object

org.sejda.model.parameter.base.AbstractParameters

org.sejda.model.parameter.base.AbstractPdfOutputParameters

org.sejda.model.parameter.base.MultiplePdfSourceParameters

org.sejda.model.parameter.base.MultiplePdfSourceMultipleOutputParameters

org.sejda.model.parameter.ExtractPagesParameters

All Implemented Interfaces:

DiscardableOutlineTaskParameters, MultiplePdfSourceTaskParameters, OptimizableOutputTaskParameters, PrefixableTaskParameters, SingleOrMultipleOutputTaskParameters, TaskParameters, PageRangeSelection, PagesSelection

@HasSelectedPages
public class ExtractPagesParameters
extends MultiplePdfSourceMultipleOutputParameters
implements PageRangeSelection, PagesSelection, OptimizableOutputTaskParameters, DiscardableOutlineTaskParameters

Parameter class for an Extract pages task. Allow to specify a predefined set of pages to extract (odd, even) or a set of page ranges but not both. Page ranges are validated to make sure that there is no intersection.

Author:

Andrea Vacondio

Constructor Summary

Constructors

Constructor and Description
ExtractPagesParameters() Creates and empty instance where page selection can be set
ExtractPagesParameters(PredefinedSetOfPages predefinedSetOfPages) Creates an instance using a predefined set of pages to extract.

Method Summary

Modifier and Type	Method and Description
void	addAllPageRanges(Collection<PageRange> ranges)
void	addPageRange(PageRange range)
boolean	discardOutline()
void	discardOutline(boolean discardOutline)
boolean	equals(Object other)
OptimizationPolicy	getOptimizationPolicy()
Set<Integer>	getPages(int upperLimit)
Set<PageRange>	getPageSelection()
List<Set<Integer>>	getPagesSets(int upperLimit)
PredefinedSetOfPages	getPredefinedSetOfPages()
int	hashCode()
boolean	isInvertSelection()
boolean	isSeparateFileForEachRange()
void	setInvertSelection(boolean invertSelection)
void	setOptimizationPolicy(OptimizationPolicy optimizationPolicy)
void	setSeparateFileForEachRange(boolean separateFileForEachRange)

Methods inherited from class org.sejda.model.parameter.base.MultiplePdfSourceMultipleOutputParameters

addSpecificResultFilename, addSpecificResultFilenames, getOutput, getOutputPrefix, getSpecificResultFilename, getSpecificResultFilename, getSpecificResultFilenames, setOutput, setOutputPrefix

Methods inherited from class org.sejda.model.parameter.base.MultiplePdfSourceParameters

addSource, addSources, getSourceList, removeAllSources

Methods inherited from class org.sejda.model.parameter.base.AbstractPdfOutputParameters

getMinRequiredPdfVersion, getVersion, isCompress, setCompress, setVersion

Methods inherited from class org.sejda.model.parameter.base.AbstractParameters

getExistingOutputPolicy, isLenient, setExistingOutputPolicy, setLenient, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sejda.model.parameter.base.TaskParameters

getExistingOutputPolicy, getOutput, isLenient, setExistingOutputPolicy, setLenient

Constructor Detail

ExtractPagesParameters

public ExtractPagesParameters()

Creates and empty instance where page selection can be set

ExtractPagesParameters

public ExtractPagesParameters(PredefinedSetOfPages predefinedSetOfPages)

Creates an instance using a predefined set of pages to extract.

Parameters:

predefinedSetOfPages -

Method Detail

addPageRange

public void addPageRange(PageRange range)

addAllPageRanges

public void addAllPageRanges(Collection<PageRange> ranges)

getPredefinedSetOfPages

public PredefinedSetOfPages getPredefinedSetOfPages()

getPageSelection

public Set<PageRange> getPageSelection()

Specified by:

getPageSelection in interface PageRangeSelection

Returns:

an unmodifiable view of the pageSelection

getPages

public Set<Integer> getPages(int upperLimit)

Specified by:

getPages in interface PagesSelection

Parameters:

upperLimit - the number of pages of the document (upper limit).

Returns:

the selected set of pages. Iteration ordering is predictable, it is the order in which elements were inserted into the PageRange set or the natural order in case of PredefinedSetOfPages.

See Also:

PagesSelection.getPages(int)

getPagesSets

public List<Set<Integer>> getPagesSets(int upperLimit)

Parameters:

upperLimit - the number of pages of the document (upper limit).

Returns:

a list of sets of pages. Each set represents an extraction set that generates an output PDF file.

getOptimizationPolicy

public OptimizationPolicy getOptimizationPolicy()

Specified by:

getOptimizationPolicy in interface OptimizableOutputTaskParameters

setOptimizationPolicy

public void setOptimizationPolicy(OptimizationPolicy optimizationPolicy)

Specified by:

setOptimizationPolicy in interface OptimizableOutputTaskParameters

discardOutline

public boolean discardOutline()

Specified by:

discardOutline in interface DiscardableOutlineTaskParameters

discardOutline

public void discardOutline(boolean discardOutline)

Specified by:

discardOutline in interface DiscardableOutlineTaskParameters

isInvertSelection

public boolean isInvertSelection()

setInvertSelection

public void setInvertSelection(boolean invertSelection)

isSeparateFileForEachRange

public boolean isSeparateFileForEachRange()

Returns:

if true the task will generate a separate PDF file for each PageRange in the parameters

setSeparateFileForEachRange

public void setSeparateFileForEachRange(boolean separateFileForEachRange)

hashCode

public int hashCode()

Overrides:

hashCode in class MultiplePdfSourceMultipleOutputParameters

equals

public boolean equals(Object other)

Overrides:

equals in class MultiplePdfSourceMultipleOutputParameters