fr.opensagres.xdocreport.document.tools
Class Tools

java.lang.Object
  fr.opensagres.xdocreport.document.Generator<Request,Response>
      fr.opensagres.xdocreport.document.tools.Tools

public class Tools
extends Generator<Request,Response>

Field Summary

Fields inherited from class fr.opensagres.xdocreport.document.Generator

CONVERTER_ID_HTTP_PARAM, DISPATCH_HTTP_PARAM, DOWNLOAD_DISPATCH, ENTRY_NAME_HTTP_PARAM, PROCESS_STATE_HTTP_PARAM, REMOVE_DISPATCH, REPORT_ID_HTTP_PARAM, TEMPLATE_ENGINE_ID_HTTP_PARAM, TEMPLATE_ENGINE_KIND_HTTP_PARAM, VIEW_DISPATCH

Constructor Summary

Tools()

Method Summary

protected void	error(Request request, Response response, Exception cause) Invoked when there is an error thrown in any part of doRequest() processing.
protected FieldsMetadata	getFieldsMetadata(String reportId, Request request)
static Tools	getInstance()
protected OutputStream	getOutputStream(Response response)
protected String	getParameter(Request request, String name)
protected InputStream	getSourceStream(String reportId, Request request) Returns input stream of the report to load identified with reportId.
protected void	populateContext(IContext context, String reportId, Request request) Put the Java model in the context for the report reportId.
protected void	prepareHTTPResponse(String id, MimeMapping mimeMapping, Request request, Response response)
protected void	prepareHTTPResponse(String reportId, String entryName, Request request, Response response)
void	process(File in, File out, String templateEngineKind, FieldsMetadata fieldsMetadata, Iterable<IDataProvider> dataProviders)
void	process(File in, File out, TemplateEngineKind templateEngineKind, FieldsMetadata fieldsMetadata, Iterable<IDataProvider> dataProviders)
void	process(InputStream in, OutputStream out, String templateEngineKind, FieldsMetadata fieldsMetadata, Iterable<IDataProvider> dataProviders)

Methods inherited from class fr.opensagres.xdocreport.document.Generator

doDocumentArchive, doGenerateReport, doRedirectAfterRemoveReport, doRemoveReport, doSaveEntry, doSaveReport, getConverterId, getDispatchParameter, getEntryName, getOptionsConverter, getProcessState, getRegistry, getReport, getReportId, getTemplateEngine, getTemplateEngine, getTemplateEngine, getTemplateEngineId, getTemplateEngineKind, getTemplateEngineKind, isCacheOriginalDocument, isGenerateContentDisposition, loadReport, prepareOptions, processRequest

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Tools

public Tools()

Method Detail

getInstance

public static Tools getInstance()

process

public void process(File in,
                    File out,
                    TemplateEngineKind templateEngineKind,
                    FieldsMetadata fieldsMetadata,
                    Iterable<IDataProvider> dataProviders)
             throws Exception

Throws:

Exception

process

public void process(File in,
                    File out,
                    String templateEngineKind,
                    FieldsMetadata fieldsMetadata,
                    Iterable<IDataProvider> dataProviders)
             throws Exception

Throws:

Exception

process

public void process(InputStream in,
                    OutputStream out,
                    String templateEngineKind,
                    FieldsMetadata fieldsMetadata,
                    Iterable<IDataProvider> dataProviders)
             throws Exception

Throws:

Exception

error

protected void error(Request request,
                     Response response,
                     Exception cause)

Description copied from class: Generator

Invoked when there is an error thrown in any part of doRequest() processing.

Default will send a simple HTML response indicating there was a problem.

Specified by:

error in class Generator<Request,Response>

Parameters:

request - original In from servlet container.

response - Out object from servlet container.

cause - Exception that was thrown by some other part of process.

getSourceStream

protected InputStream getSourceStream(String reportId,
                                      Request request)
                               throws IOException,
                                      XDocReportException

Description copied from class: Generator

Returns input stream of the report to load identified with reportId.

Specified by:

getSourceStream in class Generator<Request,Response>

Parameters:

reportId - report id.

request - Http servlet request context.

Returns:

Throws:

IOException

XDocReportException

populateContext

protected void populateContext(IContext context,
                               String reportId,
                               Request request)
                        throws IOException,
                               XDocReportException

Description copied from class: Generator

Put the Java model in the context for the report reportId.

Specified by:

populateContext in class Generator<Request,Response>

Parameters:

context - XDocReport context to register Java data model.

reportId - report id.

request - Http servlet request context.

Throws:

IOException

XDocReportException

getOutputStream

protected OutputStream getOutputStream(Response response)
                                throws IOException

Specified by:

getOutputStream in class Generator<Request,Response>

Throws:

IOException

getParameter

protected String getParameter(Request request,
                              String name)

Specified by:

getParameter in class Generator<Request,Response>

prepareHTTPResponse

protected void prepareHTTPResponse(String id,
                                   MimeMapping mimeMapping,
                                   Request request,
                                   Response response)

Specified by:

prepareHTTPResponse in class Generator<Request,Response>

prepareHTTPResponse

protected void prepareHTTPResponse(String reportId,
                                   String entryName,
                                   Request request,
                                   Response response)

Specified by:

prepareHTTPResponse in class Generator<Request,Response>

getFieldsMetadata

protected FieldsMetadata getFieldsMetadata(String reportId,
                                           Request request)

Overrides:

getFieldsMetadata in class Generator<Request,Response>