org.posper.hibernate.formatters

Class TicketFormatter

java.lang.Object

org.posper.hibernate.formatters.TicketFormatter

public class TicketFormatter
extends Object

A TicketFormatter object is passed to the Velocity engine when printing a ticket (variable ticket), which makes the methods available in the following velocity templates:

• Printer.Ticket
• Printer.Ticket.Fiscal
• Printer.TicketCopy
• Printer.TicketTotal
• Printer.TicketUser
• Printer.DeliveryNote

We rather propagate formatter objects than the object itself to a velocity script to avoid fiddeling with the object. TicketFormatter methods should not be designed to change ticket objects unless it's explicitely desired to implement ticket changes going along with ticket printing (e.g. mark a ticketline as printed).

Author:

Aaron Luchko , hans

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.log4j.Logger	contentLogger

Constructor Summary

Constructors

Constructor and Description
TicketFormatter(Ticket ticket) Create a formatter object for a ticket.

Method Summary

Modifier and Type	Method and Description
int	calculateItemCount() Get the total of items for a ticket.
String	getCompanyData(String element) Retrieve elements from the CompanyData.xml ressource.
CustomerFormatter	getCustomer() When tickets are printed from an environment which does not supply the $customer variable this method can be used to get the CustomerFormatter for this ticket.
Double	getDiscount() Calculate the discount amount for the ticket.
Integer	getGuests() Retrieve the number of guests which is assigned when a ticket is created.
String	getHost()
List<KitchenLineFormatter>	getKitchenLines() Get a list of kitchen line formatters.
List<TicketLineFormatter>	getLines() Get a list of formatters for the tickets lines.
Integer	getNumber() Retrieve the ticket number which is assigned when a ticket is closed.
List<PaymentFormatter>	getPayments() Get a list of formatters for the tickets payments.
String	getPlace() Print the name of the place the ticket is assigned to (xml escaped string).
String	getSignature() Print the signature string of the ticket as XML escaped string.
SignatureFormatter	getSignatureFormatter() Get a SignatureFormatter which will provide methods to retrieve signature information according to country specific fiscal regulations - Find the formatters layout in SignatureFormatter<country-code>.
Double	getSubTotalByTax(TaxFormatter taxFormatter) Get the total taxable base (=nat value) for the tax represented by the tax formatter object.
List<TaxFormatter>	getTaxes() Each ticketline is associated with one or more (if combined taxes are used) taxes.
Double	getTaxSum(TaxFormatter taxFormatter) Get the total tax for the tax represented by the tax formatter object.
String	getTaxTotal(TaxFormatter taxFormatter) Deprecated. Use printTaxSum instead.
double	getTotal() Calculate the total amount for the ticket.
Double	getTotalByTax(TaxFormatter taxFormatter) Get the total taxable (= gross value) for the tax represented by the tax formatter object.
UserFormatter	getUser() Get the formatter object for the user assigned to the ticket.
Integer	getVisibleId() Retrieve the tickets visibleId which is assigned when a ticket is created.
boolean	hasStatus(int status) Check if the status matches the given status mask.
boolean	isCancelled() Deprecated. Use isVoided() instead.
boolean	isTraining() Check if the ticket is a training ticket.
boolean	isVoided() Check if the ticket is voided.
boolean	isVoiding() Check if the ticket is a voiding ticket.
void	logTicket() logTicket() shall report ticket data like dateClose, user, place, ...
String	printComment() Print the tickets comment entry.
String	printCurrentDate(String pattern) Prints the current date formatted according to the given pattern.
String	printDateClose(String pattern) Print the tickets closing date.
String	printDateClose(String pattern, String language) Print the tickets closing date.
String	printDateClose(String pattern, String language, String country) Print the tickets closing date.
String	printDateClose(String pattern, String language, String country, String variant) Print the tickets closing date.
String	printDiscount() Print the currency formatted discount granted for the ticket
String	printDiscountPercent() Print the discount percentage granted for the line total
String	printHost() Print the hostname like defined in config
String	printPlace() Print the name of the place the ticket is assigned to.
String	printReceiptClose() Deprecated. Use printDateClose instead
String	printReference() Print the visibleId of the referenced ticket, if any.
String	printsDiscount() Print the discount granted for the ticket
String	printSignature() Print the signature string of the ticket which shall be contained in the QR-code printed on the ticket amd as described in the BDI documents.
String	printSignatureCounter() Return the signature counter from the QR code as string
String	printSignatureValue() Print the signature as returned by the TSE.
String	printsSubTotal() Calculate the subtotal for the ticket which is the net amount w/o taxes.
String	printsSubTotalByTax(TaxFormatter taxFormatter) Calculate the subtotal for the ticketlines matching the given tax.
String	printsTaxes() Calculate the tax total for the ticket.
String	printsTaxSum(TaxFormatter taxFormatter) Print the total for the tax represented by the tax formatter object.
String	printsTotal() Calculate the total amount for the ticket.
String	printsTotalByTax(TaxFormatter taxFormatter) Calculate the subtotal for the ticket which is the net amount w/o taxes.
String	printSubTotal() Calculate the subtotal for the ticket which is the net amount w/o taxes.
String	printSubTotalByTax(TaxFormatter taxFormatter) Calculate the subtotal for the ticketlines matching the given tax.
String	printTaxes() Calculate the tax total for the ticket.
String	printTaxSum(TaxFormatter taxFormatter) Print the total for the tax represented by the tax formatter object.
String	printTotal() Calculate the total amount for the ticket.
String	printTotalByTax(TaxFormatter taxFormatter) Calculate the subtotal for the ticket which is the net amount w/o taxes.
String	printTransactionEnd() Print the start date of the transaction
String	printTransactionNumber() Print the transaction number as String if the transaction has finshed or an error message otherwise.
String	printTransactionStart() Print the start date of the transaction - shall only be used for Gastro and is actually the creation date of a place ticket
String	printVoidingReference()
void	refreshCompanyData() Reread the company data resource.
List<String>	splitStringToLines(String sOldLine, int iMaxLen) Split a string in lines, length of lines defined with parameter iMaxLen.

