org.verapdf.features.pb.objects.PBPageFeaturesObjectAdapter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pdfbox-feature-reporting-jakarta Show documentation
Reports features extracted from a PDF document.
There is a newer version: 1.26.2
Show newest version
/**
 * This file is part of veraPDF PDF Box Features Reporting, a module of the veraPDF project.
 * Copyright (c) 2015, veraPDF Consortium 
 * All rights reserved.
 *
 * veraPDF PDF Box Features Reporting is free software: you can redistribute it and/or modify
 * it under the terms of either:
 *
 * The GNU General public license GPLv3+.
 * You should have received a copy of the GNU General Public License
 * along with veraPDF PDF Box Features Reporting as the LICENSE.GPL file in the root of the source
 * tree.  If not, see http://www.gnu.org/licenses/ or
 * https://www.gnu.org/licenses/gpl-3.0.en.html.
 *
 * The Mozilla Public License MPLv2+.
 * You should have received a copy of the Mozilla Public License along with
 * veraPDF PDF Box Features Reporting as the LICENSE.MPL file in the root of the source tree.
 * If a copy of the MPL was not distributed with this file, you can obtain one at
 * http://mozilla.org/MPL/2.0/.
 */
package org.verapdf.features.pb.objects;

import org.apache.pdfbox.cos.COSBase;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.cos.COSNumber;
import org.apache.pdfbox.cos.COSObject;
import org.apache.pdfbox.pdmodel.PDPage;
import org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransition;
import org.verapdf.features.objects.PageFeaturesObjectAdapter;
import org.verapdf.features.pb.tools.PBAdapterHelper;

import java.io.InputStream;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Set;

/**
 * Feature object for page
 *
 * @author Maksim Bezrukov
 */
public class PBPageFeaturesObjectAdapter implements PageFeaturesObjectAdapter {

	private PDPage page;
	private String label;
	private String thumb;
	private Set annotsId;
	private Set extGStateChild;
	private Set colorSpaceChild;
	private Set patternChild;
	private Set shadingChild;
	private Set xobjectChild;
	private Set fontChild;
	private Set propertiesChild;
	private int index;
	private Double scaling;
	private PDTransition transition;
	private List errors;

	/**
	 * Constructs new Page Feature Object
	 *
	 * @param page            pdfbox class represents page object
	 * @param thumb           thumbnail image id
	 * @param annotsId        set of annotations id which contains in this page
	 * @param extGStateChild  set of external graphics state id which contains in resource dictionary of this page
	 * @param colorSpaceChild set of ColorSpace id which contains in resource dictionary of this page
	 * @param patternChild    set of pattern id which contains in resource dictionary of this page
	 * @param shadingChild    set of shading id which contains in resource dictionary of this page
	 * @param xobjectChild    set of XObject id which contains in resource dictionary of this page
	 * @param fontChild       set of font id which contains in resource dictionary of this page
	 * @param propertiesChild set of properties id which contains in resource dictionary of this page
	 * @param index           page index
	 */
	public PBPageFeaturesObjectAdapter(PDPage page,
									   String label,
									   String thumb,
									   Set annotsId,
									   Set extGStateChild,
									   Set colorSpaceChild,
									   Set patternChild,
									   Set shadingChild,
									   Set xobjectChild,
									   Set fontChild,
									   Set propertiesChild,
									   int index) {
		this.page = page;
		this.label = label;
		this.thumb = thumb;
		this.annotsId = annotsId;
		this.extGStateChild = extGStateChild;
		this.colorSpaceChild = colorSpaceChild;
		this.patternChild = patternChild;
		this.shadingChild = shadingChild;
		this.xobjectChild = xobjectChild;
		this.fontChild = fontChild;
		this.propertiesChild = propertiesChild;
		this.index = index;
		if (page != null) {
			this.transition = this.page.getTransition();
			COSBase base = page.getCOSObject().getDictionaryObject(COSName.getPDFName("PZ"));
			if (base != null) {
				while (base instanceof COSObject) {
					base = ((COSObject) base).getObject();
				}
				if (base instanceof COSNumber) {
					COSNumber number = (COSNumber) base;
					this.scaling = number.doubleValue();
				} else {
					this.errors = new ArrayList<>();
					this.errors.add("Scaling is not a number");
				}
			}
		}
	}

	@Override
	public String getThumb() {
		return thumb;
	}

	@Override
	public Set getAnnotsId() {
		return annotsId;
	}

	@Override
	public Set getExtGStateChild() {
		return extGStateChild;
	}

	@Override
	public Set getColorSpaceChild() {
		return colorSpaceChild;
	}

	@Override
	public Set getPatternChild() {
		return patternChild;
	}

	@Override
	public Set getShadingChild() {
		return shadingChild;
	}

	@Override
	public Set getXObjectChild() {
		return xobjectChild;
	}

	@Override
	public Set getFontChild() {
		return fontChild;
	}

	@Override
	public Set getPropertiesChild() {
		return propertiesChild;
	}

	@Override
	public int getIndex() {
		return index;
	}

	@Override
	public String getLabel() {
		return this.label;
	}

	@Override
	public String getTransitionStyle() {
		return this.transition == null ? null : this.transition.getStyle();
	}

	@Override
	public double[] getMediaBox() {
		if (page != null) {
			return PBAdapterHelper.parseRectangle(page.getMediaBox());
		}
		return null;
	}

	@Override
	public double[] getCropBox() {
		if (page != null) {
			return PBAdapterHelper.parseRectangle(page.getCropBox());
		}
		return null;
	}

	@Override
	public double[] getTrimBox() {
		if (page != null) {
			return PBAdapterHelper.parseRectangle(page.getTrimBox());
		}
		return null;
	}

	@Override
	public double[] getBleedBox() {
		if (page != null) {
			return PBAdapterHelper.parseRectangle(page.getBleedBox());
		}
		return null;
	}

	@Override
	public double[] getArtBox() {
		if (page != null) {
			return PBAdapterHelper.parseRectangle(page.getArtBox());
		}
		return null;
	}

	@Override
	public Long getRotation() {
		if (page != null) {
			return Long.valueOf(page.getRotation());
		}
		return null;
	}

	@Override
	public Double getScaling() {
		return this.scaling;
	}

	@Override
	public InputStream getMetadataStream() {
		if (page != null) {
			return PBAdapterHelper.getMetadataStream(page.getMetadata());
		}
		return null;
	}

	@Override
	public boolean isPDFObjectPresent() {
		return this.page != null;
	}

	@Override
	public List getErrors() {
		return this.errors == null ?
				Collections.emptyList() : Collections.unmodifiableList(this.errors);
	}
}