io.starter.formats.XLS

Class OOXMLReader

java.lang.Object

io.starter.formats.XLS.OOXMLAdapter

io.starter.formats.XLS.OOXMLReader

All Implemented Interfaces:

OOXMLConstants

public class OOXMLReader
extends OOXMLAdapter
implements OOXMLConstants

Breaking out functionality for reading out of OOXMLAdapter

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	parsePivotTables

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
OOXMLReader()

Method Summary

Modifier and Type	Method and Description
protected static String	getCurrentElement(org.xmlpull.v1.XmlPullParser xpp) retrieves the entire element at the current position in the xpp pullparser, as a string, and advances the pullparser position to the next element
protected static String	getInlineString(org.xmlpull.v1.XmlPullParser xpp) XmlPullParser positioned on child of the (cell) element in sheetXXX.xml
protected static void	handlePassThroughs(ZipFile zip, WorkBookHandle bk, String parentDir, String externalDir, String[] c) pass-through current OOXML element/file - i.e.
protected static void	handleSheetPassThroughs(ZipFile zip, WorkBookHandle bk, Boundsheet sht, String parentDir, String externalDir, String[] c, String attrs) pass-through current sheet-level OOXML element/file - i.e.
protected void	parseBookLevelElements(WorkBookHandle bk, WorkSheetHandle sheet, ZipFile zip, ArrayList cl, String parentDir, ArrayList formulas, ArrayList hyperlinks, HashMap inlineStrs, HashMap<String,String> pivotCaches, HashMap<String,WorkSheetHandle> pivotTables) parses OOXML content files given a content list cl from zip file zip recurses if content file has it's own content ************************************* NOTE: certain elements we do not as of yet process; we "pass-through" or store such elements along with any embedded objects associated with them for example, activeX objects, vbaProject.bin, etc.
void	parseNBind(WorkBookHandle bk, String fName) OOXML parseNBind - reads in an OOXML (Excel 7) workbook
protected static String	parsePathForZip(String p, String parentDir) get correct path for zip access based on path p and parent directory parentDir
protected static void	passThrough(ZipFile zip, String fin, String fout) handle OOXML files that we do not process at this time.
static void	refreshExternalFiles(ZipFile zipIn, String externalDir) retrieve pass-through files (Files not processed by normal WBH channels) for later writing
protected CellHandle	sheetAdd(WorkSheetHandle sheet, Object val, Object cachedval, int r, int c, int fmtid) intercept Sheet adds and hand off to parse event listener as needed
protected static String[]	storeEmbeds(ZipFile zip, ZipEntry target, String p, String externalDir) take a passthrough element such as vmldrawing or theme which contains embedded objects (images), retrieve and store for later re-writing to zip

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

Field Detail

parsePivotTables

protected static boolean parsePivotTables

Constructor Detail

OOXMLReader

public OOXMLReader()

Method Detail

parseNBind

public void parseNBind(WorkBookHandle bk,
                       String fName)
                throws org.xmlpull.v1.XmlPullParserException,
                       IOException,
                       CellNotFoundException

OOXML parseNBind - reads in an OOXML (Excel 7) workbook

Parameters:

bk - WorkBookHandle - workbook to input

fName - OOXML filename (must be a ZIP file in OPC format)

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

CellNotFoundException

parseBookLevelElements

protected void parseBookLevelElements(WorkBookHandle bk,
                                      WorkSheetHandle sheet,
                                      ZipFile zip,
                                      ArrayList cl,
                                      String parentDir,
                                      ArrayList formulas,
                                      ArrayList hyperlinks,
                                      HashMap inlineStrs,
                                      HashMap<String,String> pivotCaches,
                                      HashMap<String,WorkSheetHandle> pivotTables)
                               throws org.xmlpull.v1.XmlPullParserException,
                                      CellNotFoundException

parses OOXML content files given a content list cl from zip file zip recurses if content file has it's own content ************************************* NOTE: certain elements we do not as of yet process; we "pass-through" or store such elements along with any embedded objects associated with them for example, activeX objects, vbaProject.bin, etc. *************************************

Parameters:

bk - WorkBookHandle

sheet - WorkSheetHandle (set if recursing)

zip - currently open ZipOutputStream

cl - ArrayList of Contents (type, filename, rId) to parse

parentDir - Parent Directory for relative paths in content lists

formulas, - hyperlinks, inlineStrs -- ArrayLists/Hashmaps stores sheet-specific info for later entry

Throws:

CellNotFoundException

org.xmlpull.v1.XmlPullParserException

handlePassThroughs

protected static void handlePassThroughs(ZipFile zip,
                                         WorkBookHandle bk,
                                         String parentDir,
                                         String externalDir,
                                         String[] c)
                                  throws IOException

pass-through current OOXML element/file - i.e. save file to external directory on disk because it cannot be processed into our normal BIFF8 machinery also, if current OOXML element has an associated .rels file containing links to other files known as "embeds", store embeds on disk and link information to for later retrieval
Possible pass-through types:
props
exprops
custprops
connections
calc
vba
externalLink

Parameters:

c - String[] {type, filename, rid}

Throws:

IOException

handleSheetPassThroughs

protected static void handleSheetPassThroughs(ZipFile zip,
                                              WorkBookHandle bk,
                                              Boundsheet sht,
                                              String parentDir,
                                              String externalDir,
                                              String[] c,
                                              String attrs)
                                       throws IOException

pass-through current sheet-level OOXML element/file - i.e. save file to external directory on disk because it cannot be processed into our normal BIFF8 machinery also, if current OOXML element has an associated .rels file containing links to other files known as "embeds", store embeds on disk and link information to for later retrieval

Parameters:

c - String[] {type, filename, rid}

Throws:

IOException

passThrough

protected static void passThrough(ZipFile zip,
                                  String fin,
                                  String fout)
                           throws IOException

handle OOXML files that we do not process at this time.
Writes the file in question from zip file fin to file directory file fout

Parameters:

zip -

fin -

fout -

Throws:

IOException

parsePathForZip

protected static String parsePathForZip(String p,
                                        String parentDir)

get correct path for zip access based on path p and parent directory parentDir

Parameters:

p -

parentDir -

getCurrentElement

protected static String getCurrentElement(org.xmlpull.v1.XmlPullParser xpp)

retrieves the entire element at the current position in the xpp pullparser, as a string, and advances the pullparser position to the next element

Parameters:

xpp -

Returns:

getInlineString

protected static String getInlineString(org.xmlpull.v1.XmlPullParser xpp)
                                 throws org.xmlpull.v1.XmlPullParserException,
                                        IOException

XmlPullParser positioned on child of the (cell) element in sheetXXX.xml

Parameters:

xpp - XmlPullParser

Returns:

String inline text

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

storeEmbeds

protected static String[] storeEmbeds(ZipFile zip,
                                      ZipEntry target,
                                      String p,
                                      String externalDir)
                               throws IOException

take a passthrough element such as vmldrawing or theme which contains embedded objects (images), retrieve and store for later re-writing to zip

Parameters:

zip - open ZipFile

target - ZipEntry pointing to .rels

p - path

Returns:

String[] array of embeds

Throws:

IOException

sheetAdd

protected CellHandle sheetAdd(WorkSheetHandle sheet,
                              Object val,
                              Object cachedval,
                              int r,
                              int c,
                              int fmtid)

intercept Sheet adds and hand off to parse event listener as needed

refreshExternalFiles

public static void refreshExternalFiles(ZipFile zipIn,
                                        String externalDir)

retrieve pass-through files (Files not processed by normal WBH channels) for later writing

Parameters:

zipIn -

externalDir -