oracle.epm.api.model

Class Workbook

java.lang.Object

oracle.epm.api.model.Workbook

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class Workbook
extends java.lang.Object
implements java.io.Closeable

Represents an Excel workbook with functionality to create sheets, add rows, and save or write the workbook to an output stream or file.

Example demonstrating the creation and manipulation of an Excel workbook using Groovy.

The code performs the following operations:

• Creates a workbook with two sheets.
• Adds rows with specified data to each sheet.
• Appends a row to the first sheet after both sheets have been created.
• Saves the workbook to a file named "Test.xlsx" on the outbox.

Example call from Groovy:

 
 workbook().withCloseable { Workbook book ->
     book.createSheet().with { sheet ->
         addRow('','Jan','Feb','Mar')
         addRow('Plan','10','','30')
         addRow('Budget','','200','100')
         addRow('Actual','','110','120')
     }
     book.createSheet('Sheet#2').with { sheet ->
         addRow('','Apr','May','Jun')
         addRow('Variance','1','2','3')
         addRow('Revised','10','20','')
     }
     book.getSheet(0).addRow('Working','15','20','300')
     book.save('Test.xlsx')
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Workbook.Sheet Represents a sheet in the workbook, allowing rows to be added with specified cell values.

Constructor Summary

Constructors

Constructor and Description
Workbook() Constructs a new, empty workbook.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the workbook and releases any system resources associated with it.
Workbook.Sheet	createSheet() Creates a new sheet in the workbook with a default name (e.g., "Sheet1", "Sheet2").
Workbook.Sheet	createSheet(java.lang.String sheetName) Creates a new sheet in the workbook with the specified name.
Workbook.Sheet	getSheet(int sheetIndex) Retrieves the sheet at the specified index.
void	save(java.lang.String fileName) Saves the workbook to the specified file on the outbox.
void	write(java.io.OutputStream outputStream) Writes the workbook to the provided output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

Workbook

public Workbook()

Constructs a new, empty workbook.

Method Detail

close

public void close()
           throws java.io.IOException

Closes the workbook and releases any system resources associated with it.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - if an I/O error occurs while closing the workbook

createSheet

public Workbook.Sheet createSheet()

Creates a new sheet in the workbook with a default name (e.g., "Sheet1", "Sheet2").

Returns:

the newly created Workbook.Sheet

Throws:

java.lang.Exception - if the maximum number of sheets is exceeded or workbook is closed

createSheet

public Workbook.Sheet createSheet(java.lang.String sheetName)

Creates a new sheet in the workbook with the specified name.

Parameters:

sheetName - the name of the new sheet; must not be null

Returns:

the newly created Workbook.Sheet

Throws:

java.lang.IllegalArgumentException - if sheetName is null

java.lang.Exception - if the maximum number of sheets is exceeded or workbook is closed

getSheet

public Workbook.Sheet getSheet(int sheetIndex)

Retrieves the sheet at the specified index.

Parameters:

sheetIndex - the zero-based index of the sheet

Returns:

the Workbook.Sheet at the given index

Throws:

java.lang.IllegalArgumentException - if the index is out of range

save

public void save(java.lang.String fileName)
          throws java.io.IOException

Saves the workbook to the specified file on the outbox.

Parameters:

fileName - name of the file on the outbox.

A valid file name may only contain letters, digits, underscores (_), hyphens (-), periods (.), and spaces.

Throws:

java.io.IOException - if an I/O error occurs during writing

java.lang.IllegalArgumentException - if fileName is null

com.hyperion.planning.HspRuntimeException - if the file name contains invalid characters

write

public void write(java.io.OutputStream outputStream)
           throws java.io.IOException

Writes the workbook to the provided output stream.

Parameters:

outputStream - the output stream to write to The caller is responsible for closing this stream when finished with it

Throws:

java.io.IOException - if an I/O error occurs during writing

java.lang.IllegalArgumentException - if outputStream is null