org.sejda.model.parameter.ExtractPagesParameters Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sejda-model Show documentation
Show all versions of sejda-model Show documentation
Package containing reusable model for Sejda.
/*
* Created on 25/ago/2011
* Copyright 2011 by Andrea Vacondio ([email protected]).
*
* This file is part of the Sejda source code
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see pageSelection = new NullSafeSet<>();
private boolean invertSelection = false;
private boolean separateFileForEachRange = false;
/**
* Creates and empty instance where page selection can be set
*/
public ExtractPagesParameters() {
this.predefinedSetOfPages = PredefinedSetOfPages.NONE;
}
/**
* Creates an instance using a predefined set of pages to extract.
*/
public ExtractPagesParameters(PredefinedSetOfPages predefinedSetOfPages) {
this.predefinedSetOfPages = ofNullable(predefinedSetOfPages).orElse(PredefinedSetOfPages.NONE);
}
public void addPageRange(PagesSelection range) {
pageSelection.add(range);
}
public void addAllPageRanges(Collection ranges) {
pageSelection.addAll(ranges);
}
public PredefinedSetOfPages getPredefinedSetOfPages() {
return predefinedSetOfPages;
}
/**
* @return true if there is some page selection. There is no guarantee about the validity of the selection
* (Ex. the selection is for page 30 and the input document has only 20 pages)
*/
public boolean hasPageSelection() {
return !pageSelection.isEmpty();
}
/**
* @param upperLimit the number of pages of the document (upper limit).
* @return the selected set of pages. Iteration ordering is predictable, it is the order in which elements were inserted into the {@link PageRange} set or the natural order in
* case of {@link PredefinedSetOfPages}.
* @see PagesSelection#getPages(int)
*/
@Override
public Set getPages(int upperLimit) {
Set pages = new NullSafeSet<>();
if (predefinedSetOfPages != PredefinedSetOfPages.NONE) {
pages = predefinedSetOfPages.getPages(upperLimit);
} else {
for (PagesSelection range : pageSelection) {
pages.addAll(range.getPages(upperLimit));
}
}
if (!invertSelection) {
return pages;
}
Set invertedPages = new NullSafeSet<>();
for (int i = 1; i <= upperLimit; i++) {
if (!pages.contains(i)) {
invertedPages.add(i);
}
}
return invertedPages;
}
/**
* @param upperLimit the number of pages of the document (upper limit).
* @return a list of sets of pages. Each set represents an extraction set that generates an output PDF file.
*/
public List> getPagesSets(int upperLimit) {
ArrayList> pages = new ArrayList<>();
if (predefinedSetOfPages == PredefinedSetOfPages.NONE && isSeparateFileForEachRange()) {
if (invertSelection) {
Set currentRange = new NullSafeSet<>();
int previous = 0;
for (int current : getPages(upperLimit)) {
if (currentRange.isEmpty() || (current == previous + 1)) {
currentRange.add(current);
previous = current;
} else {
pages.add(currentRange);
currentRange = new NullSafeSet<>();
currentRange.add(current);
previous = current;
}
}
if (!currentRange.isEmpty()) {
pages.add(currentRange);
}
} else {
for (PagesSelection range : pageSelection) {
pages.add(range.getPages(upperLimit));
}
}
return pages;
}
return Collections.singletonList(getPages(upperLimit));
}
@Override
public OptimizationPolicy getOptimizationPolicy() {
return optimizationPolicy;
}
@Override
public void setOptimizationPolicy(OptimizationPolicy optimizationPolicy) {
this.optimizationPolicy = optimizationPolicy;
}
@Override
public boolean discardOutline() {
return discardOutline;
}
@Override
public void discardOutline(boolean discardOutline) {
this.discardOutline = discardOutline;
}
public boolean isInvertSelection() {
return invertSelection;
}
public void setInvertSelection(boolean invertSelection) {
this.invertSelection = invertSelection;
}
/**
* @return if true the task will generate a separate PDF file for each PageRange in the parameters
*/
public boolean isSeparateFileForEachRange() {
return separateFileForEachRange;
}
public void setSeparateFileForEachRange(boolean separateFileForEachRange) {
this.separateFileForEachRange = separateFileForEachRange;
}
@Override
public int hashCode() {
return new HashCodeBuilder().appendSuper(super.hashCode()).append(optimizationPolicy).append(discardOutline)
.append(predefinedSetOfPages).append(invertSelection).append(separateFileForEachRange)
.append(pageSelection).toHashCode();
}
@Override
public boolean equals(Object other) {
if (this == other) {
return true;
}
if (!(other instanceof ExtractPagesParameters parameter)) {
return false;
}
return new EqualsBuilder().appendSuper(super.equals(other))
.append(predefinedSetOfPages, parameter.predefinedSetOfPages)
.append(optimizationPolicy, parameter.optimizationPolicy)
.append(discardOutline, parameter.discardOutline).append(pageSelection, parameter.pageSelection)
.append(invertSelection, parameter.invertSelection)
.append(separateFileForEachRange, parameter.separateFileForEachRange).isEquals();
}
}