Package com.nomagic.magicreport.engine.velocity

Class XLSXEngine

java.lang.Object

java.util.Observable

com.nomagic.magicreport.engine.AbstractTemplateEngine

com.nomagic.magicreport.engine.velocity.DefaultTemplateEngine

com.nomagic.magicreport.engine.velocity.XLSXEngine

All Implemented Interfaces:

IExtensionTemplateEngine, com.nomagic.magicreport.engine.IRuntimeInstanceVelocityEngine, ITemplateEngine, StyledDocument

@OpenApiAll
public class XLSXEngine
extends DefaultTemplateEngine
implements StyledDocument

The Velocity engine for OpenXML Excel Workbook (XLSX).

Since:

Dec 14, 2009

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XLSXEngine.SheetInfo	Class for hadler sheet data in XLSX.

Field Summary

Fields inherited from class com.nomagic.magicreport.engine.velocity.DefaultTemplateEngine

velocityContext

Fields inherited from class com.nomagic.magicreport.engine.AbstractTemplateEngine

context, isAborted, preProcessFile, processFile, properties

Fields inherited from interface com.nomagic.magicreport.format.html.StyledDocument

CHARACTER, COLOR, FONT, PARAGRAPH, TABLE

Constructor Summary

Constructors

Constructor	Description
XLSXEngine()	A class constructor.

Method Summary

Modifier and Type	Method	Description
int	addColor(Color color)	Add color for html to XLSX.
int	addFont(Font font)	Add font for html to XLSX.
void	addImage(String format)	Add image format to list.
int	addList(List list)	Add list for html to XLSX.
int	addObject(Object object)	Appends object content into the document.
int	addStyle(Style style)	Add style for html to XLSX.
protected ParseErrorException	createParseErrorWrapper(ParseErrorException parseError, Reader source)	Create a ParseErrorException from the message.
Template	createTemplate()	Creates a new Template object for generating report by this engine.
Template	createTemplate(File input, File output)	Creates a new Template object.
Template	createTemplate(File input, File output, boolean ignoreLocation)	Creates a new Template object.
void	evaluate(Template template)	Merge a template with current context and rendered stream into the writer.
int	getChartID()
Set<String>	getEntrySet()	Return XLSX entry set.
float[]	getPageSize()	Return page size.
Template	getTemplate()	Return template.
protected void	handleForColumn(Template template, StringBuilder inProcessBuffer)	Handle the #forcol directive.
protected void	handleForPage(Template template, StringBuilder inProcessBuffer)	Handle the #forpage directive.
protected void	handleForRow(Template template, StringBuilder inProcessBuffer)	Handle the #forrow directive.
protected void	handleMergeColumns(Template template, StringBuilder inProcessBuffer)	Handle $tableprop.mergeColumns directive
protected void	handleMergeRows(Template template, StringBuilder inProcessBuffer)	Handle $tableprop.mergeRows directive
void	increaseChartID()
protected int	lineCount(String content)	Count number of line from given content string.
protected void	postProcess(Template template)	Perform a post-processing after the template has been evaluated.
protected TemplateException	processException(Template template, ParseErrorException e)	Call this method to process a ParseErrorException.
protected TemplateException	processVelocityException(Template template, org.apache.velocity.exception.ParseErrorException e)	Call this method to process an Velocity exception and return in new format.
void	setChartID(int chartID)
protected BufferedWriter	setWriterForEvaluate(Template template)
protected void	translate(Template template, StringBuilder inProcessBuffer)	Process the template in inProcessBuffer into valid format.

Methods inherited from class com.nomagic.magicreport.engine.velocity.DefaultTemplateEngine

abort, checkFileNotFoundException, clearTools, createComment, destroy, getClassLoader, getFormatter, getResolvedSectionName, handleImport, handleIncludeSection, handleSectionBegin, isNoSpaceException, preProcess, process, process, processVelocityException, setClassLoader, setFormatter, setLatestLocation, setLocation, setProperty, trimTrailSpace

