org.verapdf.features.pb

Class PBFeaturesObjectCreator

java.lang.Object

org.verapdf.features.pb.PBFeaturesObjectCreator

public final class PBFeaturesObjectCreator
extends Object

Creates Feature Objects and report them to Features Reporter

Author:

Maksim Bezrukov

Method Summary

Methods

Modifier and Type	Method and Description
static PBAnnotationFeaturesObject	createAnnotFeaturesObject(PDAnnotation annot, String id, Set<String> pages, String parentId, String popupId, Set<String> formXObjects) Creates new PBAnnotationFeaturesObject
static PBColorSpaceFeaturesObject	createColorSpaceFeaturesObject(PDColorSpace colorSpace, String id, String iccProfileChild, String colorSpaceChild, Set<String> pageParents, Set<String> colorSpaceParents, Set<String> patternParents, Set<String> shadingParents, Set<String> xobjectParents, Set<String> fontParents) Constructs new PBColorSpaceFeaturesObject
static PBDocSecurityFeaturesObject	createDocSecurityFeaturesObject(PDEncryption encryption) Creates new PBDocSecurityFeaturesObject
static PBEmbeddedFileFeaturesObject	createEmbeddedFileFeaturesObject(PDComplexFileSpecification embFile, int index) Creates new PBEmbeddedFileFeaturesObject
static PBExtGStateFeaturesObject	createExtGStateFeaturesObject(PDExtendedGraphicsState exGState, String id, String fontChildID, Set<String> pageParentsID, Set<String> patternParentsID, Set<String> xobjectParentsID, Set<String> fontParentsID) Creates new PBExtGStateFeaturesObject
static PBFontFeaturesObject	createFontFeaturesObject(PDFontLike fontLike, String id, Set<String> extGStateChild, Set<String> colorSpaceChild, Set<String> patternChild, Set<String> shadingChild, Set<String> xobjectChild, Set<String> fontChild, Set<String> propertiesChild, Set<String> extGStateParent, Set<String> pageParent, Set<String> patternParent, Set<String> xobjectParent, Set<String> fontParent) Constructs new PBFontFeaturesObject
static PBFormXObjectFeaturesObject	createFormXObjectFeaturesObject(PDFormXObject formXObject, String id, String groupChild, Set<String> extGStateChild, Set<String> colorSpaceChild, Set<String> patternChild, Set<String> shadingChild, Set<String> xobjectChild, Set<String> fontChild, Set<String> propertiesChild, Set<String> pageParent, Set<String> annotationParent, Set<String> patternParent, Set<String> xobjectParent, Set<String> fontParent) Constructs new PBFormXObjectFeaturesObject
static PBICCProfileFeaturesObject	createICCProfileFeaturesObject(COSStream profile, String id, Set<String> outInts, Set<String> iccBaseds) Creates new PBICCProfileFeaturesObject
static PBImageXObjectFeaturesObject	createImageXObjectFeaturesObject(PDImageXObjectProxy imageXObject, String id, String colorSpaceChild, String maskChild, String sMaskChild, Set<String> alternatesChild, Set<String> pageParent, Set<String> patternParent, Set<String> xobjectParent, Set<String> fontParent) Constructs new PBImageXObjectFeaturesObject
static PBInfoDictFeaturesObject	createInfoDictFeaturesObject(PDDocumentInformation info) Creates new PBInfoDictFeaturesObject
static PBLowLvlInfoFeaturesObject	createLowLvlInfoFeaturesObject(COSDocument document) Creates new PBLowLvlInfoFeaturesObject
static PBMetadataFeaturesObject	createMetadataFeaturesObject(PDMetadata metadata) Creates new PBMetadataFeaturesObject
static PBOutlinesFeaturesObject	createOutlinesFeaturesObject(PDDocumentOutline outlines) Creates new PBOutlinesFeaturesObject
static PBOutputIntentsFeaturesObject	createOutputIntentFeaturesObject(PDOutputIntent outInt, String id, String iccProfileID) Creates new PBOutputIntentsFeaturesObject
static PBPageFeaturesObject	createPageFeaturesObject(PDPage page, String thumb, Set<String> annotsId, Set<String> extGStateChild, Set<String> colorSpaceChild, Set<String> patternChild, Set<String> shadingChild, Set<String> xobjectChild, Set<String> fontChild, Set<String> propertiesChild, String id, int index) Creates new PBPageFeaturesObject
static PBPostScriptXObjectFeaturesObject	createPostScriptXObjectFeaturesObject(String id, Set<String> pageParent, Set<String> patternParent, Set<String> xobjectParent, Set<String> fontParent) Constructs new PBPostScriptXObjectFeaturesObject
static PBPropertiesDictFeaturesObject	createPropertiesDictFeaturesObject(COSDictionary properties, String id, Set<String> pageParent, Set<String> patternParent, Set<String> xobjectParent, Set<String> fontParent) Constructs new PBPropertiesDictFeaturesObject
static PBShadingFeaturesObject	createShadingFeaturesObject(PDShading shading, String id, String colorSpaceChild, Set<String> pageParent, Set<String> patternParent, Set<String> xobjectParent, Set<String> fontParent) Constructs new PBShadingFeaturesObject
static PBShadingPatternFeaturesObject	createShadingPatternFeaturesObject(PDShadingPattern shadingPattern, String id, String shadingChild, String extGStateChild, Set<String> pageParent, Set<String> patternParent, Set<String> xobjectParent, Set<String> fontParent) Constructs new PBShadingPatternFeaturesObject
static PBSignatureFeaturesObject	createSignatureFeaturesObject(PDSignature signature) Constructs new PBSignatureFeaturesObject
static PBTilingPatternFeaturesObject	createTilingPatternFeaturesObject(PDTilingPattern tilingPattern, String id, Set<String> extGStateChild, Set<String> colorSpaceChild, Set<String> patternChild, Set<String> shadingChild, Set<String> xobjectChild, Set<String> fontChild, Set<String> propertiesChild, Set<String> pageParent, Set<String> patternParent, Set<String> xobjectParent, Set<String> fontParent) Constructs new PBTilingPatternFeaturesObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createInfoDictFeaturesObject

