Uses of Interface
fr.opensagres.xdocreport.document.IXDocReport

Packages that use IXDocReport

Package	Description
fr.opensagres.xdocreport.document
fr.opensagres.xdocreport.document.discovery
fr.opensagres.xdocreport.document.dump
fr.opensagres.xdocreport.document.dump.eclipse
fr.opensagres.xdocreport.document.dump.java
fr.opensagres.xdocreport.document.dump.maven
fr.opensagres.xdocreport.document.registry
fr.opensagres.xdocreport.document.web
fr.opensagres.xdocreport.document.web.dispatcher

Uses of IXDocReport in fr.opensagres.xdocreport.document

Classes in fr.opensagres.xdocreport.document that implement IXDocReport

Modifier and Type	Class	Description
class	AbstractXDocReport	Abstract class for IXDocReport to implement to manage docx, odt...

Methods in fr.opensagres.xdocreport.document that return IXDocReport

Modifier and Type	Method	Description
static IXDocReport	XDocReport.generateReport(InputStream sourceStream, String templateEngineKind, fr.opensagres.xdocreport.template.formatter.FieldsMetadata metadata, Map<String,Object> contextMap, OutputStream out)	Generate report without cache.
static IXDocReport	XDocReport.generateReport(InputStream sourceStream, String templateEngineKind, fr.opensagres.xdocreport.template.formatter.FieldsMetadata metadata, Map<String,Object> contextMap, OutputStream out, XDocReportRegistry registry)	Generate report without cache by setting the registry.
static IXDocReport	XDocReport.generateReport(String reportId, IXDocReportController controller, Map<String,Object> contextMap, OutputStream out)	Generate report by using controller to load report.
static IXDocReport	XDocReport.generateReport(String reportId, IXDocReportController controller, Map<String,Object> contextMap, OutputStream out, XDocReportRegistry registry)	Generate report by using controller to load report by setting the registry.
static IXDocReport	XDocReport.generateReport(String reportId, IXDocReportLoader reportLoader, Map<String,Object> contextMap, OutputStream out)	Generate report by using report loader to load report.
static IXDocReport	XDocReport.generateReport(String reportId, IXDocReportLoader reportLoader, Map<String,Object> contextMap, OutputStream out, XDocReportRegistry registry)	Generate report by using report loader to load report by setting the registry.
static IXDocReport	XDocReport.generateReportAndConvert(InputStream sourceStream, String templateEngineKind, fr.opensagres.xdocreport.template.formatter.FieldsMetadata metadata, Map<String,Object> contextMap, fr.opensagres.xdocreport.converter.Options options, OutputStream out)	Generate report and convert it to another format (PDF, XHTML) without cache.
static IXDocReport	XDocReport.generateReportAndConvert(InputStream sourceStream, String templateEngineKind, fr.opensagres.xdocreport.template.formatter.FieldsMetadata metadata, Map<String,Object> contextMap, fr.opensagres.xdocreport.converter.Options options, OutputStream out, XDocReportRegistry registry)	Generate report and convert it to another format (PDF, XHTML) without cache by setting the registry.
static IXDocReport	XDocReport.generateReportAndConvert(String reportId, IXDocReportController controller, Map<String,Object> contextMap, fr.opensagres.xdocreport.converter.Options options, OutputStream out)	Generate report and convert it by using controller to load report.
static IXDocReport	XDocReport.generateReportAndConvert(String reportId, IXDocReportController controller, Map<String,Object> contextMap, fr.opensagres.xdocreport.converter.Options options, OutputStream out, XDocReportRegistry registry)	Generate report and convert it by using controller to load report by setting the registry.
static IXDocReport	XDocReport.generateReportAndConvert(String reportId, IXDocReportLoader reportLoader, Map<String,Object> contextMap, fr.opensagres.xdocreport.converter.Options options, OutputStream out)	Generate report and convert it by using report loader to load report.
static IXDocReport	XDocReport.generateReportAndConvert(String reportId, IXDocReportLoader reportLoader, Map<String,Object> contextMap, fr.opensagres.xdocreport.converter.Options options, OutputStream out, XDocReportRegistry registry)	Generate report and convert it by using report loader to load report by setting the registry.
protected IXDocReport	Generator.getReport(In request)
static IXDocReport	XDocReport.getReport(String reportId, IXDocReportController controller)	Get the template report from the cache registered with report id and load it if it is not found by using the given controller.
static IXDocReport	XDocReport.getReport(String reportId, IXDocReportController controller, XDocReportRegistry registry)	Get the template report from the cache registered with report id and load it if it is not found by using the given controller by setting the registry.
static IXDocReport	XDocReport.getReport(String reportId, IXDocReportLoader reportLoader)	Get the template report from the cache registered with report id and load it if it is not found by using the given report loader.
static IXDocReport	XDocReport.getReport(String reportId, IXDocReportLoader reportLoader, XDocReportRegistry registry)	Get the template report from the cache registered with report id and load it if it is not found by using the given report loader by setting the registry.
protected IXDocReport	Generator.loadReport(String reportId, XDocReportRegistry registry, In request)	Load report.
static IXDocReport	XDocReport.loadReport(InputStream sourceStream, String templateEngineKind, fr.opensagres.xdocreport.template.formatter.FieldsMetadata metadata, XDocReportRegistry registry)	Load the template report by using the given controller and cache it to the given registry
static IXDocReport	XDocReport.loadReport(String reportId, IXDocReportController controller, XDocReportRegistry registry)	Load the template report by using the given controller and cache it to the given registry
static IXDocReport	XDocReport.loadReport(String reportId, IXDocReportLoader reportLoader, XDocReportRegistry registry)	Load the template report by using the given report loader and cache it to the given registry

