io.starter.formats.XLS

Class OOXMLWriter

java.lang.Object

io.starter.formats.XLS.OOXMLAdapter

io.starter.formats.XLS.OOXMLWriter

All Implemented Interfaces:

OOXMLConstants

public class OOXMLWriter
extends OOXMLAdapter
implements OOXMLConstants

Breaking out functionality for writing out of OOXMLAdapter

Field Summary

Fields inherited from class io.starter.formats.XLS.OOXMLAdapter

DEBUG

Fields inherited from interface io.starter.formats.OOXML.OOXMLConstants

borderStyle, builtInNames, cellFormulaType, cellType, chartDir, chartns, contentTypes, drawingDir, drawingmlns, drawingns, fontFamily, fontScheme, horizontalAlignment, legendPos, mediaDir, patternFill, pkgrelns, relns, relsContentTypes, systemColors, themeDir, threeDchartTypes, twoDchartTypes, typens, verticalAlignment, xmlHeader, xmlns

Constructor Summary

Constructors

Constructor and Description
OOXMLWriter()

Method Summary

cell table - specifies rows and cells with types and values (see below) -- REQUIRED ("Supporting Features" -- all optional)

Modifier and Type	Method and Description
void	getOOXML(WorkBookHandle bk, OutputStream out) generates OOXML for a workbook (see specification above) Creates the ZIP file and writes all files into proper directory structure re: OPC
void	getOOXML(WorkBookHandle bk, String path) generates OOXML for a workbook Creates the ZIP file and writes all files into proper directory structure Will create either an .xlsx or an .xlsm output, depending upon whether WorkBookHandle bk contains macros
protected void	writeContentType() writes all package contents to [Content_Types].xml Package contents are contained in global array lists mainContentList, wbContentList, sheetsContentList, drContentList
protected void	writeDeferredFiles() write the deferred files to the zipfile
protected void	writeMergedCellRecords(WorkSheetHandle sheet) Write the merged cell records for a worksheet
protected void	writeOOXML(WorkBookHandle bk) Calls all the necessary methods to create style OOXML, workbook OOXML, sheet(s) OOXML ...
protected void	writeRels(ArrayList cl, String relsfname) generic method for creating a .rels file from a content list array cl
void	writeRow(RowHandle row, ArrayList hyperlinks) Writes a row and all contents to the zip output
protected void	writeSheetOOXML(WorkBookHandle bk, WorkSheetHandle sheet, int id) writeSheetOOXML writes XML data in SheetML specificaiton to [worksheet].xml Main portion is the section, containing all row and cell information format of SheetML: ROOT autoFilter (AutoFilter Settings) Hides rows based upon criteria cellWatches (Cell Watch Items) colBreaks (Vertical Page Breaks) cols (Column Information) conditionalFormatting (Conditional Formatting) controls (Embedded Controls) customProperties (Custom Properties) customSheetViews (Custom Sheet Views) dataConsolidate (Data Consolidate) dataValidations (Data Validations) dimension (Worksheet Dimensions) drawing (Drawing) extLst (Future Feature Data Storage Area) headerFooter (Header Footer Settings) hyperlinks (Hyperlinks) ignoredErrors (Ignored Errors) legacyDrawing (Legacy Drawing Reference) legacyDrawingHF (Legacy Drawing Reference in Header Footer) mergeCells (Merge Cells) oleObjects (Embedded Objects) pageMargins (Page Margins) pageSetup (Page Setup Settings) phoneticPr (Phonetic Properties) picture (Background Image) printOptions (Print Options) protectedRanges (Protected Ranges) rowBreaks (Horizontal Page Breaks (Row)) scenarios (Scenarios) sheetCalcPr (Sheet Calculation Properties) sheetData (Sheet Data) sheetFormatPr (Sheet Format Properties) sheetPr (Sheet Properties) sheetProtection (Sheet Protection Options) sheetViews (Sheet Views) smartTags (Smart Tags) sortState (Sort State) tableParts (Table Parts) webPublishItems (Web Publishing Items) * ORDER OF THE ABOVE: (sheet properties -- all optional) indicates that an autofilter has been applied indicates the used range on the sheet (there should be no data or formulas outside this range) indicates which cell and sheet are active default row height
protected void	writeSheetPrefix(WorkSheetHandle sheet, WorkBookHandle bk, int id) Handles preliminary writing of worksheets, essentially everything before elements start

Methods inherited from class io.starter.formats.XLS.OOXMLAdapter

addDeferredFile, addDeferredFile, addDeferredFile, cloneStack, deleteDir, getContentType, getEntry, getExOOXMLFileName, getFilename, getFormat, getNextText, getRelationshipType, getRelationshipTypeAbbrev, getStandaloneChartDrawingOOXML, getTempDir, hasMacros, nextZipEntry, parseBoolean, parseRels, refreshPassThroughFiles, reorderWbContentList, setFormat, sortSheets, stripNonAscii, stripNonAsciiRetainQuote, wrapInputStream, writeFileToZIP, writeSBToStreamEfficiently