public static PBInfoDictFeaturesObject createInfoDictFeaturesObject(PDDocumentInformation info)

Creates new PBInfoDictFeaturesObject

Parameters:

info - PDDocumentInformation class from pdfbox, which represents a document info dictionary for feature report

Returns:

created PBInfoDictFeaturesObject

createMetadataFeaturesObject

public static PBMetadataFeaturesObject createMetadataFeaturesObject(PDMetadata metadata)

Creates new PBMetadataFeaturesObject

Parameters:

metadata - PDMetadata class from pdfbox, which represents a metadata for feature report

Returns:

created PBMetadataFeaturesObject

createDocSecurityFeaturesObject

public static PBDocSecurityFeaturesObject createDocSecurityFeaturesObject(PDEncryption encryption)

Creates new PBDocSecurityFeaturesObject

Parameters:

encryption - PDEncryption class from pdfbox, which represents an encryption for feature report

Returns:

created PBDocSecurityFeaturesObject

createLowLvlInfoFeaturesObject

public static PBLowLvlInfoFeaturesObject createLowLvlInfoFeaturesObject(COSDocument document)

Creates new PBLowLvlInfoFeaturesObject

Parameters:

document - COSDocument class from pdfbox, which represents a document for feature report

Returns:

created PBLowLvlInfoFeaturesObject

createEmbeddedFileFeaturesObject

public static PBEmbeddedFileFeaturesObject createEmbeddedFileFeaturesObject(PDComplexFileSpecification embFile,
                                                            int index)

Creates new PBEmbeddedFileFeaturesObject

Parameters:

embFile - PDComplexFileSpecification class from pdfbox, which represents a file specification with embedded file for feature report

Returns:

created PBEmbeddedFileFeaturesObject

createOutputIntentFeaturesObject

public static PBOutputIntentsFeaturesObject createOutputIntentFeaturesObject(PDOutputIntent outInt,
                                                             String id,
                                                             String iccProfileID)

Creates new PBOutputIntentsFeaturesObject

Parameters:

outInt - PDOutputIntent class from pdfbox, which represents an outputIntent for feature report

id - id of the outputIntent

iccProfileID - id of the icc profile which use in this outputIntent

Returns:

created PBOutputIntentsFeaturesObject

createOutlinesFeaturesObject

public static PBOutlinesFeaturesObject createOutlinesFeaturesObject(PDDocumentOutline outlines)

Creates new PBOutlinesFeaturesObject

Parameters:

outlines - PDPage class from pdfbox, which represents a page for feature report

Returns:

created PBOutlinesFeaturesObject

createAnnotFeaturesObject

public static PBAnnotationFeaturesObject createAnnotFeaturesObject(PDAnnotation annot,
                                                   String id,
                                                   Set<String> pages,
                                                   String parentId,
                                                   String popupId,
                                                   Set<String> formXObjects)

Creates new PBAnnotationFeaturesObject

Parameters:

annot - PDAnnotation class from pdfbox, which represents an annotation for feature report

