org.verapdf.model.tools.IDGenerator Maven / Gradle / Ivy
Show all versions of pdfbox-validation-model Show documentation
/**
* This file is part of veraPDF PDF Box PDF/A Validation Model Implementation, a module of the veraPDF project.
* Copyright (c) 2015, veraPDF Consortium
* All rights reserved.
*
* veraPDF PDF Box PDF/A Validation Model Implementation 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 PDF/A Validation Model Implementation 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 PDF/A Validation Model Implementation 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.model.tools;
import org.apache.pdfbox.cos.COSBase;
import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.cos.COSObject;
import org.apache.pdfbox.pdmodel.common.COSObjectable;
import org.apache.pdfbox.pdmodel.font.PDFontLike;
import org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem;
/**
* Created by Evgeniy Muravitskiy on 4/27/15.
*
* This class specified for creating ID`s for every object from model.
*/
public final class IDGenerator {
private IDGenerator() {
// Disable default constructor
}
/**
* Generate ID for pdf box object. Current method generate a string of the
* form 'N M' for {@link org.apache.pdfbox.cos.COSObject}, where 'N' and 'M'
* are numbers, and null for other pdf box objects
*
* @param pdfBoxObject
* object of pdf box library
* @return string representation of ID
*/
public static String generateID(COSBase pdfBoxObject) {
if (pdfBoxObject instanceof COSObject) {
return String.valueOf(((COSObject) pdfBoxObject)
.getObjectNumber() + " " + ((COSObject) pdfBoxObject)
.getGenerationNumber());
}
return null;
}
/**
* Generate ID for font glyph. Current method generate a string of the
* form 'hashcode fontName glyphCode', where 'hashcode' is hashcode of
* font dictionary, 'fontName' is String and 'glyphCode' is number.
*
* @param hashcode hashcode of font dictionary
* @param fontName name of font
* @param glyphCode code of glyph
* @return string representation of ID
*/
public static String generateID(int hashcode, String fontName, int glyphCode, int renderingMode) {
return String.valueOf(hashcode) + ' ' + fontName + ' ' + glyphCode + ' ' + renderingMode;
}
/**
* Generate ID for font. Current method generate a string of the form
* 'hashcode fontName', where 'hashcode' is hashcode of font dictionary
* and 'fontName' is String
*
* @param font target font for generating ID
* @return string representation of ID
*/
public static String generateID(PDFontLike font) {
int hashcode = font instanceof COSObjectable ?
((COSObjectable) font).getCOSObject().hashCode() : -1;
return String.valueOf(hashcode) + ' ' + font.getName();
}
public static String generateID(PDOutlineItem item) {
COSDictionary dictionary = item.getCOSObject();
String value = getOutlineID(dictionary, COSName.PREV, COSName.NEXT);
return value != null ? value :
getOutlineID(dictionary, COSName.PARENT, COSName.FIRST);
}
private static String getOutlineID(COSDictionary dictionary, COSName kind, COSName key) {
COSBase base = dictionary.getDictionaryObject(kind);
if (base instanceof COSDictionary) {
COSBase current = ((COSDictionary) base).getItem(key);
String value = IDGenerator.generateID(current);
if (value != null) {
return "outline " + value;
}
/*
TODO : according to specification entries Next, Prev, First and Parent
must be indirect objects, but document can fail specification.
How we must resolve this situation?
*/
}
return null;
}
}