Package com.pdftools.pdfa.conversion

Class ConversionOptions

    • Constructor Detail

      • ConversionOptions

        public ConversionOptions()

    • Method Detail

      • getConformance

        public Conformance getConformance()

        The minimal target conformance (Getter)

        If a conformance is set, it is used as the minimal target conformance. The PDF/A version of the conformance must match the PDF/A version of the analysisOptions of pdftools.pdfa.validation.Validator.analyze. If the conformance level cannot be achieved, the conversion will abort with the error ConformanceException. If a higher conformance level can be achieved, it is used automatically.

        If null is used, the optimal conformance determined in the analysis (i.e. pdftools.pdfa.validation.AnalysisResult.getRecommendedConformance) is used. It is highly recommended to use null.

        Default value: null

      • setConformance

        public void setConformance​(Conformance value)

        The minimal target conformance (Setter)

        If a conformance is set, it is used as the minimal target conformance. The PDF/A version of the conformance must match the PDF/A version of the analysisOptions of pdftools.pdfa.validation.Validator.analyze. If the conformance level cannot be achieved, the conversion will abort with the error ConformanceException. If a higher conformance level can be achieved, it is used automatically.

        If null is used, the optimal conformance determined in the analysis (i.e. pdftools.pdfa.validation.AnalysisResult.getRecommendedConformance) is used. It is highly recommended to use null.

        Default value: null

      • getCopyMetadata

        public boolean getCopyMetadata()

        Whether to copy metadata (Getter)

        Copy document information dictionary and XMP metadata. Default: true.

      • setCopyMetadata

        public void setCopyMetadata​(boolean value)

        Whether to copy metadata (Setter)

        Copy document information dictionary and XMP metadata. Default: true.

      • getImageQuality

        public double getImageQuality()

        Image quality of recompressed images (Getter)

        The image quality for images that use a prohibited lossy compression type and must be recompressed. Supported values are 0.01 to 1.0. A higher value means better visual quality at the cost of a larger file size. Recommended values range from 0.7 to 0.9.

        Example: JPX (JPEG2000) is not allowed in PDF/A-1. If a PDF contains a JPX compressed image, its compression type must be altered. Thus the image is converted to an image with JPEG compression using the image quality defined by this property. Copy document information dictionary and XMP metadata. Default value: 0.8

      • setImageQuality

        public void setImageQuality​(double value)

        Image quality of recompressed images (Setter)

        The image quality for images that use a prohibited lossy compression type and must be recompressed. Supported values are 0.01 to 1.0. A higher value means better visual quality at the cost of a larger file size. Recommended values range from 0.7 to 0.9.

        Example: JPX (JPEG2000) is not allowed in PDF/A-1. If a PDF contains a JPX compressed image, its compression type must be altered. Thus the image is converted to an image with JPEG compression using the image quality defined by this property. Copy document information dictionary and XMP metadata. Default value: 0.8

        Throws:
        java.lang.IllegalArgumentException - The given value is smaller than 0.1 or greater than 1.