Methods inherited from class java.lang.Object

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

Constructor Detail

OOXMLWriter

public OOXMLWriter()

Method Detail

getOOXML

public void getOOXML(WorkBookHandle bk,
                     OutputStream out)
              throws IOException

generates OOXML for a workbook (see specification above) Creates the ZIP file and writes all files into proper directory structure re: OPC

Parameters:

workbook -

out - outputStream used by ZipOutputStream

Throws:

IOException

writeDeferredFiles

protected void writeDeferredFiles()
                           throws IOException

write the deferred files to the zipfile

Throws:

IOException

writeRels

protected void writeRels(ArrayList cl,
                         String relsfname)
                  throws IOException

generic method for creating a .rels file from a content list array cl

Parameters:

cl - ArrayList contentList (type, filename)

relsfname -

Throws:

IOException

writeContentType

protected void writeContentType()
                         throws IOException

writes all package contents to [Content_Types].xml Package contents are contained in global array lists mainContentList, wbContentList, sheetsContentList, drContentList

Throws:

IOException

getOOXML

public void getOOXML(WorkBookHandle bk,
                     String path)
              throws Exception

generates OOXML for a workbook Creates the ZIP file and writes all files into proper directory structure Will create either an .xlsx or an .xlsm output, depending upon whether WorkBookHandle bk contains macros

Parameters:

bk - workbookhandle

path - output filename and path

Throws:

Exception

writeOOXML

protected void writeOOXML(WorkBookHandle bk)
                   throws IOException

Calls all the necessary methods to create style OOXML, workbook OOXML, sheet(s) OOXML ... Expects global zip var to be set to correct zip file

Parameters:

bk -

output -

Throws:

IOException

See Also:

getOOXML

writeSheetPrefix

protected void writeSheetPrefix(WorkSheetHandle sheet,
                                WorkBookHandle bk,
                                int id)
                         throws IOException

Handles preliminary writing of worksheets, essentially everything before elements start

Parameters:

sheet -

bk -

id -

Throws:

IOException

writeSheetOOXML

protected void writeSheetOOXML(WorkBookHandle bk,
                               WorkSheetHandle sheet,
                               int id)
                        throws IOException

writeSheetOOXML writes XML data in SheetML specificaiton to [worksheet].xml Main portion is the section, containing all row and cell information format of SheetML: ROOT autoFilter (AutoFilter Settings) Hides rows based upon criteria cellWatches (Cell Watch Items) colBreaks (Vertical Page Breaks) cols (Column Information) conditionalFormatting (Conditional Formatting) controls (Embedded Controls) customProperties (Custom Properties) customSheetViews (Custom Sheet Views) dataConsolidate (Data Consolidate) dataValidations (Data Validations) dimension (Worksheet Dimensions) drawing (Drawing) extLst (Future Feature Data Storage Area) headerFooter (Header Footer Settings) hyperlinks (Hyperlinks) ignoredErrors (Ignored Errors) legacyDrawing (Legacy Drawing Reference) legacyDrawingHF (Legacy Drawing Reference in Header Footer) mergeCells (Merge Cells) oleObjects (Embedded Objects) pageMargins (Page Margins) pageSetup (Page Setup Settings) phoneticPr (Phonetic Properties) picture (Background Image) printOptions (Print Options) protectedRanges (Protected Ranges) rowBreaks (Horizontal Page Breaks (Row)) scenarios (Scenarios) sheetCalcPr (Sheet Calculation Properties) sheetData (Sheet Data) sheetFormatPr (Sheet Format Properties) sheetPr (Sheet Properties) sheetProtection (Sheet Protection Options) sheetViews (Sheet Views) smartTags (Smart Tags) sortState (Sort State) tableParts (Table Parts) webPublishItems (Web Publishing Items) * ORDER OF THE ABOVE: (sheet properties -- all optional) indicates that an autofilter has been applied indicates the used range on the sheet (there should be no data or formulas outside this range) indicates which cell and sheet are active default row height cell table - specifies rows and cells with types and values (see below) -- REQUIRED ("Supporting Features" -- all optional)

Parameters:

bk -

sheet -

Throws:

IOException

writeMergedCellRecords

protected void writeMergedCellRecords(WorkSheetHandle sheet)
                               throws IOException

Write the merged cell records for a worksheet

Throws:

IOException

writeRow

public void writeRow(RowHandle row,
                     ArrayList hyperlinks)
              throws IOException

Writes a row and all contents to the zip output

Parameters:

hyperlinks -

Throws:

IOException

FormulaNotFoundException