id - page id

pages - set of pages for this annotation

parentId - parent annotation for this annotation

popupId - id of the popup annotation for this annotation

formXObjects - set of id of the form XObjects which used in appearance stream of this annotation

Returns:

created PBAnnotationFeaturesObject

createPageFeaturesObject

public static PBPageFeaturesObject createPageFeaturesObject(PDPage page,
                                            String thumb,
                                            Set<String> annotsId,
                                            Set<String> extGStateChild,
                                            Set<String> colorSpaceChild,
                                            Set<String> patternChild,
                                            Set<String> shadingChild,
                                            Set<String> xobjectChild,
                                            Set<String> fontChild,
                                            Set<String> propertiesChild,
                                            String id,
                                            int index)

Creates new PBPageFeaturesObject

Parameters:

page - pdfbox class represents page object

thumb - thumbnail image id

annotsId - set of annotations id which contains in this page

extGStateChild - set of extGState id which contains in resource dictionary of this page

colorSpaceChild - set of ColorSpace id which contains in resource dictionary of this page

patternChild - set of pattern id which contains in resource dictionary of this page

shadingChild - set of shading id which contains in resource dictionary of this page

xobjectChild - set of XObject id which contains in resource dictionary of this page

fontChild - set of font id which contains in resource dictionary of this page

propertiesChild - set of properties id which contains in resource dictionary of this page

id - page id

index - page index

Returns:

created PBPageFeaturesObject

createICCProfileFeaturesObject

public static PBICCProfileFeaturesObject createICCProfileFeaturesObject(COSStream profile,
                                                        String id,
                                                        Set<String> outInts,
                                                        Set<String> iccBaseds)

Creates new PBICCProfileFeaturesObject

Parameters:

profile - COSStream which represents the icc profile for feature report

id - id of the profile

outInts - set of ids of all parent output intents for this icc profile

iccBaseds - set of ids of all parent icc based color spaces for this icc profile

Returns:

created PBICCProfileFeaturesObject

createExtGStateFeaturesObject

public static PBExtGStateFeaturesObject createExtGStateFeaturesObject(PDExtendedGraphicsState exGState,
                                                      String id,
                                                      String fontChildID,
                                                      Set<String> pageParentsID,
                                                      Set<String> patternParentsID,
                                                      Set<String> xobjectParentsID,
                                                      Set<String> fontParentsID)

Creates new PBExtGStateFeaturesObject

Parameters:

exGState - PDExtendedGraphicsState which represents extended graphics state for feature report

id - id of the object

fontChildID - id of the font child

pageParentsID - set of page ids which contains the given extended graphics state as its resources

patternParentsID - set of pattern ids which contains the given extended graphics state as its resources

xobjectParentsID - set of xobject ids which contains the given extended graphics state as its resources

fontParentsID - set of font ids which contains the given extended graphics state as its resources

Returns:

created PBExtGStateFeaturesObject

createColorSpaceFeaturesObject

public static PBColorSpaceFeaturesObject createColorSpaceFeaturesObject(PDColorSpace colorSpace,
                                                        String id,
                                                        String iccProfileChild,
                                                        String colorSpaceChild,
                                                        Set<String> pageParents,
                                                        Set<String> colorSpaceParents,
                                                        Set<String> patternParents,
                                                        Set<String> shadingParents,
                                                        Set<String> xobjectParents,
                                                        Set<String> fontParents)

Constructs new PBColorSpaceFeaturesObject

Parameters:

colorSpace - PDColorSpace which represents colorspace for feature report

id - id of the object

iccProfileChild - id of the iccprofile child

colorSpaceChild - id of the colorspace child

pageParents - set of page ids which contains the given colorspace as its resources

colorSpaceParents - set of colorspace ids which contains the given colorspace as its resources

patternParents - set of pattern ids which contains the given colorspace as its resources

shadingParents - set of shading ids which contains the given colorspace as its resources

xobjectParents - set of xobject ids which contains the given colorspace as its resources

fontParents - set of font ids which contains the given colorspace as its resources

Returns:

created PBColorSpaceFeaturesObject

createTilingPatternFeaturesObject

public static PBTilingPatternFeaturesObject createTilingPatternFeaturesObject(PDTilingPattern tilingPattern,
                                                              String id,
                                                              Set<String> extGStateChild,
                                                              Set<String> colorSpaceChild,
                                                              Set<String> patternChild,
                                                              Set<String> shadingChild,
                                                              Set<String> xobjectChild,
                                                              Set<String> fontChild,
                                                              Set<String> propertiesChild,
                                                              Set<String> pageParent,
                                                              Set<String> patternParent,
                                                              Set<String> xobjectParent,
                                                              Set<String> fontParent)

