Export ViewObject data to Excel File Using Apache POI in Oracle ADF

Hello All

Previously I have posted about importing data in ADF Table from Excel file

This post is about exporting viewObject data in Excel file using Apache POI API, Apache POI provides HSFF and XSFF to read , create and modify spreadsheets.
You can download POI jars from The APACHE Software Foundation or from here
Other than this you need to use xmlbeans and common-collections Jar

Export ViewObject data to PDF file using Apache PDFBox

Hello All
Hope you all are doing well :)

This post is about exporting view object data in a pdf file directly from af:table , export to excel is built in feature of ADF but exporting data in PDF requires little bit of extra effort
So here for this requirement I am using Apache PDFBox library , previously I have posted about using this API to create PDF file from text data
I know many of you will not visit that link ;) So a quick overview

Exporting viewObject data in text file using af:fileDownloadActionListener in Oracle ADF (12.1.3)

Hello All
This post is about using af:fileDownloadActionListener to generate file on run-time, suppose i have a viewObject and i want to export it's data in CSV or plain text so for this requirement we can generate file at run-time and send it to client UI to download

What is af:fileDownloadActionListener-
as per oracle docs-
The fileDownloadActionListener tag is a declarative way to allow an action source (<commandButton>, <commandLink>, etc.) to programatically send the contents of a file to the user, optionally with a specific content type and filename. Since file downloads must be processed with an ordinary request - not XMLHttp AJAX requests - this tag forces partialSubmit to be false on the parent component, if it supports that attribute.
The fileDownloadActionListener uses the native (browser built-in) filedownload popup, so this popup cannot be configured.

In this post i am using Departments table of HR schema

• Prepare model part using Departments table and drop it on page as a table and add a button to UI for downloading





• drop af:fileDownloadActionListener as child of button and set it's property as contentType, method , fileName 





• Now see code written in download Listener-



    /**Method to get BindingsContainer for current page
     * @return
     */
    public BindingContainer getBindingsCont() {
        return BindingContext.getCurrent().getCurrentBindingsEntry();
    }

    /**Method to download ViewObject's data in plain text file
     * @param facesContext
     * @param outputStream
     * @throws UnsupportedEncodingException
     * @throws IOException
     */
    public void fileDownloadListener(FacesContext facesContext,
                                     OutputStream outputStream) throws UnsupportedEncodingException, IOException {
        OutputStreamWriter w = new OutputStreamWriter(outputStream, "UTF-8");
        //Get itertaor from bindings
        DCIteratorBinding deptIter = (DCIteratorBinding) getBindingsCont().get("Departments1Iterator");
        //Get ViewObject from Iterator
        ViewObjectImpl vo = (ViewObjectImpl) deptIter.getViewObject();
        ViewAttributeDefImpl[] attrDefs = vo.getViewAttributeDefImpls();
        int count = 0;
        RowSetIterator rsi = vo.createRowSetIterator(null);
        while (rsi.hasNext()) {
            Row nextRow = rsi.next();
            if (nextRow != null) {
                // Code to iterate over ViewObject's column to get all columns value at runtime
                for (ViewAttributeDefImpl attrDef : attrDefs) {
                    byte attrKind =
                        attrDefs[count].getAttributeKind(); //checks attribute kind for each element in an array of AttributeDefs
                    if (attrKind != AttributeDef.ATTR_ASSOCIATED_ROW &&
                        attrKind != AttributeDef.ATTR_ASSOCIATED_ROWITERATOR) {
                        String columnName = attrDef.getName();
                        w.write(columnName + " - " + nextRow.getAttribute(columnName) + "  ");
                    }
                }
                // Code to create new line text line for new Row
                w.write(System.getProperty("line.separator"));
            }
        }
        //Flush the writer after wrting file
        w.flush();
    }
}



• Run this application and click on download button, browser download box appears , open downloaded file and see how your data appears in text file, to export data in a pdf file you have to generate PDF file using some API then you can download it in same way

Cheers:) Happy Learning

Creating and Exporting hierarchical data to excel using dvt:pivotTable & dvt:exportPivotTableData in Oracle ADF

Hello All,
This post is about exporting tree structured(hierarchical ) data to an excel file.
suppose we have export department wise detail of employees , we can achieve this in ADF using pivot table (<dvt:pivotTable>)