Methods inherited from class java.lang.Object

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

Field Detail

contentLogger

protected org.apache.log4j.Logger contentLogger

Constructor Detail

TicketFormatter

public TicketFormatter(Ticket ticket)

Create a formatter object for a ticket.

Parameters:

ticket -

Method Detail

printTaxes

public String printTaxes()

Calculate the tax total for the ticket. For each line the value is calculated in full precision and then the sum over all lines is rounded to currency precision in the formatting procedure.

Returns:

a currency formatted string.

printsTaxes

public String printsTaxes()

Calculate the tax total for the ticket.

Returns:

a 2 decinal formatted string.

printTotal

public String printTotal()

Calculate the total amount for the ticket. For each line subtotal and taxes are both calculated and rounded to currency precision before all values are summed up. The result is formatted to currency precision with currency symbol.

Returns:

a currency formatted String.

printsTotal

public String printsTotal()

Calculate the total amount for the ticket. For each line subtotal and taxes are both calculated and rounded to currency precision before all values are summed up. The result is formatted to 2 digits precision without currency symbol.

Returns:

a 2 decimals formatted String.

getTotal

public double getTotal()

Calculate the total amount for the ticket. For each line subtotal and taxes are both calculated and rounded to currency precision before all values are summed up.

Returns:

the amount as double

printSubTotal

public String printSubTotal()

Calculate the subtotal for the ticket which is the net amount w/o taxes. The amount is rounded to currency precision before the values are summed up.

Returns:

a currency formatted String.

printsSubTotal

public String printsSubTotal()

Calculate the subtotal for the ticket which is the net amount w/o taxes. The amount is rounded to currency precision before the values are summed up.

Returns:

a 2 decimals formatted String.

printSubTotalByTax

public String printSubTotalByTax(TaxFormatter taxFormatter)

Calculate the subtotal for the ticketlines matching the given tax. The amount is rounded to currency precision before the values are summed up.

Parameters:

taxFormatter - a tax formatter object. A list of taxes can be retrieved getTaxes().

Returns:

a currency formatted String.

printTotalByTax

public String printTotalByTax(TaxFormatter taxFormatter)

Calculate the subtotal for the ticket which is the net amount w/o taxes. The amount is rounded to currency precision before the values are summed up.

Parameters:

taxFormatter - taxFormatter a tax formatter object. A list of taxes can be retrieved getTaxes().

Returns:

a currency formatted String.

printsSubTotalByTax

public String printsSubTotalByTax(TaxFormatter taxFormatter)

Calculate the subtotal for the ticketlines matching the given tax. The amount is rounded to currency precision before the values are summed up.

Parameters:

taxFormatter - taxFormatter a tax formatter object. A list of taxes can be retrieved getTaxes().

Returns:

a 2 decimals formatted String.

printsTotalByTax

public String printsTotalByTax(TaxFormatter taxFormatter)

Calculate the subtotal for the ticket which is the net amount w/o taxes. The amount is rounded to currency precision before the values are summed up.

Parameters:

taxFormatter - taxFormatter a tax formatter object. A list of taxes can be retrieved getTaxes().

Returns:

a 2 decimals formatted String.

printReceiptClose

public String printReceiptClose()

Deprecated. Use printDateClose instead

Print the tickets closing date. If the stored date is null, the current date will be returned.

Returns:

a timestamp formatted String

printDateClose

public String printDateClose(String pattern)

Print the tickets closing date. If the stored date is null, the current date will be returned. For more information please have a look at class SimpleDateFormat.

Parameters:

pattern - a simple date format pattern

Returns:

a date formatted String

printDateClose

public String printDateClose(String pattern,
                             String language)

Print the tickets closing date. If the stored date is null, the current date will be returned. For more information please have a look at class SimpleDateFormat and class Locale.

Parameters:

pattern - a simple date format pattern

language - the language code to be used for Locale

Returns:

a date formatted String

printDateClose

public String printDateClose(String pattern,
                             String language,
                             String country)

Print the tickets closing date. If the stored date is null, the current date will be returned. For more information please have a look at class SimpleDateFormat and class Locale.

Parameters:

pattern - a simple date format pattern

language - the language code to be used for Locale

country - the country code to be used for Locale

Returns:

a date formatted String

printDateClose

public String printDateClose(String pattern,
                             String language,
                             String country,
                             String variant)

Print the tickets closing date. If the stored date is null, the current date will be returned. For more information please have a look at class SimpleDateFormat and class Locale.

Parameters:

pattern - a simple date format pattern

variant - the variant code to be used for Locale

country - the country code to be used for Locale

language - the language code to be used for Locale

Returns:

a date formatted String

getNumber

public Integer getNumber()

Retrieve the ticket number which is assigned when a ticket is closed. The ticket number is not shown in the ticket window. It should be printed on the receipt because this is the number to be referenced for editing a ticket.

Returns:

the number as integer.

getGuests

public Integer getGuests()

Retrieve the number of guests which is assigned when a ticket is created.

Returns:

getVisibleId

public Integer getVisibleId()

Retrieve the tickets visibleId which is assigned when a ticket is created. The visibleId is shown in the ticket window.

Returns:

the number as integer.

getUser

public UserFormatter getUser()

Get the formatter object for the user assigned to the ticket.

Returns:

a UserFormatter object.

printComment

public String printComment()

Print the tickets comment entry.

Returns:

the comment as String.

printVoidingReference

public String printVoidingReference()

getLines

public List<TicketLineFormatter> getLines()

Get a list of formatters for the tickets lines. A TicketLineFormatter object provides methods to access ticketline information.