Constructs new PBTilingPatternFeaturesObject

Parameters:

tilingPattern - PDTilingPattern which represents tilling pattern for feature report

id - id of the object

extGStateChild - set of external graphics state id which contains in resource dictionary of this pattern

colorSpaceChild - set of ColorSpace id which contains in resource dictionary of this pattern

patternChild - set of pattern id which contains in resource dictionary of this pattern

shadingChild - set of shading id which contains in resource dictionary of this pattern

xobjectChild - set of XObject id which contains in resource dictionary of this pattern

fontChild - set of font id which contains in resource dictionary of this pattern

propertiesChild - set of properties id which contains in resource dictionary of this pattern

pageParent - set of page ids which contains the given pattern as its resources

patternParent - set of pattern ids which contains the given pattern as its resources

xobjectParent - set of xobject ids which contains the given pattern as its resources

fontParent - set of font ids which contains the given pattern as its resources

Returns:

created PBTilingPatternFeaturesObject

createShadingPatternFeaturesObject

public static PBShadingPatternFeaturesObject createShadingPatternFeaturesObject(PDShadingPattern shadingPattern,
                                                                String id,
                                                                String shadingChild,
                                                                String extGStateChild,
                                                                Set<String> pageParent,
                                                                Set<String> patternParent,
                                                                Set<String> xobjectParent,
                                                                Set<String> fontParent)

Constructs new PBShadingPatternFeaturesObject

Parameters:

shadingPattern - PDShadingPattern which represents shading pattern for feature report

id - id of the object

extGStateChild - external graphics state id which contains in this shading pattern

shadingChild - shading id which contains in this shading pattern

pageParent - set of page ids which contains the given pattern as its resources

patternParent - set of pattern ids which contains the given pattern as its resources

xobjectParent - set of xobject ids which contains the given pattern as its resources

fontParent - set of font ids which contains the given pattern as its resources

Returns:

created PBShadingPatternFeaturesObject

createShadingFeaturesObject

public static PBShadingFeaturesObject createShadingFeaturesObject(PDShading shading,
                                                  String id,
                                                  String colorSpaceChild,
                                                  Set<String> pageParent,
                                                  Set<String> patternParent,
                                                  Set<String> xobjectParent,
                                                  Set<String> fontParent)

Constructs new PBShadingFeaturesObject

Parameters:

shading - PDShading which represents shading for feature report

id - id of the object

colorSpaceChild - colorSpace id which contains in this shading pattern

pageParent - set of page ids which contains the given shading as its resources

patternParent - set of pattern ids which contains the given shading as its resources

xobjectParent - set of xobject ids which contains the given shading as its resources

fontParent - set of font ids which contains the given shading as its resources

Returns:

created PBShadingFeaturesObject

createImageXObjectFeaturesObject

public static PBImageXObjectFeaturesObject createImageXObjectFeaturesObject(PDImageXObjectProxy imageXObject,
                                                            String id,
                                                            String colorSpaceChild,
                                                            String maskChild,
                                                            String sMaskChild,
                                                            Set<String> alternatesChild,
                                                            Set<String> pageParent,
                                                            Set<String> patternParent,
                                                            Set<String> xobjectParent,
                                                            Set<String> fontParent)

Constructs new PBImageXObjectFeaturesObject

Parameters:

imageXObject - PDImageXObject which represents image xobject for feature report

id - id of the object

colorSpaceChild - colorSpace id which contains in this image xobject

maskChild - image xobject id which contains in this image xobject as it's mask

sMaskChild - image xobject id which contains in this image xobject as it's smask

alternatesChild - set of image xobject ids which contains in this image xobject as alternates

pageParent - set of page ids which contains the given image xobject as its resources

patternParent - set of pattern ids which contains the given image xobject state as its resources

xobjectParent - set of xobject ids which contains the given image xobject state as its resources

fontParent - set of font ids which contains the given image xobject state as its resources

Returns:

created PBImageXObjectFeaturesObject

createFormXObjectFeaturesObject

public static PBFormXObjectFeaturesObject createFormXObjectFeaturesObject(PDFormXObject formXObject,
                                                          String id,
                                                          String groupChild,
                                                          Set<String> extGStateChild,
                                                          Set<String> colorSpaceChild,
                                                          Set<String> patternChild,
                                                          Set<String> shadingChild,
                                                          Set<String> xobjectChild,
                                                          Set<String> fontChild,
                                                          Set<String> propertiesChild,
                                                          Set<String> pageParent,
                                                          Set<String> annotationParent,
                                                          Set<String> patternParent,
                                                          Set<String> xobjectParent,
                                                          Set<String> fontParent)