Methods inherited from class com.nomagic.magicreport.engine.AbstractTemplateEngine

addContext, addInvalidReferenceHandler, addObserver, addReferenceInsertionHandler, evaluate, getConcurrentToolException, getContext, getCurrentRuntimeInstance, getInvalidReferenceHandler, getProcessSize, getProperties, getProperty, getReferenceInsertionHandler, isMemoryMode, notifyObservers, observers, setConcurrentToolException, setContext, setCurrentRuntimeInstance

Methods inherited from class java.util.Observable

clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Constructor Details

XLSXEngine

public XLSXEngine()

A class constructor.

Method Details

createTemplate

public Template createTemplate()

Creates a new Template object for generating report by this engine.

Specified by:

createTemplate in interface ITemplateEngine

Overrides:

createTemplate in class DefaultTemplateEngine

Returns:

an instance of Template

See Also:

• DefaultTemplateEngine.createTemplate(File, File)

createTemplate

public Template createTemplate(File input,
 File output)
                        throws IOException

Creates a new Template object.

Specified by:

createTemplate in interface ITemplateEngine

Overrides:

createTemplate in class DefaultTemplateEngine

Parameters:

input - template file.

output - output file.

Returns:

an instance of Template

Throws:

FileNotFoundException - if the file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened.

IOException - If an I/O error occurs

createTemplate

public Template createTemplate(File input,
 File output,
 boolean ignoreLocation)
                        throws IOException

Creates a new Template object.

Overrides:

createTemplate in class DefaultTemplateEngine

Parameters:

input - template file.

output - output file.

ignoreLocation - true to ignore location property for child document

Returns:

an instance of Template

Throws:

FileNotFoundException - if the file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened.

IOException - If an I/O error occurs

getTemplate

public Template getTemplate()

Return template.

Returns:

a XLSX template

getEntrySet

public Set<String> getEntrySet()

Return XLSX entry set.

Returns:

XLSX entry set.

addImage

public void addImage(String format)

Add image format to list.

Parameters:

format - format of image

getPageSize

public float[] getPageSize()

Return page size.

Returns:

float[] pageSize

getChartID

public int getChartID()

setChartID

public void setChartID(int chartID)

increaseChartID

public void increaseChartID()

evaluate

public void evaluate(Template template)
              throws TemplateException

Merge a template with current context and rendered stream into the writer.

Specified by:

evaluate in interface ITemplateEngine

Overrides:

evaluate in class AbstractTemplateEngine

Parameters:

template - Template being evaluated

Throws:

ParseErrorException - if a syntax or other error which prevents it from being parsed.

InitializationEngineException - error while initializing engine

TemplateException - other error while processing the template

See Also:

• ITemplateEngine.evaluate(Template)

setWriterForEvaluate

protected BufferedWriter setWriterForEvaluate(Template template)

Overrides:

setWriterForEvaluate in class DefaultTemplateEngine

translate

protected void translate(Template template,
 StringBuilder inProcessBuffer)
                  throws ParseErrorException,
IOException

Process the template in inProcessBuffer into valid format.

Overrides:

translate in class DefaultTemplateEngine

Parameters:

template - Template source.

inProcessBuffer - in process buffer.

Throws:

ParseErrorException - when error while translation, or syntax not recognized.

IOException - if IO Error occurs while reading template.

createParseErrorWrapper

protected ParseErrorException createParseErrorWrapper(ParseErrorException parseError,
 Reader source)

Create a ParseErrorException from the message.

Parameters:

parseError - root cause

source - source template

Returns:

instance of ParseErrorException

processException

protected TemplateException processException(Template template,
 ParseErrorException e)

Call this method to process a ParseErrorException. This method call internally by postProcess(Template). If code was performed by Velocity (DefaultTemplateEngine.process(Template)), uses method processVelocityException(Template, org.apache.velocity.exception.ParseErrorException). By default this method try to calculate line number from ParseErrorException.getSource().