Returns:

a list of TicketLineFormatter objects.

getKitchenLines

public List<KitchenLineFormatter> getKitchenLines()

Get a list of kitchen line formatters. A KitchenLineFormatter object provides methods to access ticketline information for kitchen printing.

Returns:

a list of TicketLineFormatter objects.

calculateItemCount

public int calculateItemCount()

Get the total of items for a ticket. Scale products and lines with no product assigned (free price entry) are always counted as 1.

Returns:

the sum of ticketline items (amount of products) as double.

getPayments

public List<PaymentFormatter> getPayments()

Get a list of formatters for the tickets payments. A PaymentFormatter object provides methods to access payment information. There is a list element for each payment method used with the ticket.

Returns:

a list of PaymentFormatter objects.

getTaxes

public List<TaxFormatter> getTaxes()

Each ticketline is associated with one or more (if combined taxes are used) taxes. For each tax a tax formatter is created.

Returns:

the list of tax formatters for the ticket.

getTaxTotal

public String getTaxTotal(TaxFormatter taxFormatter)

Deprecated. Use printTaxSum instead.

Print the total for the tax represented by the tax formatter object.

Parameters:

taxFormatter -

Returns:

a currency formatted String.

printTaxSum

public String printTaxSum(TaxFormatter taxFormatter)

Print the total for the tax represented by the tax formatter object. For each line the value is calculated in full precision and then the sum over all lines is rounded to currency precision in the formatting procedure.

Parameters:

taxFormatter -

Returns:

a currency formatted String.

printsTaxSum

public String printsTaxSum(TaxFormatter taxFormatter)

Print the total for the tax represented by the tax formatter object. For each line the value is calculated in full precision and then the sum over all lines is rounded in the formatting procedure.

Parameters:

taxFormatter -

Returns:

a 2 decimals formatted String

getTaxSum

public Double getTaxSum(TaxFormatter taxFormatter)

Get the total tax for the tax represented by the tax formatter object. For each line the value is calculated in full precision and values are summed up over all lines.

Parameters:

taxFormatter -

Returns:

a the tax total as Double

getTotalByTax

public Double getTotalByTax(TaxFormatter taxFormatter)

Get the total taxable (= gross value) for the tax represented by the tax formatter object. For each line the value is calculated in full precision and values are summed up over all lines.

Parameters:

taxFormatter -

Returns:

a the tax total as Double

getSubTotalByTax

public Double getSubTotalByTax(TaxFormatter taxFormatter)

Get the total taxable base (=nat value) for the tax represented by the tax formatter object. For each line the value is calculated in full precision and values are summed up over all lines.

Parameters:

taxFormatter -

Returns:

a the tax total as Double

isCancelled

public boolean isCancelled()

Deprecated. Use isVoided() instead.

Get the status of the ticket (cancelled or active) Beware: This does not indicate the status CANCEL. Instead, we check if the ticket belongs to a CANCELLED_ register.

Returns:

true/false depending on ticket status.

isVoided

public boolean isVoided()

Check if the ticket is voided. Beware: This does not indicate the status CANCEL. We check if the ticket belongs to a CANCELLED_ register or has status VOID.

Returns:

true/false depending on ticket status.

isVoiding

public boolean isVoiding()

Check if the ticket is a voiding ticket.

Returns:

true/false depending on ticket status.

isTraining

public boolean isTraining()

Check if the ticket is a training ticket.

Returns:

true/false depending on ticket status.

printReference

public String printReference()

Print the visibleId of the referenced ticket, if any.

Returns:

the number of the referenced ticket as String.

hasStatus

public boolean hasStatus(int status)

Check if the status matches the given status mask.

Parameters:

status -

Returns:

printHost

public String printHost()

Print the hostname like defined in config

Returns:

a String with the machine.hostname entry from posper.properties

getHost

public String getHost()

getCompanyData

public String getCompanyData(String element)

