Package net.webpdf.wsclient.schema.operation

Class ExtractionImagesType

  • public class ExtractionImagesType
extends ResourceExtractionType
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Extract the PDF document's image contents</p>
 
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>
 
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><p><b>Important:</b>
                         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.
                     </p><p><b>Important:</b>
                         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.
                     </p><p><b>Important:</b>
                         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).
                     </p></p>

    Java class for ExtractionImagesType complex type

    .

    The following schema fragment specifies the expected content contained within this class.

    
 <complexType name="ExtractionImagesType">
   <complexContent>
     <extension base="{http://schema.webpdf.de/1.0/operation}ResourceExtractionType">
       <attribute name="fileNameTemplate" type="{http://www.w3.org/2001/XMLSchema}string" default="file[%d]" />
       <attribute name="folderNameTemplate" type="{http://www.w3.org/2001/XMLSchema}string" default="page[%d]" />
       <attribute name="fallbackFormat" default="png">
         <simpleType>
           <restriction base="{http://schema.webpdf.de/1.0/operation}ExtractionImageFormat">
             <enumeration value="jpeg"/>
             <enumeration value="png"/>
           </restriction>
         </simpleType>
       </attribute>
     </extension>
   </complexContent>
 </complexType>

    • Field Detail

      • fileNameTemplate

        protected String fileNameTemplate
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>

      • folderNameTemplate

        protected String folderNameTemplate
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>

      • fallbackFormat

        protected ExtractionImageFormat fallbackFormat
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.
                                 <ul><li>png = PNG file</li><li>jpeg = JPEG file</li></ul></p>

    • Constructor Detail

      • ExtractionImagesType

        public ExtractionImagesType()

    • Method Detail

      • getFileNameTemplate

        public String getFileNameTemplate()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>
        Returns:
        possible object is String

      • setFileNameTemplate

        public void setFileNameTemplate​(String value)
        Sets the value of the fileNameTemplate property.
        Parameters:
        value - allowed object is String
        See Also:
        getFileNameTemplate()

      • isSetFileNameTemplate

        public boolean isSetFileNameTemplate()

      • getFolderNameTemplate

        public String getFolderNameTemplate()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>
        Returns:
        possible object is String

      • setFolderNameTemplate

        public void setFolderNameTemplate​(String value)
        Sets the value of the folderNameTemplate property.
        Parameters:
        value - allowed object is String
        See Also:
        getFolderNameTemplate()

      • isSetFolderNameTemplate

        public boolean isSetFolderNameTemplate()

      • getFallbackFormat

        public ExtractionImageFormat getFallbackFormat()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.
                                 <ul><li>png = PNG file</li><li>jpeg = JPEG file</li></ul></p>
        Returns:
        possible object is ExtractionImageFormat

      • isSetFallbackFormat

        public boolean isSetFallbackFormat()