com.compomics.util.io.export.writers

Class ExcelWriter

java.lang.Object

com.compomics.util.io.export.ExportWriter

com.compomics.util.io.export.writers.ExcelWriter

public class ExcelWriter
extends ExportWriter

ExportWriter for the export to excel files.

Author:

Marc Vaudel

Field Summary

Fields inherited from class com.compomics.util.io.export.ExportWriter

exportFormat, lastFolderKey

Constructor Summary

Constructors

Constructor and Description
ExcelWriter(File destinationFile) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addSeparator(WorkbookStyle textStyle) Adds a separator.
void	close() Writes the content in cache and closes the connection to the file.
void	decreseDepth() Notifies the writer that data of a lower hierarchical depth will be written, e.g.
org.apache.poi.hssf.usermodel.HSSFWorkbook	getWorkbook() Return the workBook.
WorkbookStyle	getWorkbookStyle() Returns the workbook style.
void	increaseDepth() Notifies the writer that data of a higher hierarchical depth will be written, e.g.
void	newLine() Adds a separator.
void	setWorkbookStyle(WorkbookStyle workbookStyle) Sets the workbook style.
void	startNewSection(String sectionTitle, WorkbookStyle textStyle) Starts a new section.
void	write(String text, WorkbookStyle textStyle) Writes text to the export.
void	writeHeaderText(String text, WorkbookStyle textStyle) Writes header text to the export.
void	writeMainTitle(String text, WorkbookStyle textStyle) Writes the main title.

Methods inherited from class com.compomics.util.io.export.ExportWriter

addSeparator, getExportFormat, getExportWriter, startNewSection, startNewSection, write, writeHeaderText, writeMainTitle

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcelWriter

public ExcelWriter(File destinationFile)

Constructor.

Parameters:

destinationFile - the file where to write the data

Method Detail

getWorkbookStyle

public WorkbookStyle getWorkbookStyle()

Returns the workbook style.

Returns:

the workbook style

setWorkbookStyle

public void setWorkbookStyle(WorkbookStyle workbookStyle)

Sets the workbook style.

Parameters:

workbookStyle - the workbook style

getWorkbook

public org.apache.poi.hssf.usermodel.HSSFWorkbook getWorkbook()

Return the workBook.

Returns:

the workBook

write

public void write(String text,
                  WorkbookStyle textStyle)
           throws IOException

Description copied from class: ExportWriter

Writes text to the export.

Specified by:

write in class ExportWriter

Parameters:

text - the text to write

textStyle - the style to use, overwrites any previous/default

Throws:

IOException - if an IOException occurs

writeMainTitle

public void writeMainTitle(String text,
                           WorkbookStyle textStyle)
                    throws IOException

Description copied from class: ExportWriter

Writes the main title.

Specified by:

writeMainTitle in class ExportWriter

Parameters:

text - the text to write

textStyle - the style to use, overwrites any previous/default

Throws:

IOException - if an IOException occurs

startNewSection

public void startNewSection(String sectionTitle,
                            WorkbookStyle textStyle)
                     throws IOException

Description copied from class: ExportWriter

Starts a new section.

Specified by:

startNewSection in class ExportWriter

Parameters:

sectionTitle - the text to write

textStyle - the style to use, overwrites any previous/default

Throws:

IOException - if an IOException occurs

writeHeaderText

public void writeHeaderText(String text,
                            WorkbookStyle textStyle)
                     throws IOException

Description copied from class: ExportWriter

Writes header text to the export.

Specified by:

writeHeaderText in class ExportWriter

Parameters:

text - the text to write

textStyle - the style to use, overwrites any previous/default

Throws:

IOException - if an IOException occurs

addSeparator

public void addSeparator(WorkbookStyle textStyle)
                  throws IOException

Description copied from class: ExportWriter

Adds a separator.

Specified by:

addSeparator in class ExportWriter

Parameters:

textStyle - the style to use, overwrites any previous/default

Throws:

IOException - if an IOException occurs

newLine

public void newLine()
             throws IOException

Description copied from class: ExportWriter

Adds a separator.

Specified by:

newLine in class ExportWriter

Throws:

IOException - if an IOException occurs

close

public void close()
           throws IOException,
                  FileNotFoundException

Description copied from class: ExportWriter

Writes the content in cache and closes the connection to the file.

Specified by:

close in class ExportWriter

Throws:

IOException - if an IOException occurs

FileNotFoundException - if a FileNotFoundException occurs

increaseDepth

public void increaseDepth()

Description copied from class: ExportWriter

Notifies the writer that data of a higher hierarchical depth will be written, e.g. going from protein to peptide.

Specified by:

increaseDepth in class ExportWriter

decreseDepth

public void decreseDepth()

Description copied from class: ExportWriter

Notifies the writer that data of a lower hierarchical depth will be written, e.g. going from peptide to protein.

Specified by:

decreseDepth in class ExportWriter