it.discovery.jasperreports.jasper2word.J2WDocxPoiJRExporter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jasper2docx-apache-poi Show documentation
The newest version!
package it.discovery.jasperreports.jasper2word;

import it.discovery.jasperreports.jasper2word.J2WDocxPoiHelper.J2WDocxPrintElementVisitor;
import it.discovery.jasperreports.jasper2word.J2WDocxPoiHelper.J2WDocxPrintElementVisitorContext;
import net.sf.jasperreports.engine.*;
import net.sf.jasperreports.export.OutputStreamExporterOutput;
import org.apache.poi.xwpf.usermodel.XWPFDocument;

import java.io.IOException;

/**
 * A jasper to docx implementation using poi-apache word library.
 * @author discovery
 * @date 10/08/15 11.29
 */
public class J2WDocxPoiJRExporter extends J2WAbstractJRExporter {
    /** Jasper report exporter key */
    public static final String J2W_DOCX_EXPORTER_KEY = JRPropertiesUtil.PROPERTY_PREFIX + ".j2w.poi.docx";
    /** Jasper report exporter properties prefix */
    protected static final String J2W_DOCX_EXPORTER_PROPERTIES_PREFIX = JRPropertiesUtil.PROPERTY_PREFIX + "export.j2w.poi.docx.";

    /**
     * Construct the exporter with the jasper context.
     * @param jasperReportsContext The jasper context.
     */
    public J2WDocxPoiJRExporter(JasperReportsContext jasperReportsContext) {
        super(jasperReportsContext);
    }

    @Override
    protected J2WDocxExporterContext createNewExporterContext() {
        return new SimpleJ2WDocxExporterContext();
    }

    @Override
    protected Class getConfigurationInterface() {
        return J2WExporterConfiguration.class;
    }

    @Override
    protected Class getItemConfigurationInterface() {
        return J2WReportConfiguration.class;
    }

    @Override
    protected void ensureOutput() {
        if (exporterOutput == null)
            exporterOutput = new SimpleJ2WOutputStreamExporterOutput(true);
    }

    @Override
    public String getExporterKey() {
        return J2W_DOCX_EXPORTER_KEY;
    }

    @Override
    public String getExporterPropertiesPrefix() {
        return J2W_DOCX_EXPORTER_PROPERTIES_PREFIX;
    }

    @Override
    protected J2WDocxPrintElementVisitorContext createVisitorContext() {
        return new J2WDocxPrintElementVisitorContext();
    }

    @Override
    protected PrintElementVisitor createPrintElementVisitor() {
        return new J2WDocxPrintElementVisitor(this.allSelector, this.getJasperReportsContext());
    }

    @Override
    protected void prepareDocument(J2WDocxPrintElementVisitorContext context, JasperPrint report, boolean firstReport) {
        J2WDocxPoiHelper.prepareNewDocument(firstReport, context, report);
    }

    @Override
    protected void prepareNewPage(J2WDocxPrintElementVisitorContext context, JRPrintPage jrPage, int pageNumber, PageOrder pageOrder) {
        context.resetPageStatus();
        J2WDocxPoiHelper.prepareNewPage(context, jrPage, pageNumber, pageOrder);
    }

    @Override
    protected void finalizePage(J2WDocxPrintElementVisitorContext context, JRPrintPage jrPage, int pageNumber, PageOrder pageOrder) {
        J2WDocxPoiHelper.finalizePage(context, jrPage, pageNumber, pageOrder);
    }

    /**
     * Exporter context implementation. It expose a {@link XWPFDocument document} to write into.
     */
    private class SimpleJ2WDocxExporterContext extends BaseExporterContext implements J2WDocxExporterContext {
        /** The output document */
        private XWPFDocument document;

        /**
         * Constructor.
         */
        private SimpleJ2WDocxExporterContext() {
            this.document = new XWPFDocument();
        }

        @Override
        public XWPFDocument getDocument() {
            return document;
        }

        @Override
        public void writeReport(XWPFDocument document, OutputStreamExporterOutput output) throws JRException {
            try {
                document.write(exporterOutput.getOutputStream());
                exporterOutput.close();
            } catch (IOException e) {
                throw new JRException("Write document error", e);
            }
        }
    }
}