Methods in fr.opensagres.xdocreport.document with parameters of type IXDocReport

Modifier and Type	Method	Description
protected String	Generator.getConverterId(IXDocReport report, In request)	Returns the converter id.
protected fr.opensagres.xdocreport.converter.Options	Generator.getOptionsConverter(IXDocReport report, In request)
protected fr.opensagres.xdocreport.template.ITemplateEngine	Generator.getTemplateEngine(IXDocReport report, In request)
protected void	Generator.prepareOptions(fr.opensagres.xdocreport.converter.Options options, IXDocReport report, String converterId, In request)

Uses of IXDocReport in fr.opensagres.xdocreport.document.discovery

Methods in fr.opensagres.xdocreport.document.discovery that return IXDocReport

Modifier and Type	Method	Description
IXDocReport	IXDocReportFactoryDiscovery.createReport()	Create a new instance of IXDocReport.

Uses of IXDocReport in fr.opensagres.xdocreport.document.dump

Methods in fr.opensagres.xdocreport.document.dump with parameters of type IXDocReport

Modifier and Type	Method	Description
static fr.opensagres.xdocreport.template.IContext	DumpHelper.createDumpContext(IXDocReport report, fr.opensagres.xdocreport.template.ITemplateEngine templateEngine, DumperOptions option)
protected abstract void	AbstractDumper.doDump(IXDocReport report, InputStream documentIn, fr.opensagres.xdocreport.template.IContext context, DumperOptions option, fr.opensagres.xdocreport.template.ITemplateEngine templateEngine, OutputStream out)
protected void	AbstractProjectDumper.doDump(IXDocReport report, InputStream documentIn, fr.opensagres.xdocreport.template.IContext context, DumperOptions option, fr.opensagres.xdocreport.template.ITemplateEngine templateEngine, OutputStream out)
protected void	AbstractProjectDumper.doDump(IXDocReport report, InputStream documentIn, fr.opensagres.xdocreport.template.IContext context, fr.opensagres.xdocreport.template.ITemplateEngine templateEngine, fr.opensagres.xdocreport.template.IContext dumpContext, File baseDir, ZipOutputStream out)
void	AbstractDumper.dump(IXDocReport report, fr.opensagres.xdocreport.template.IContext context, DumperOptions option, OutputStream out)
final void	AbstractDumper.dump(IXDocReport report, InputStream documentIn, fr.opensagres.xdocreport.template.IContext context, DumperOptions option, OutputStream out)
void	IDumper.dump(IXDocReport report, fr.opensagres.xdocreport.template.IContext context, DumperOptions options, OutputStream out)	Dump the given report and context by using the dumper configured with the given options and generates the result of the dump in the given out.
void	IDumper.dump(IXDocReport report, InputStream documentIn, fr.opensagres.xdocreport.template.IContext context, DumperOptions option, OutputStream out)	Dump the given report and context by using the dumper configured with the given options and generates the result of the dump in the given out.
static void	DumpHelper.generateDocumentEntry(IXDocReport report, InputStream documentIn, fr.opensagres.xdocreport.template.IContext dumpContext, String src, File baseDir, ZipOutputStream out)
static void	DumpHelper.generateDocumentFile(IXDocReport report, InputStream documentIn, fr.opensagres.xdocreport.template.IContext dumpContext, File srcDir)
static void	DumpHelper.generateDocumentZipEntry(IXDocReport report, InputStream documentIn, fr.opensagres.xdocreport.template.IContext dumpContext, ZipOutputStream out, String src)
static void	DumpHelper.generateFieldsMetadataEntry(IXDocReport report, fr.opensagres.xdocreport.template.IContext dumpContext, String resourcesSrcPath, File baseDir, ZipOutputStream out)
static void	DumpHelper.generateFieldsMetadataFile(IXDocReport report, fr.opensagres.xdocreport.template.IContext dumpContext, File srcDir)
static void	DumpHelper.generateFieldsMetadataZipEntry(IXDocReport report, fr.opensagres.xdocreport.template.IContext dumpContext, ZipOutputStream out, String src)
static void	DumpHelper.generateJSONEntry(IXDocReport report, fr.opensagres.xdocreport.template.IContext context, boolean upperCaseFirstChar, fr.opensagres.xdocreport.template.IContext dumpContext, String resourcesSrcPath, File baseDir, ZipOutputStream out)
static void	DumpHelper.generateJSONFile(IXDocReport report, fr.opensagres.xdocreport.template.IContext context, boolean upperCaseFirstChar, fr.opensagres.xdocreport.template.IContext dumpContext, File srcDir)
static void	DumpHelper.generateJSONZipEntry(IXDocReport report, fr.opensagres.xdocreport.template.IContext context, boolean upperCaseFirstChar, fr.opensagres.xdocreport.template.IContext dumpContext, ZipOutputStream out, String src)
static String	DumpHelper.getClassName(IXDocReport report)
static InputStream	DumpHelper.getDocument(IXDocReport report)
static String	DumpHelper.getJSONFileName(IXDocReport report, fr.opensagres.xdocreport.template.IContext dumpContext)
static String	DumpHelper.toDocumentAsBinary64(IXDocReport report)