Constructs new PBFormXObjectFeaturesObject

Parameters:

formXObject - PDFormXObject which represents form xobject for feature report

id - id of the object

groupChild - id of the group xobject which contains in the given form xobject

extGStateChild - set of external graphics state id which contains in resource dictionary of this xobject

colorSpaceChild - set of ColorSpace id which contains in resource dictionary of this xobject

patternChild - set of pattern id which contains in resource dictionary of this xobject

shadingChild - set of shading id which contains in resource dictionary of this xobject

xobjectChild - set of XObject id which contains in resource dictionary of this xobject

fontChild - set of font id which contains in resource dictionary of this pattern

propertiesChild - set of properties id which contains in resource dictionary of this xobject

pageParent - set of page ids which contains the given xobject as its resources

annotationParent - set of annotation ids which contains the given xobject in its appearance dictionary

patternParent - set of pattern ids which contains the given xobject as its resources

xobjectParent - set of xobject ids which contains the given xobject as its resources

fontParent - set of font ids which contains the given xobject as its resources

Returns:

created PBFormXObjectFeaturesObject

createFontFeaturesObject

public static PBFontFeaturesObject createFontFeaturesObject(PDFontLike fontLike,
                                            String id,
                                            Set<String> extGStateChild,
                                            Set<String> colorSpaceChild,
                                            Set<String> patternChild,
                                            Set<String> shadingChild,
                                            Set<String> xobjectChild,
                                            Set<String> fontChild,
                                            Set<String> propertiesChild,
                                            Set<String> extGStateParent,
                                            Set<String> pageParent,
                                            Set<String> patternParent,
                                            Set<String> xobjectParent,
                                            Set<String> fontParent)

Constructs new PBFontFeaturesObject

Parameters:

fontLike - PDFontLike which represents font for feature report

id - id of the object

extGStateChild - set of external graphics state id which contains in resource dictionary of this font

colorSpaceChild - set of ColorSpace id which contains in resource dictionary of this font

patternChild - set of pattern id which contains in resource dictionary of this font

shadingChild - set of shading id which contains in resource dictionary of this font

xobjectChild - set of XObject id which contains in resource dictionary of this font

fontChild - set of font id which contains in resource dictionary of this font

propertiesChild - set of properties id which contains in resource dictionary of this font

pageParent - set of page ids which contains the given font as its resources

extGStateParent - set of graphicsState ids which contains the given font as their resource

patternParent - set of pattern ids which contains the given font as its resources

xobjectParent - set of xobject ids which contains the given font as its resources

fontParent - set of font ids which contains the given font as its resources

Returns:

created PBFontFeaturesObject

createPropertiesDictFeaturesObject

public static PBPropertiesDictFeaturesObject createPropertiesDictFeaturesObject(COSDictionary properties,
                                                                String id,
                                                                Set<String> pageParent,
                                                                Set<String> patternParent,
                                                                Set<String> xobjectParent,
                                                                Set<String> fontParent)

Constructs new PBPropertiesDictFeaturesObject

Parameters:

properties - COSDictionary which represents properties for feature report

id - id of the object

pageParent - set of page ids which contains the given properties as its resources

patternParent - set of pattern ids which contains the given properties as its resources

xobjectParent - set of xobject ids which contains the given properties as its resources

fontParent - set of font ids which contains the given properties as its resources

Returns:

created PBPropertiesDictFeaturesObject

createPostScriptXObjectFeaturesObject

public static PBPostScriptXObjectFeaturesObject createPostScriptXObjectFeaturesObject(String id,
                                                                      Set<String> pageParent,
                                                                      Set<String> patternParent,
                                                                      Set<String> xobjectParent,
                                                                      Set<String> fontParent)

Constructs new PBPostScriptXObjectFeaturesObject

Parameters:

id - id of the object

pageParent - set of page ids which contains the given xobject as its resources

patternParent - set of pattern ids which contains the given xobject as its resources

xobjectParent - set of xobject ids which contains the given xobject as its resources

fontParent - set of font ids which contains the given xobject as its resources

Returns:

created PBPostScriptXObjectFeaturesObject

createSignatureFeaturesObject

public static PBSignatureFeaturesObject createSignatureFeaturesObject(PDSignature signature)

Constructs new PBSignatureFeaturesObject

Parameters:

signature - pdfbox signature object

Returns:

created PBSignatureFeaturesObject