Package net.webpdf.wsclient.openapi

Class OperationExtractionImages

  • public class OperationExtractionImages
extends Object
    Extract the PDF document's image contents Generates a ZIP file that is returned as a result when the web service is called. This file will contain all the images contained at the page level in a freely selectable page range. **Important:** The images mode can only be used to extract raster graphics (bitmap images). The extraction vector graphics, as well as the rendering of vector graphics based on vectorial drawing paths, is not supported. **Important:** Due to licensing reasons, the images mode currently only supports the extraction of basic JPEG2000 images that conform to the part-1 core coding system definition in ISO/IEC 15444-1. **Important:** It cannot be guaranteed that an image will be exported in its original source format, as the image may have already been converted when embedded in the PDF (this depends on whether the source format was supported by the PDF standard and on the application that was used to embed the image).

    • Constructor Detail

      • OperationExtractionImages

        public OperationExtractionImages()

    • Method Detail

      • getFallbackFormat

        @Nullable
public @Nullable OperationExtractionImages.FallbackFormatEnum getFallbackFormat()
        Used to specify the format that should be used as the fallback format if extracting an image would result in a format that is not supported. * png = PNG file * jpeg = JPEG file
        Returns:
        fallbackFormat

      • getFileFormat

        @Nullable
public @Nullable OperationExtractionImages.FileFormatEnum getFileFormat()
        Used to define the output format for the PDF document text contents being extracted. * text = Text document * xml = XML document * json = JSON data structure
        Returns:
        fileFormat

      • getFileNameTemplate

        @Nullable
public @Nullable String getFileNameTemplate()
        Used to set the template for the image files in the returned ZIP file. \"file\\[%d\\]\", for example, would result in a \"file\\[1\\].png\" entry for a PNG image.
        Returns:
        fileNameTemplate

      • setFileNameTemplate

        public void setFileNameTemplate​(String fileNameTemplate)

      • getFolderNameTemplate

        @Nullable
public @Nullable String getFolderNameTemplate()
        Used to set the template for the page folders in the returned ZIP file. \"page\\[%d\\]\", for example, would result in a folder called \"page\\[1\\]\" for page 1, etc.
        Returns:
        folderNameTemplate

      • setFolderNameTemplate

        public void setFolderNameTemplate​(String folderNameTemplate)

      • getPages

        @Nullable
public @Nullable String getPages()
        Used to define which page(s) should be used for the image's mode. The page number can be an individual page, a page range, or a list (separated with commas) (e.g., \"1,5-6,9\"). A blank value or \"\\*\" selects all pages of the PDF document.
        Returns:
        pages

      • setPages

        public void setPages​(String pages)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object