Uses of IXDocReport in fr.opensagres.xdocreport.document.dump.eclipse

Methods in fr.opensagres.xdocreport.document.dump.eclipse with parameters of type IXDocReport

Modifier and Type	Method	Description
protected void	EclipseProjectDumper.doDump(IXDocReport report, InputStream documentIn, fr.opensagres.xdocreport.template.IContext context, fr.opensagres.xdocreport.template.ITemplateEngine templateEngine, fr.opensagres.xdocreport.template.IContext dumpContext, File baseDir, ZipOutputStream out)

Uses of IXDocReport in fr.opensagres.xdocreport.document.dump.java

Methods in fr.opensagres.xdocreport.document.dump.java with parameters of type IXDocReport

Modifier and Type	Method	Description
protected void	JavaMainDumper.doDump(IXDocReport report, InputStream documentIn, fr.opensagres.xdocreport.template.IContext context, DumperOptions option, fr.opensagres.xdocreport.template.ITemplateEngine templateEngine, OutputStream out)

Uses of IXDocReport in fr.opensagres.xdocreport.document.dump.maven

Methods in fr.opensagres.xdocreport.document.dump.maven with parameters of type IXDocReport

Modifier and Type	Method	Description
protected void	MavenProjectDumper.doDump(IXDocReport report, InputStream documentIn, fr.opensagres.xdocreport.template.IContext context, fr.opensagres.xdocreport.template.ITemplateEngine templateEngine, fr.opensagres.xdocreport.template.IContext dumpContext, File baseDir, ZipOutputStream out)