Overrides:

processException in class DefaultTemplateEngine

Parameters:

template - Template

e - MagicReport parse error exception

Returns:

TemplateException

processVelocityException

protected TemplateException processVelocityException(Template template,
 org.apache.velocity.exception.ParseErrorException e)

Call this method to process an Velocity exception and return in new format. Override DefaultTemplateEngine.processVelocityException(Template, org.apache.velocity.exception.ParseErrorException) to return exception with valid ODF line count.

Overrides:

processVelocityException in class DefaultTemplateEngine

Parameters:

template - Template

e - Velocity exception

Returns:

TemplateException

lineCount

protected int lineCount(String content)

Count number of line from given content string.

Overrides:

lineCount in class DefaultTemplateEngine

Parameters:

content - the input string

Returns:

number of line

handleForPage

protected void handleForPage(Template template,
 StringBuilder inProcessBuffer)
                      throws ParseErrorException

Handle the #forpage directive.

Overrides:

handleForPage in class DefaultTemplateEngine

Parameters:

template - Template source.

inProcessBuffer - in process buffer.

Throws:

ParseErrorException - when error while translation, or syntax not recognized.

handleForColumn

protected void handleForColumn(Template template,
 StringBuilder inProcessBuffer)
                        throws ParseErrorException

Handle the #forcol directive.

Parameters:

template - Template source.

inProcessBuffer - in process buffer.

Throws:

ParseErrorException - when error while translation, or syntax not recognized.

handleMergeColumns

protected void handleMergeColumns(Template template,
 StringBuilder inProcessBuffer)
                           throws ParseErrorException

Handle $tableprop.mergeColumns directive

Parameters:

template - Template source.

inProcessBuffer - in process buffer.

Throws:

ParseErrorException - when error while translation, or syntax not recognized.

handleForRow

protected void handleForRow(Template template,
 StringBuilder inProcessBuffer)
                     throws ParseErrorException

Handle the #forrow directive.

Overrides:

handleForRow in class DefaultTemplateEngine

Parameters:

template - Template source.

inProcessBuffer - in process buffer.

Throws:

ParseErrorException - when error while translation, or syntax not recognized.

handleMergeRows

protected void handleMergeRows(Template template,
 StringBuilder inProcessBuffer)
                        throws ParseErrorException

Handle $tableprop.mergeRows directive

Parameters:

template - Template source.

inProcessBuffer - in process buffer.

Throws:

ParseErrorException - when error while translation, or syntax not recognized.

postProcess

protected void postProcess(Template template)
                    throws TemplateException

Perform a post-processing after the template has been evaluated.

Overrides:

postProcess in class DefaultTemplateEngine

Parameters:

template - template after evaluated.

Throws:

ParseErrorException - if a syntax or other error which prevents it from being parsed.

InitializationEngineException - error while initializing engine

TemplateException - other error while processing the template

See Also:

• DefaultTemplateEngine.postProcess(com.nomagic.magicreport.Template)

addFont

public int addFont(Font font)

Add font for html to XLSX.

Specified by:

addFont in interface StyledDocument

Parameters:

font - font

Returns:

font id

addList

public int addList(List list)

Add list for html to XLSX.

Specified by:

addList in interface StyledDocument

Parameters:

list - list

Returns:

list id

addStyle

public int addStyle(Style style)

Add style for html to XLSX.

Specified by:

addStyle in interface StyledDocument

Parameters:

style - style

Returns:

style id

addColor

public int addColor(Color color)

Add color for html to XLSX.

Specified by:

addColor in interface StyledDocument

Parameters:

color - color

Returns:

color id

addObject

public int addObject(Object object)

Appends object content into the document.

Specified by:

addObject in interface StyledDocument

Parameters:

object - adding object

Returns:

index to object