Package net.webpdf.wsclient.schema.operation

Class ConverterType

  • All Implemented Interfaces:
    ParameterInterface
    public class ConverterType
extends Object
implements ParameterInterface
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Performs the conversion of a document.</p>

    Java class for ConverterType complex type

    .

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

    
 <complexType name="ConverterType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <all>
         <element name="page" type="{http://schema.webpdf.de/1.0/operation}ConverterPageType" minOccurs="0"/>
         <element name="pdfa" type="{http://schema.webpdf.de/1.0/operation}PdfaType" minOccurs="0"/>
         <element name="signature" type="{http://schema.webpdf.de/1.0/operation}SignatureType" minOccurs="0"/>
         <element name="html" type="{http://schema.webpdf.de/1.0/operation}ConverterHtmlType" minOccurs="0"/>
         <element name="mail" type="{http://schema.webpdf.de/1.0/operation}ConverterMailType" minOccurs="0"/>
         <element name="officeBridge" type="{http://schema.webpdf.de/1.0/operation}OfficeBridgeType" minOccurs="0"/>
         <element name="sharePointBridge" type="{http://schema.webpdf.de/1.0/operation}SharePointBridgeType" minOccurs="0"/>
         <element name="report" type="{http://schema.webpdf.de/1.0/operation}ConverterReportType" minOccurs="0"/>
         <element name="template" type="{http://schema.webpdf.de/1.0/operation}ConverterTemplateType" minOccurs="0"/>
         <element name="text" type="{http://schema.webpdf.de/1.0/operation}ConverterTextType" minOccurs="0"/>
         <element name="transform" type="{http://schema.webpdf.de/1.0/operation}ConverterTransformType" minOccurs="0"/>
         <element name="image" type="{http://schema.webpdf.de/1.0/operation}ConverterImageType" minOccurs="0"/>
       </all>
       <attribute name="pages" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="compression" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="jpegQuality" default="90">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="0"/>
             <maxInclusive value="100"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="reduceResolution" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="dpi" default="300">
         <simpleType>
           <restriction base="{http://schema.webpdf.de/1.0/operation}DpiType">
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="embedFonts" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="accessPassword" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="fileExtension" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="maxRecursion" default="1">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="1"/>
           </restriction>
         </simpleType>
       </attribute>
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • pages

        protected String pages
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">A text that defines the page range for the export. Individual pages or a range of pages can be defined here. If the text is empty, the entire file will be exported (e.g.: "1-10" or "1,2,5-10")</p>

      • compression

        protected Boolean compression
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If "true," the data objects in the PDF document will be compressed (ZLib compression), reducing the size of the document.</p>

      • jpegQuality

        protected Integer jpegQuality
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to set the quality (as a percentage) of JPEG images in the PDF document.</p>

      • reduceResolution

        protected Boolean reduceResolution
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If "true," then the DPI resolution of graphics is reduced. The reduction value is set with "dpi."</p>

      • dpi

        protected Integer dpi
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to set the DPI solution (pixels per inch) for images.</p>

      • embedFonts

        protected Boolean embedFonts
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If "true," fonts will be embedded in the PDF document that is created.</p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>: If the original fonts are not available on the conversion system, substitute fonts may be embedded instead.
                     </p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>: If, after the conversion, you want to convert the PDF document to PDF/A, you should not embed any of the fonts, but should instead let the "Pdfa" web service do this.
                     </p>

      • accessPassword

        protected String accessPassword
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This parameter can be used to declare a password that will be used to open the source document if it is protected.</p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                         This option is currently only supported for Microsoft Office 97-2003 binary documents and Microsoft Office 2007 documents. Only the default password methods are supported. Encryption based on digital certificates is not supported.
                     </p>

      • fileExtension

        protected String fileExtension
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If you use this attribute to enter an extension for the file (e.g., "doc") that is currently being processed, automatic file format detection will be disabled. Normally, webPDF does not detect file formats based on the corresponding file extension, but on the file contents instead. Accordingly, webPDF will analyze the file and assign the file the appropriate "mime-type" so that the appropriate file converter can then be selected.</p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>: You should only set a file extension in exceptional cases, as this will completely disable automatic detection. If, for instance, you specify an extension for which webPDF does not have a "mime-type," the conversion will fail.
                     </p>

      • maxRecursion

        protected Integer maxRecursion
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Sets the maximum recursions, that may occur when converting a document's attachments.</p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                         This parameter is intended for internal use only. Please only use this, if you really are sure you need to do so.
                     </p>

    • Constructor Detail

      • ConverterType

        public ConverterType()

    • Method Detail

      • isSetPage

        public boolean isSetPage()

      • getPdfa

        public PdfaType getPdfa()
        Gets the value of the pdfa property.
        Returns:
        possible object is PdfaType

      • setPdfa

        public void setPdfa​(PdfaType value)
        Sets the value of the pdfa property.
        Parameters:
        value - allowed object is PdfaType

      • isSetPdfa

        public boolean isSetPdfa()

      • getSignature

        public SignatureType getSignature()
        Gets the value of the signature property.
        Returns:
        possible object is SignatureType

      • setSignature

        public void setSignature​(SignatureType value)
        Sets the value of the signature property.
        Parameters:
        value - allowed object is SignatureType

      • isSetSignature

        public boolean isSetSignature()

      • isSetHtml

        public boolean isSetHtml()

      • isSetMail

        public boolean isSetMail()

      • setOfficeBridge

        public void setOfficeBridge​(OfficeBridgeType value)
        Sets the value of the officeBridge property.
        Parameters:
        value - allowed object is OfficeBridgeType

      • isSetOfficeBridge

        public boolean isSetOfficeBridge()

      • isSetSharePointBridge

        public boolean isSetSharePointBridge()

      • isSetReport

        public boolean isSetReport()

      • isSetTemplate

        public boolean isSetTemplate()

      • isSetText

        public boolean isSetText()

      • isSetTransform

        public boolean isSetTransform()

      • isSetImage

        public boolean isSetImage()

      • getPages

        public String getPages()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">A text that defines the page range for the export. Individual pages or a range of pages can be defined here. If the text is empty, the entire file will be exported (e.g.: "1-10" or "1,2,5-10")</p>
        Returns:
        possible object is String

      • setPages

        public void setPages​(String value)
        Sets the value of the pages property.
        Parameters:
        value - allowed object is String
        See Also:
        getPages()

      • isSetPages

        public boolean isSetPages()

      • isCompression

        public boolean isCompression()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If "true," the data objects in the PDF document will be compressed (ZLib compression), reducing the size of the document.</p>
        Returns:
        possible object is Boolean

      • setCompression

        public void setCompression​(boolean value)
        Sets the value of the compression property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isCompression()

      • isSetCompression

        public boolean isSetCompression()

      • unsetCompression

        public void unsetCompression()

      • getJpegQuality

        public int getJpegQuality()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to set the quality (as a percentage) of JPEG images in the PDF document.</p>
        Returns:
        possible object is Integer

      • setJpegQuality

        public void setJpegQuality​(int value)
        Sets the value of the jpegQuality property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getJpegQuality()

      • isSetJpegQuality

        public boolean isSetJpegQuality()

      • unsetJpegQuality

        public void unsetJpegQuality()

      • isReduceResolution

        public boolean isReduceResolution()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If "true," then the DPI resolution of graphics is reduced. The reduction value is set with "dpi."</p>
        Returns:
        possible object is Boolean

      • setReduceResolution

        public void setReduceResolution​(boolean value)
        Sets the value of the reduceResolution property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isReduceResolution()

      • isSetReduceResolution

        public boolean isSetReduceResolution()

      • unsetReduceResolution

        public void unsetReduceResolution()

      • getDpi

        public int getDpi()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to set the DPI solution (pixels per inch) for images.</p>
        Returns:
        possible object is Integer

      • setDpi

        public void setDpi​(int value)
        Sets the value of the dpi property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getDpi()

      • isSetDpi

        public boolean isSetDpi()

      • unsetDpi

        public void unsetDpi()

      • isEmbedFonts

        public boolean isEmbedFonts()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If "true," fonts will be embedded in the PDF document that is created.</p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>: If the original fonts are not available on the conversion system, substitute fonts may be embedded instead.
                     </p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>: If, after the conversion, you want to convert the PDF document to PDF/A, you should not embed any of the fonts, but should instead let the "Pdfa" web service do this.
                     </p>
        Returns:
        possible object is Boolean

      • setEmbedFonts

        public void setEmbedFonts​(boolean value)
        Sets the value of the embedFonts property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isEmbedFonts()

      • isSetEmbedFonts

        public boolean isSetEmbedFonts()

      • unsetEmbedFonts

        public void unsetEmbedFonts()

      • getAccessPassword

        public String getAccessPassword()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This parameter can be used to declare a password that will be used to open the source document if it is protected.</p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                         This option is currently only supported for Microsoft Office 97-2003 binary documents and Microsoft Office 2007 documents. Only the default password methods are supported. Encryption based on digital certificates is not supported.
                     </p>
        Returns:
        possible object is String

      • setAccessPassword

        public void setAccessPassword​(String value)
        Sets the value of the accessPassword property.
        Parameters:
        value - allowed object is String
        See Also:
        getAccessPassword()

      • isSetAccessPassword

        public boolean isSetAccessPassword()

      • getFileExtension

        public String getFileExtension()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If you use this attribute to enter an extension for the file (e.g., "doc") that is currently being processed, automatic file format detection will be disabled. Normally, webPDF does not detect file formats based on the corresponding file extension, but on the file contents instead. Accordingly, webPDF will analyze the file and assign the file the appropriate "mime-type" so that the appropriate file converter can then be selected.</p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>: You should only set a file extension in exceptional cases, as this will completely disable automatic detection. If, for instance, you specify an extension for which webPDF does not have a "mime-type," the conversion will fail.
                     </p>
        Returns:
        possible object is String

      • setFileExtension

        public void setFileExtension​(String value)
        Sets the value of the fileExtension property.
        Parameters:
        value - allowed object is String
        See Also:
        getFileExtension()

      • isSetFileExtension

        public boolean isSetFileExtension()

      • getMaxRecursion

        public int getMaxRecursion()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Sets the maximum recursions, that may occur when converting a document's attachments.</p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                         This parameter is intended for internal use only. Please only use this, if you really are sure you need to do so.
                     </p>
        Returns:
        possible object is Integer

      • setMaxRecursion

        public void setMaxRecursion​(int value)
        Sets the value of the maxRecursion property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getMaxRecursion()

      • isSetMaxRecursion

        public boolean isSetMaxRecursion()

      • unsetMaxRecursion

        public void unsetMaxRecursion()