Uses of IXDocReport in fr.opensagres.xdocreport.document.registry

Methods in fr.opensagres.xdocreport.document.registry that return IXDocReport

Modifier and Type	Method	Description
IXDocReport	XDocReportRegistry.createReport(fr.opensagres.xdocreport.core.io.XDocArchive documentArchive)
IXDocReport	XDocReportRegistry.createReport(InputStream sourceStream)
IXDocReport	XDocReportRegistry.getReport(String reportId)	Returns the report identified with the given id.
IXDocReport	XDocReportRegistry.loadReport(InputStream sourceStream)	Load report.
IXDocReport	XDocReportRegistry.loadReport(InputStream sourceStream, boolean cacheReport)	Load report.
IXDocReport	XDocReportRegistry.loadReport(InputStream sourceStream, fr.opensagres.xdocreport.template.ITemplateEngine templateEngine)	Load report.
IXDocReport	XDocReportRegistry.loadReport(InputStream sourceStream, fr.opensagres.xdocreport.template.ITemplateEngine templateEngine, boolean cacheReport)	Load report.
IXDocReport	XDocReportRegistry.loadReport(InputStream sourceStream, fr.opensagres.xdocreport.template.TemplateEngineKind templateEngineKind)	Load report.
IXDocReport	XDocReportRegistry.loadReport(InputStream sourceStream, fr.opensagres.xdocreport.template.TemplateEngineKind templateEngineKind, boolean cacheReport)	Load report.
IXDocReport	XDocReportRegistry.loadReport(InputStream sourceStream, String reportId)	Load report.
IXDocReport	XDocReportRegistry.loadReport(InputStream sourceStream, String reportId, boolean cacheReport)	Load report.
IXDocReport	XDocReportRegistry.loadReport(InputStream sourceStream, String reportId, fr.opensagres.xdocreport.template.ITemplateEngine templateEngine)	Load report.
IXDocReport	XDocReportRegistry.loadReport(InputStream sourceStream, String reportId, fr.opensagres.xdocreport.template.ITemplateEngine templateEngine, boolean cacheReport)	Load report.
IXDocReport	XDocReportRegistry.loadReport(InputStream sourceStream, String reportId, fr.opensagres.xdocreport.template.TemplateEngineKind templateEngineKind)	Load report.
IXDocReport	XDocReportRegistry.loadReport(InputStream sourceStream, String reportId, fr.opensagres.xdocreport.template.TemplateEngineKind templateEngineKind, boolean cacheReport)	Load report.
IXDocReport	XDocReportRegistry.loadReport(InputStream sourceStream, String reportId, String templateEngineKind)	Load report.
IXDocReport	XDocReportRegistry.loadReport(InputStream sourceStream, String reportId, String templateEngineKind, boolean cacheReport)	Load report.

Methods in fr.opensagres.xdocreport.document.registry that return types with arguments of type IXDocReport

Modifier and Type	Method	Description
protected fr.opensagres.xdocreport.core.cache.ICacheStorage<String,IXDocReport>	XDocReportRegistry.createCache()	Create the storage cache to store instances of IXDocReport.
Collection<IXDocReport>	XDocReportRegistry.getCachedReports()	Returns cached report IXDocReport;

