com.ihr.xbrl.validation.report

Class XBRLValidationReportToExcel

java.lang.Object

com.ihr.xbrl.validation.report.XBRLValidationReportToExcel

All Implemented Interfaces:

XBRLValidationReportSerializer

public class XBRLValidationReportToExcel
extends java.lang.Object
implements XBRLValidationReportSerializer

Generates an excel file with the content of an XBRLValidationReport.

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
XBRLValidationReportToExcel(java.net.URI excelURI) Creates an instance of the transformer of the validation report to Excel.

Method Summary

Modifier and Type	Method and Description
void	serialize(XBRLValidationReport xbrlValidationReport) Produces the output of the XBRLValidationReport in the object implementing this interface.
static void	serializeToOutputStream(XBRLValidationReport xbrlValidationReport, java.io.OutputStream stream, boolean simplified, java.lang.String[] extraInfo) Generates an excel spreadsheet and serializes it to the output stream from the XBRLValidationReport received The simplified parameter can be used to decide about the number of sheets to generate
void	setAdditionalInformation(java.lang.String[] exportValidationReportAdditionalInformation) Additional information to be added to the main page of the excel validation report This information might be useful from the entry point or any other parts of the hosted application
void	setMode(boolean newMode) Export the validation report to excel in a simplified mode (when value is true) or the full mode (when value is false) Default mode is full mode We might change this functionality in the future to provide more control over sheets to generate

Methods inherited from class java.lang.Object

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

Constructor Detail

XBRLValidationReportToExcel

public XBRLValidationReportToExcel(java.net.URI excelURI)

Creates an instance of the transformer of the validation report to Excel.

Parameters:

excelURI - the Excel document URI

Method Detail

setMode

public void setMode(boolean newMode)

Export the validation report to excel in a simplified mode (when value is true) or the full mode (when value is false)

Default mode is full mode

We might change this functionality in the future to provide more control over sheets to generate

Parameters:

newMode -

Since:

3.0.6

setAdditionalInformation

public void setAdditionalInformation(java.lang.String[] exportValidationReportAdditionalInformation)

Additional information to be added to the main page of the excel validation report This information might be useful from the entry point or any other parts of the hosted application

Parameters:

exportValidationReportAdditionalInformation - is array of strings or null

serializeToOutputStream

public static void serializeToOutputStream(XBRLValidationReport xbrlValidationReport,
                                           java.io.OutputStream stream,
                                           boolean simplified,
                                           java.lang.String[] extraInfo)
                                    throws java.io.IOException

Generates an excel spreadsheet and serializes it to the output stream from the XBRLValidationReport received

The simplified parameter can be used to decide about the number of sheets to generate

Parameters:

xbrlValidationReport -

stream -

simplified -

extraInfo -

Throws:

java.io.IOException

serialize

public void serialize(XBRLValidationReport xbrlValidationReport)

Description copied from interface: XBRLValidationReportSerializer

Produces the output of the XBRLValidationReport in the object implementing this interface.

Specified by:

serialize in interface XBRLValidationReportSerializer

Parameters:

xbrlValidationReport - the xbrl validation report