Retrieve elements from the CompanyData.xml ressource. XLM meta characters in element must be escaped. The returned string will also be XML escaped.

Parameters:

element -

Returns:

the value of element

refreshCompanyData

public void refreshCompanyData()

Reread the company data resource. This can be used if tickets use frequently changing elements like advertising texts and changes shall immediately be available for the tickezs.

getPlace

public String getPlace()

Print the name of the place the ticket is assigned to (xml escaped string).

Returns:

The name of the tickets place.

printPlace

public String printPlace()

Print the name of the place the ticket is assigned to.

Returns:

The name of the tickets place.

printSignature

public String printSignature()

Print the signature string of the ticket which shall be contained in the QR-code printed on the ticket amd as described in the BDI documents. It is assumed that the string does not contain characters that must be XML-escaped. Otherwise use getSignature().

Returns:

the signature string as it is.

printSignatureValue

public String printSignatureValue()

Print the signature as returned by the TSE.

Returns:

the signature value as String if the ticket is valid or an error message otherwise

printSignatureCounter

public String printSignatureCounter()

Return the signature counter from the QR code as string

Returns:

the signature counter as String if the ticket is valid or an error message otherwise

printTransactionStart

public String printTransactionStart()

Print the start date of the transaction - shall only be used for Gastro and is actually the creation date of a place ticket

Returns:

the start date as normalized ISO date

printTransactionEnd

public String printTransactionEnd()

Print the start date of the transaction

Returns:

the start date as normalized ISO date

getSignature

public String getSignature()

Print the signature string of the ticket as XML escaped string.

Returns:

the XML-escaped signature string.

getSignatureFormatter

public SignatureFormatter getSignatureFormatter()

Get a SignatureFormatter which will provide methods to retrieve signature information according to country specific fiscal regulations - Find the formatters layout in SignatureFormatter<country-code>.

Returns:

a country specific signature formatter

getCustomer

public CustomerFormatter getCustomer()

When tickets are printed from an environment which does not supply the $customer variable this method can be used to get the CustomerFormatter for this ticket.

Returns:

a CustomerFormatter object

printCurrentDate

public String printCurrentDate(String pattern)

Prints the current date formatted according to the given pattern.

Parameters:

pattern - a SimpleDateFormat string. If null, a TIMESTAMP is used.

Returns:

the current date as String

splitStringToLines

public List<String> splitStringToLines(String sOldLine,
                                       int iMaxLen)

Split a string in lines, length of lines defined with parameter iMaxLen. Some strings have a size longer than the print size of a line (eg: User_field_1 -> char(255)), so we have to cut the strings in shorter pieces for printing. example for Velocity:

 #foreach ($ufline in $ticket.splitStringToLines($!{customer.getUser_field_1()},45))
   <line>
     <text>$ufline</text>
   </line>
 #end
 

Hint: Some printers like the EPSON TM-T88 series can print over multiple lines. Just omit the lenght= atrribute in the line tag. align= will not work if no length is given and line break will not regard white spaces. Using the spliStringToLines method can give you more control.

Parameters:

sOldLine - - String to split

iMaxLen - - Maximum line length, default = 80

Returns:

List of lines

logTicket

public void logTicket()

logTicket() shall report ticket data like dateClose, user, place, ...

getDiscount

public Double getDiscount()

Calculate the discount amount for the ticket.

Returns:

the discount amount

printDiscount

public String printDiscount()

Print the currency formatted discount granted for the ticket

Returns:

The discount formatted as currency.

printsDiscount

public String printsDiscount()

Print the discount granted for the ticket

Returns:

The discount formatted as double with 2 decimals.

printDiscountPercent

public String printDiscountPercent()

Print the discount percentage granted for the line total

Returns:

The discount formatted as percent.

printTransactionNumber

public String printTransactionNumber()

Print the transaction number as String if the transaction has finshed or an error message otherwise. The error message can be adapted in messages.properties (message.tse_error).

Returns:

the transaction number as String