What is pivot tabel (oracle docs)- 
 
UIComponent class: oracle.adf.view.faces.bi.component.pivotTable.UIPivotTable
Component type: oracle.dss.adf.pivotTable.PivotTable
The Pivot Table supports the display of multiple nested attributes on a row and column header. In addition, the Pivot Table supports the ability to dynamically change the layout of the attributes displayed in the row or column headers via drag and drop pivoting.
now see the implementation part -

• Create a Fusion Web Application using HRSchema , for this sample app i have created a view (Department Wise Employees) to export data



CREATE OR REPLACE FORCE EDITIONABLE VIEW "APP_USR"."DEPT_EMP" ("DEPARTMENT_NAME", "EMPLOYEE_NAME", "SALARY") AS 
  SELECT A.DEPARTMENT_NAME, B.FIRST_NAME,B.SALARY FROM DEPARTMENTS A, EMPLOYEES B WHERE A.DEPARTMENT_ID=B.DEPARTMENT_ID (+);



• Prepare model using this view





• Create a page and drop this view as pivot table (ADF Faces component) from data control





• Now configure pivot table (set row & column attributes, insert appropriate drilling) - see the snaps











• Now run your page and see working pivot table - here pivot table is created successfully 





• Drop a button  and a <dvt:exportPivotTableData> under button to export pivot table



<af:commandButton text="Export" id="b1">
                    <dvt:exportPivotTableData type="excelHTML" exportedId="pt1" filename="Dep_Empl.xls"
                                              title="PivotTable export"/>
                </af:commandButton>



• Run your page and click on export button and see your tree structured data in exported excel file

Cheers :) Happy Learning Sample ADF Application

Export ViewObject dataset to XML, Generate customized XML file using ViewObject in Oracle ADF

Hello All,
this post is about exporting a viewObject data to a XML document.
Sometimes we need to generate XML document with the same data in ViewObject, for this ADF provides a facility to directly export data to a XML document using ViewObjectImpl class

See the steps to generate XML for a ViewObject

• Create a Fusion Web application and model using HR schema (Departments & Employees) table (master detail relation using viewLink)





• Now to generate XML, i have used writeXML method of ViewObjectImpl class, it produce XML using two parameters



from oracle docs-
writeXML(int depthCount, long options)
here depthCount - no. of ViewLink levels that should be traversed to produce XML
options- how many rows you want to export, It can be set any of flags given below
XMLInterface.XML_OPT_ALL_ROWS
Includes all rows in the view object's row set in the XML.

XMLInterface.XML_OPT_LIMIT_RANGE
Includes only the rows in the current range in the XML.


• created a method in DepartmentsVOImpl class to export data to XML, added it to client Interface



    /**Method to generate XML from ViewObject data
     * @param level
     * @return
     */
    public String writeVoToXml(int level) {
        FileOutputStream out;
        ByteArrayOutputStream opStream = new ByteArrayOutputStream();
        try {
            // Generating XML for All rows and adding it to Output Stream
            ((XMLNode) this.writeXML(level, XMLInterface.XML_OPT_ALL_ROWS)).print(opStream);
            System.out.println(opStream);
            // Creating a XML document in D Drive
            out = new FileOutputStream("D://Departments.xml");
            out.close();

        } catch (Exception e) {
            System.out.println(e.getMessage());
        }

        return opStream.toString();

    }






• Now run application module to execute method and see generated XML on console








• i have created a simple page with a af:codeEditor to show generated XML , button to generate XML and a spinner to pass depth level of viewLink accessor

In case depth level is '0' , it export data only for Departments viewObject



Change level to '1' , Now it generate XML for Departments --> Employess relation





• now to how to customize XML ? How to change default tags for attribute names and rows ?
• To change attribute label (tag in xml)- Suppose i have to change DepartmentName to Name in XML
• Add attribute level custom property named XML_ELEMENT to a value AnyOtherName to change the XML element name used for that attribute





• To change Row label (tag in xml)- Suppose i have to change DepartmentsVORow to DepartmentLine in XML
• Add ViewObject level custom property named XML_ROW_ELEMENT to a value AnyOtherName to change the XML element name used for that Row





• Now Run and see generated XML -

Cheers :-) Happy Learning