Class JRXmlTemplateWriter

    • Field Detail

      • JASPERTEMPLATE_NAMESPACE

        public static final XmlNamespace JASPERTEMPLATE_NAMESPACE
      • DEFAULT_ENCODING

        public static final java.lang.String DEFAULT_ENCODING
        Default XML output encoding.
        See Also:
        Constant Field Values
    • Constructor Detail

      • JRXmlTemplateWriter

        public JRXmlTemplateWriter​(JRTemplate template,
                                   java.io.Writer out,
                                   java.lang.String encoding)
        Creates an XML template writer.
        Parameters:
        template - the template to write
        out - the output writer
        encoding - the XML encoding to use
      • JRXmlTemplateWriter

        public JRXmlTemplateWriter​(JasperReportsContext jasperReportsContext,
                                   JRTemplate template,
                                   java.io.Writer out,
                                   java.lang.String encoding)
        Creates an XML template writer.
        Parameters:
        jasperReportsContext -
        template - the template to write
        out - the output writer
        encoding - the XML encoding to use
    • Method Detail

      • writeTemplate

        public static java.lang.String writeTemplate​(JRTemplate template)
        Returns the XML representation of a template.

        Uses the default encoding.

        Parameters:
        template - the template
        Returns:
        the XML representation of the template
      • writeTemplate

        public static java.lang.String writeTemplate​(JasperReportsContext jasperReportsContext,
                                                     JRTemplate template)
        Returns the XML representation of a template.

        Uses the default encoding.

        Parameters:
        jasperReportsContext -
        template - the template
        Returns:
        the XML representation of the template
      • writeTemplate

        public static java.lang.String writeTemplate​(JRTemplate template,
                                                     java.lang.String encoding)
        Returns the XML representation of a template.
        Parameters:
        template - the template
        encoding - the XML encoding to use
        Returns:
        the XML representation of the template
      • writeTemplate

        public static java.lang.String writeTemplate​(JasperReportsContext jasperReportsContext,
                                                     JRTemplate template,
                                                     java.lang.String encoding)
        Returns the XML representation of a template.
        Parameters:
        jasperReportsContext -
        template - the template
        encoding - the XML encoding to use
        Returns:
        the XML representation of the template
      • writeTemplate

        public static void writeTemplate​(JRTemplate template,
                                         java.io.OutputStream out)
        Writes the XML representation of a template to an output stream.

        Uses the default encoding.

        Parameters:
        template - the template
        out - the output stream
      • writeTemplate

        public static void writeTemplate​(JasperReportsContext jasperReportsContext,
                                         JRTemplate template,
                                         java.io.OutputStream out)
        Writes the XML representation of a template to an output stream.

        Uses the default encoding.

        Parameters:
        jasperReportsContext -
        template - the template
        out - the output stream
      • writeTemplate

        public static void writeTemplate​(JRTemplate template,
                                         java.io.OutputStream out,
                                         java.lang.String encoding)
        Writes the XML representation of a template to an output stream.
        Parameters:
        template - the template
        out - the output stream
        encoding - the XML encoding to use
      • writeTemplate

        public static void writeTemplate​(JasperReportsContext jasperReportsContext,
                                         JRTemplate template,
                                         java.io.OutputStream out,
                                         java.lang.String encoding)
        Writes the XML representation of a template to an output stream.
        Parameters:
        jasperReportsContext -
        template - the template
        out - the output stream
        encoding - the XML encoding to use
      • writeTemplateToFile

        public static void writeTemplateToFile​(JRTemplate template,
                                               java.lang.String outputFile)
        Writes the XML representation of a template to a file.

        Uses the default encoding.

        Parameters:
        template - the template
        outputFile - the output file name
      • writeTemplateToFile

        public static void writeTemplateToFile​(JasperReportsContext jasperReportsContext,
                                               JRTemplate template,
                                               java.lang.String outputFile)
        Writes the XML representation of a template to a file.

        Uses the default encoding.

        Parameters:
        jasperReportsContext -
        template - the template
        outputFile - the output file name
      • writeTemplateToFile

        public static void writeTemplateToFile​(JRTemplate template,
                                               java.lang.String outputFile,
                                               java.lang.String encoding)
        Writes the XML representation of a template to a file.
        Parameters:
        template - the template
        outputFile - the output file name
        encoding - the XML encoding to use
      • writeTemplateToFile

        public static void writeTemplateToFile​(JasperReportsContext jasperReportsContext,
                                               JRTemplate template,
                                               java.lang.String outputFile,
                                               java.lang.String encoding)
        Writes the XML representation of a template to a file.
        Parameters:
        jasperReportsContext -
        template - the template
        outputFile - the output file name
        encoding - the XML encoding to use
      • writeTemplate

        protected static void writeTemplate​(JasperReportsContext jasperReportsContext,
                                            JRTemplate template,
                                            java.io.Writer out,
                                            java.lang.String encoding)
                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • write

        public void write()
                   throws java.io.IOException
        Writes the template to the output writer.
        Throws:
        java.io.IOException
      • writeIncludedTemplates

        protected void writeIncludedTemplates()
                                       throws java.io.IOException
        Throws:
        java.io.IOException
      • writeIncludedTemplate

        protected void writeIncludedTemplate​(JRTemplateReference reference)
                                      throws java.io.IOException
        Throws:
        java.io.IOException
      • writeStyles

        protected void writeStyles()
                            throws java.io.IOException
        Throws:
        java.io.IOException
      • toWriteConditionalStyles

        protected boolean toWriteConditionalStyles()
        Description copied from class: JRXmlBaseWriter
        Decides whether conditional styles are to be written.
        Specified by:
        toWriteConditionalStyles in class JRXmlBaseWriter
        Returns:
        whether conditional styles are to be written