org.sejda.model.parameter

Class ExtractTextByPagesParameters

java.lang.Object

org.sejda.model.parameter.base.AbstractParameters

org.sejda.model.parameter.base.AbstractPdfOutputParameters

org.sejda.model.parameter.base.SinglePdfSourceMultipleOutputParameters

org.sejda.model.parameter.ExtractTextByPagesParameters

All Implemented Interfaces:

MultipleOutputTaskParameters, SinglePdfSourceTaskParameters, TaskParameters, PageRangeSelection, PagesSelection

@NoIntersections
public class ExtractTextByPagesParameters
extends SinglePdfSourceMultipleOutputParameters
implements PageRangeSelection, PagesSelection

Parameters for extract text by pages manipulation. Accepts a set of page numbers, where the split occurs. Works similar to SplitByPages, with the difference that the output will be extracted text files.

Author:

Edi Weissmann

Constructor Summary

Constructors

Constructor and Description
ExtractTextByPagesParameters()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAllPageRanges(Collection<PageRange> ranges)
void	addPageRange(PageRange range)
boolean	equals(Object other)
Set<Integer>	getPages(int totalNumberOfPage)
Set<PageRange>	getPageSelection()
PdfSource<?>	getSource()
String	getTextEncoding()
int	hashCode()
boolean	isAllPages()
void	setSource(PdfSource<?> source) Set the source for this parameter.
void	setTextEncoding(String textEncoding)

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

getOutput, getOutputPrefix, setOutput, setOutputPrefix

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

isOverwrite, setOverwrite, 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

isOverwrite

Constructor Detail

ExtractTextByPagesParameters

public ExtractTextByPagesParameters()

Method Detail

getTextEncoding

public String getTextEncoding()

setTextEncoding

public void setTextEncoding(String textEncoding)

getPageSelection

public Set<PageRange> getPageSelection()

Specified by:

getPageSelection in interface PageRangeSelection

Returns:

an unmodifiable view of the pageSelection

addPageRange

public void addPageRange(PageRange range)

addAllPageRanges

public void addAllPageRanges(Collection<PageRange> ranges)

isAllPages

public boolean isAllPages()

Returns:

true if page selection for this input contains all the pages of the input source.

getPages

public Set<Integer> getPages(int totalNumberOfPage)

Specified by:

getPages in interface PagesSelection

Parameters:

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

See Also:

PagesSelection.getPages(int)

hashCode

public int hashCode()

Overrides:

hashCode in class SinglePdfSourceMultipleOutputParameters

equals

public boolean equals(Object other)

Overrides:

equals in class SinglePdfSourceMultipleOutputParameters

getSource

public PdfSource<?> getSource()

Specified by:

getSource in interface SinglePdfSourceTaskParameters

Returns:

the source for this parameter.

setSource

public void setSource(PdfSource<?> source)

Description copied from interface: SinglePdfSourceTaskParameters

Set the source for this parameter.

Specified by:

setSource in interface SinglePdfSourceTaskParameters