Methods in fr.opensagres.xdocreport.document.registry with parameters of type IXDocReport

Modifier and Type	Method	Description
void	XDocReportRegistry.registerReport(IXDocReport report)	Register report and throws XDocReportException if it already exists a report in the registry with the same id .
void	XDocReportRegistry.registerReport(IXDocReport report, boolean force)	Register report.
void	XDocReportRegistry.unregisterReport(IXDocReport report)	Unregister report.

Uses of IXDocReport in fr.opensagres.xdocreport.document.web

Methods in fr.opensagres.xdocreport.document.web that return IXDocReport

Modifier and Type	Method	Description
protected IXDocReport	AbstractProcessXDocReportServlet.getReport(jakarta.servlet.http.HttpServletRequest request)
protected IXDocReport	AbstractProcessXDocReportServlet.loadReport(String reportId, XDocReportRegistry registry, jakarta.servlet.http.HttpServletRequest request)	Load report.

Methods in fr.opensagres.xdocreport.document.web with parameters of type IXDocReport

Modifier and Type	Method	Description
fr.opensagres.xdocreport.converter.IURIResolver	AbstractProcessXDocReportServlet.createWEBURIResolver(IXDocReport report, String converterId, jakarta.servlet.http.HttpServletRequest request)	Create the WEB URIResolver used to manage image with XHTML converter.
protected void	UploadXDocReportServlet.doForward(IXDocReport report, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
protected void	AbstractProcessXDocReportServlet.error(IXDocReport report, fr.opensagres.xdocreport.template.IContext context, DumperOptions dumperOptions, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Exception cause)	Invoked when there is an error thrown in any part of doRequest() processing.
protected String	AbstractProcessXDocReportServlet.getConverterId(IXDocReport report, jakarta.servlet.http.HttpServletRequest request)	Returns the converter id.
protected String	AbstractProcessXDocReportServlet.getDumperKind(IXDocReport report, jakarta.servlet.http.HttpServletRequest request)	Returns the dumper kind from the HTTP request.
protected String	AbstractProcessXDocReportServlet.getFontEncoding(IXDocReport report, String converterId, jakarta.servlet.http.HttpServletRequest request)	Returns the encoding to use for converter.
protected fr.opensagres.xdocreport.converter.Options	AbstractProcessXDocReportServlet.getOptionsConverter(IXDocReport report, jakarta.servlet.http.HttpServletRequest request)	Returns the options for the converter.
protected DumperOptions	AbstractProcessXDocReportServlet.getOptionsDumper(IXDocReport report, jakarta.servlet.http.HttpServletRequest request)	Returns the dumper options from the HTTP request and null otherwise.
protected fr.opensagres.xdocreport.template.ITemplateEngine	BaseXDocReportServlet.getTemplateEngine(IXDocReport report, jakarta.servlet.http.HttpServletRequest request)
protected void	AbstractProcessXDocReportServlet.prepareOptions(fr.opensagres.xdocreport.converter.Options options, IXDocReport report, String converterId, jakarta.servlet.http.HttpServletRequest request)	Initialize converter options with default settings.
protected void	UploadXDocReportServlet.reportLoaded(IXDocReport report, jakarta.servlet.http.HttpServletRequest request)

Uses of IXDocReport in fr.opensagres.xdocreport.document.web.dispatcher

Methods in fr.opensagres.xdocreport.document.web.dispatcher with parameters of type IXDocReport

Modifier and Type	Method	Description
void	IXDocReportWEBController.populateContext(fr.opensagres.xdocreport.template.IContext context, IXDocReport report, jakarta.servlet.http.HttpServletRequest request)
protected void	ProcessDispatcherXDocReportServlet.populateContext(fr.opensagres.xdocreport.template.IContext context, IXDocReport report, jakarta.servlet.http.HttpServletRequest request)