io.starter.formats.XLS

Class OOXMLAdapter

java.lang.Object

io.starter.formats.XLS.OOXMLAdapter

All Implemented Interfaces:

OOXMLConstants

Direct Known Subclasses:

OOXMLReader, OOXMLWriter

public class OOXMLAdapter
extends Object
implements OOXMLConstants

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	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
OOXMLAdapter()

Method Summary

Modifier and Type	Method and Description
protected void	addDeferredFile(byte[] b, String fn) write a temp file for later inclusion in the zip file
protected File	addDeferredFile(String name)
protected void	addDeferredFile(StringBuffer sb, String fn) write a temp file for later inclusion in the zip file
protected Stack	cloneStack(Stack origStack) creates a copy of a stack so changes won't affect original
static boolean	deleteDir(File f)
protected String	getContentType(String type) utility to look up Content Type string for type abbreviation
protected static ZipEntry	getEntry(ZipFile f, String name) used as a way to monitor Zip Entry fetching Oct 14, 2010
protected String	getExOOXMLFileName(String f) generic utility to take the original external object filename and parse it using a new ordinal id e.g.
protected static String	getFilename(ArrayList contentList, String rId) return the file matching rId in the ContentList (String[] type, filename, rId)
int	getFormat()
static String	getNextText(org.xmlpull.v1.XmlPullParser xpp) utility to retrieve Text element for tag
protected String	getRelationshipType(String type) utility to look up Relationship Type string for type abbreviation
protected static String	getRelationshipTypeAbbrev(String type) utility to retrieve correct relationship type abbreviation string from verbose type string
static String	getStandaloneChartDrawingOOXML(ChartHandle ch) get a standalone ChartML document
static String	getTempDir(String f)
static boolean	hasMacros(Document bk) return true of workbook bk contains macros
protected void	nextZipEntry(String name)
static boolean	parseBoolean(String value) Parses an xsd:boolean value.
protected static ArrayList	parseRels(InputStream ii) parses any .rels file into content List array list
static void	refreshPassThroughFiles(WorkBookHandle wbh) re-save to temp directroy any "pass-through" OOXML files i.e.
protected void	reorderWbContentList(ArrayList wbContentList) simple utility that ensures that sheets are last in the workbookcontent list also ensure that theme(s) are parsed first, as are used in styles etc.
void	setFormat(int format) set the XLSX format for this WorkBook either FORMAT_XLSX, FORMAT_XLSM (Macro-enabled), FORMAT_XLTS (template) or FORMAT_XLTM (Macro-enabled template) NOTE: If file extension is .XLSM format FORMAT_XLSM must be set either because there are macros present or because the filename is unconditionally set to .XLSM
protected static void	sortSheets(ArrayList cl) sorts the sheets for incoming workbook xlsx -- used for eventMode only Jan 19, 2011
static StringBuffer	stripNonAscii(String s) Strip non-ascii (i.e.
static StringBuffer	stripNonAsciiRetainQuote(String s) Strip non-ascii (i.e.
protected static InputStream	wrapInputStream(InputStream in) deal with the "BOM" input streams...
protected void	writeFileToZIP(String f2write, String fname) utility which, given an an exisitng file f2write, creates zipEntry and writes to zip var NOTE: global zip ZipOutputStream must be open
static void	writeSBToStreamEfficiently(StringBuffer aSB, Writer ous) A memory efficient way to write a StringBuffer to an OutputStream without creating Strings and other Objects.

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

protected boolean DEBUG

Constructor Detail

OOXMLAdapter

public OOXMLAdapter()

Method Detail

setFormat

public void setFormat(int format)

set the XLSX format for this WorkBook
either FORMAT_XLSX, FORMAT_XLSM (Macro-enabled), FORMAT_XLTS (template) or FORMAT_XLTM (Macro-enabled template)
NOTE: If file extension is .XLSM format FORMAT_XLSM must be set
either because there are macros present or because the filename
is unconditionally set to .XLSM

Parameters:

format -

getFormat

public int getFormat()

parseBoolean

public static final boolean parseBoolean(String value)

Parses an xsd:boolean value.

Parameters:

value - the string to parse

Returns:

the boolean value of the given string

Throws:

IllegalArgumentException - if the given string is not a valid boolean value

getStandaloneChartDrawingOOXML

public static String getStandaloneChartDrawingOOXML(ChartHandle ch)

get a standalone ChartML document

Parameters:

ch -

Returns:

getExOOXMLFileName

protected String getExOOXMLFileName(String f)

generic utility to take the original external object filename and parse it using a new ordinal id e.g. image10.emf may become image3.emf NOTE: Increments global ordinal ids

Parameters:

f - Original filename with path

Returns:

New filename

addDeferredFile

protected void addDeferredFile(StringBuffer sb,
                               String fn)

write a temp file for later inclusion in the zip file

Parameters:

sb -

fn -

writeSBToStreamEfficiently

public static void writeSBToStreamEfficiently(StringBuffer aSB,
                                              Writer ous)
                                       throws IOException

A memory efficient way to write a StringBuffer to an OutputStream without creating Strings and other Objects. Mar 9, 2012

Parameters:

aSB -

ous -

Throws:

IOException

addDeferredFile

protected File addDeferredFile(String name)
                        throws IOException

Throws:

IOException

addDeferredFile

protected void addDeferredFile(byte[] b,
                               String fn)
                        throws IOException

write a temp file for later inclusion in the zip file

Parameters:

sb -

fn -

Throws:

IOException

hasMacros

public static boolean hasMacros(Document bk)

return true of workbook bk contains macros

Parameters:

bk -

Returns:

writeFileToZIP

protected void writeFileToZIP(String f2write,
                              String fname)
                       throws IOException

utility which, given an an exisitng file f2write, creates zipEntry and writes to zip var NOTE: global zip ZipOutputStream must be open

Parameters:

f2write - name and path of exisitng file

fname - desired name in zip

Throws:

IOException

nextZipEntry

protected void nextZipEntry(String name)
                     throws IOException

Throws:

IOException

getContentType

protected String getContentType(String type)

utility to look up Content Type string for type abbreviation

Parameters:

type -

Returns:

getRelationshipType

protected String getRelationshipType(String type)

utility to look up Relationship Type string for type abbreviation

Parameters:

type -

Returns:

See Also:

OOXMLConstnats

getRelationshipTypeAbbrev

protected static String getRelationshipTypeAbbrev(String type)

utility to retrieve correct relationship type abbreviation string from verbose type string

Parameters:

type -

Returns:

See Also:

OOXMLConstants

stripNonAscii

public static StringBuffer stripNonAscii(String s)

Strip non-ascii (i.e. xml non-valid) chars from Strings This is utilized for xml attributes, node values can contain quote symbols

Parameters:

s -

Returns:

stripNonAsciiRetainQuote

public static StringBuffer stripNonAsciiRetainQuote(String s)

Strip non-ascii (i.e. xml non-valid) chars from Strings Node values can contain quote symbols

Parameters:

s -

Returns:

wrapInputStream

protected static InputStream wrapInputStream(InputStream in)

deal with the "BOM" input streams... http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4508058 Oct 14, 2010

Parameters:

in -

Returns:

getEntry

protected static ZipEntry getEntry(ZipFile f,
                                   String name)

used as a way to monitor Zip Entry fetching Oct 14, 2010

Parameters:

f -

name -

Returns:

parseRels

protected static ArrayList parseRels(InputStream ii)

parses any .rels file into content List array list

Parameters:

ii -

Returns:

getNextText

public static String getNextText(org.xmlpull.v1.XmlPullParser xpp)
                          throws IOException,
                                 org.xmlpull.v1.XmlPullParserException

utility to retrieve Text element for tag

Parameters:

xpp -

Returns:

Throws:

IOException

org.xmlpull.v1.XmlPullParserException

reorderWbContentList

protected void reorderWbContentList(ArrayList wbContentList)

simple utility that ensures that sheets are last in the workbookcontent list also ensure that theme(s) are parsed first, as are used in styles etc. in order to create all dependent objects first

Parameters:

wbContentList -

getFilename

protected static String getFilename(ArrayList contentList,
                                    String rId)

return the file matching rId in the ContentList (String[] type, filename, rId)

Parameters:

contentList -

rId -

Returns:

cloneStack

protected Stack cloneStack(Stack origStack)

creates a copy of a stack so changes won't affect original

Parameters:

origStack -

Returns:

deleteDir

public static boolean deleteDir(File f)

getTempDir

public static String getTempDir(String f)
                         throws IOException

Throws:

IOException

sortSheets

protected static void sortSheets(ArrayList cl)
                          throws Exception

sorts the sheets for incoming workbook xlsx -- used for eventMode only Jan 19, 2011

Parameters:

cl -

Throws:

Exception

refreshPassThroughFiles

public static void refreshPassThroughFiles(WorkBookHandle wbh)

re-save to temp directroy any "pass-through" OOXML files i.e. files/entities not present in 2003-version and thus not processed
(app.xml, theme.xml ...)

Parameters:

wbh -