org.openinvoice.text.doc

Class ReportDocument

java.lang.Object

org.openinvoice.text.doc.AbstractDocument

org.openinvoice.text.doc.ReportDocument

public class ReportDocument
extends AbstractDocument

Formats the invoice entries including the invoice items. To cover the invoices with multiple items, the invoice entry lists the items if there's more than one item. Created by jhe on 08/03/2018.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReportDocument.Keys

Nested classes/interfaces inherited from class org.openinvoice.text.doc.AbstractDocument

AbstractDocument.Format, AbstractDocument.MetaData

Constructor Summary

Constructors

Constructor and Description
ReportDocument(AbstractDocumentFormatter formatter)

Method Summary

Modifier and Type	Method and Description
String	createDefaultDocumentName() Created the report document file name based on the invoice period.
org.joda.money.CurrencyUnit	getCurrencyUnit()
File	getDefaultOutputFile()
File	getDefaultTemplateFile()
String	getOutputLanguageCode()
Map	getQueryCriteria()
ResultSet	getResultSet()
void	initTokens()
void	render(OutputStream userOutStream)
void	setCurrencyUnit(org.joda.money.CurrencyUnit currencyUnit)
void	setOutputLanguageCode(String outputLanguageCode)
void	setQueryCriteria(Map queryCriteria)
void	setResultSet(ResultSet resultSet)

Methods inherited from class org.openinvoice.text.doc.AbstractDocument

addDynamicToken, addLocalizedToken, addMetaData, getFormat, getFormatter, getLocalizedProperties, getMetaData, getOutputStream, getTemplateStream, getTemplateText, getTokenMap, setDocumentName, setFormat, setFormatter, setLocalizedProperties, setOutputStream, setTemplateStream, setTemplateText, setTokenMap, toUpperCase

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportDocument

public ReportDocument(AbstractDocumentFormatter formatter)
               throws SQLException

Throws:

SQLException

Method Detail

render

public void render(OutputStream userOutStream)
            throws IOException,
                   ConfigurationException,
                   SQLException

Overrides:

render in class AbstractDocument

Throws:

IOException

ConfigurationException

SQLException

initTokens

public void initTokens()
                throws IOException

Specified by:

initTokens in class AbstractDocument

Throws:

IOException

createDefaultDocumentName

public String createDefaultDocumentName()

Created the report document file name based on the invoice period. The file name has the following format: OPENINVOICE_Report_YYYY-MM-DD_YYYY-MM-DD.tex

Overrides:

createDefaultDocumentName in class AbstractDocument

getDefaultTemplateFile

public File getDefaultTemplateFile()
                            throws ConfigurationException

Specified by:

getDefaultTemplateFile in class AbstractDocument

Throws:

ConfigurationException

getDefaultOutputFile

public File getDefaultOutputFile()

Specified by:

getDefaultOutputFile in class AbstractDocument

getResultSet

public ResultSet getResultSet()

setResultSet

public void setResultSet(ResultSet resultSet)

getCurrencyUnit

public org.joda.money.CurrencyUnit getCurrencyUnit()

setCurrencyUnit

public void setCurrencyUnit(org.joda.money.CurrencyUnit currencyUnit)

getOutputLanguageCode

public String getOutputLanguageCode()

setOutputLanguageCode

public void setOutputLanguageCode(String outputLanguageCode)

getQueryCriteria

public Map getQueryCriteria()

setQueryCriteria

public void setQueryCriteria(Map queryCriteria)