TicketLineFormatter (posper 3.0 API)

java.lang.Object
- org.posper.hibernate.formatters.TicketLineFormatter

Direct Known Subclasses:

KitchenLineFormatter
```
public class TicketLineFormatter
extends Object
```
TicketLineFormatter is used to get access to ticketline information from velocity templates that yield a TicketFormatter object. A list of TicketLineFormatter objects can then be retrieved with TicketFormatter#getLines().
Also, the Printer.Ticketline template has a ticketline variable referring a TicketLineFormatter object.
Difference between get, print, and prints methods
- get returns the raw value as defined in the model
- print returns a rounded and formatted value with a unit appended
- prints returns a rounded value without a unit appended
Author:

Hans, Aaron Luchko

See Also:

TicketFormatter

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.apache.log4j.Logger`	`contentLogger`
`protected org.apache.log4j.Logger`	`debugLogger`
`protected TicketLine`	`line`
`protected org.apache.log4j.Logger`	`logger`

Constructor Summary

Constructors
Constructor and Description
`TicketLineFormatter(TicketLine line)` TicketLineFormatter is instantiated in TicketFormatter.
`TicketLineFormatter(TicketLine line, Modifiers mod)` Used for rendering the ticketline in the sales panel (template `Ticket.Line`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`createSurfAccount(char type, String period)` This is a placeholder for a functionality still to be developed.
`Double`	`getAmount()` Get the number of items for the ticketline
`String`	`getBarcode()` Prints the XML escaped barcode string,if any (this is for completeness and should only be necessary in special cases where the code property is 'misused'.
`Integer`	`getCategoryVisibleId()` Get the visibleId of the items category.
`String`	`getComment()` Get the lines comment.
`String`	`getDescription()` Print the line items description.
`String`	`getDescriptionWithComment()` Print the line items description with added comment.
`Double`	`getDiscount()` Calculate the discount amount for the line.
`String`	`getGrossPriceSell()` Deprecated. Use printPriceSellTax() instead. getXXX() methods in formatters should always return unformatted values.
`double`	`getItemsPrinted()` Use this method to filter unprinted ticket lines when printing a kitchen order receipt.
`String`	`getModifiers()` Print the display names of the modifiers currently active for the ticketline
`boolean`	`getOrderPrinted()` Use this method to filter unprinted ticket lines when printing a kitchen order receipt.
`TicketFormatter`	`getParentTicket()` Get a a formatter for the lines parent object, can be used in audit tickets when the ticket variable is empty.
`String`	`getPlace()` Get the name of the tickets place as XML escaped string.
`Double`	`getPriceSell()` Get the ticketline items sell price (net) in Double precision
`Double`	`getPriceSellTax()` Get the ticketline items sell price with tax (gross) in Double precision.
`String`	`getPrivComment()` Get the lines private comment.
`ProductFormatter`	`getProduct()` Get a formatter for the lines product
`String`	`getPubComment()` Get the lines public comment.
`String`	`getReference()` Prints the XML escaped reference string,if any (this is for completeness and should only be necessary in special cases.
`Date`	`getReservationStart()` Get the start date for a reservation.
`Double`	`getSubTotal()` Get the ticketline subtotal (net = amount * priceSell) rounded to currency precision.
`TaxFormatter`	`getTax()` Get the TaxFormatter object for the tax apllied to the item (in case of no combined taxes being used).
`List<TaxFormatter>`	`getTaxes()` Get a list of TaxFormatter objects used with this ticketline (in case of combined taxes for a product)
`String`	`getTaxName()` Print the name of the tax applied for this item.
`Double`	`getTaxRate()` Get the rate of the tax applied for this item in Double precision
`Double`	`getTotal()` Get the ticketline total (gross = amount * priceSell * (1 + taxRate)) rounded to currency precision
`Double`	`getTotalOrig()`
`boolean`	`hasAccountingLevels(int levelMask)` Returns true if at least one of the accounting levels in mask is set for the product assigned to the line.
`boolean`	`hasModifiers(int mask)` Returns true if at least one of the modifiers in mask is set for the line.
`Boolean`	`isCoupon()`
`boolean`	`isProductCom()` Identify helper products (commissioning products)
`boolean`	`isScaleProduct()`
`void`	`log(int level)` Log an INFO message with the supplied integer value.
`void`	`logLine()` logLine() shall report description, amount, price, ...
`String`	`printAmount()` Print the number of items for the ticketline and append a unit.
`String`	`printBarcode()` Prints the barcode of the product, if any.
`String`	`printComment()` Print the comment.
`String`	`printCreatedAt(String format)` Print the date created of the ticketline
`String`	`printDescription()` Print the line items description as string.
`String`	`printDescriptionWithComment()` Print the line items description with added public comment as string.
`String`	`printDiscount()` Print the currency formatted discount granted for the line total
`String`	`printDiscountPercent()` Print the discount percentage granted for the line total.
`String`	`printNextReservationStart(int slotLength)` Prints the start time which is calculated by rounding to the next slot start.
`String`	`printPlace()` Print the name of the tickets place.
`String`	`printPriceSell()` Print the ticketline items sell price (net) rounded to currency precision
`String`	`printPriceSellTax()` Print the ticketline items sell price with tax (gross) rounded to currency precision.
`String`	`printPrivComment()` Print the lines private comment.
`String`	`printPubComment()` Print the lines public comment.
`String`	`printReference()` Prints the reference of the product, if any.
`String`	`printReservationDate()` Prints the reservation date like '15 Juni 2017')
`String`	`printReservationDate(String dateFormat)` Prints the reservation date in the requested format
`String`	`printReservationEnd(int slotLength)` Print the end time of a reservation period.
`String`	`printReservationStart()` Prints the start time like ist has been entered in the create slot reservationt dialog.
`String`	`printReservationStart(int slotLength)` Deprecated. slotLength is ignored, use printReservationStart()
`String`	`printsAmount()` Print the number of items for the ticketline.
`String`	`printsDiscount()` Print the discount granted for the line total
`String`	`printSeat()` The seat number as String
`String`	`printsPriceSell()` Print the ticketline items sell price (net)
`String`	`printsPriceSellTax()` Print the ticketline items sell price with tax (gross) rounded to currency precision.
`String`	`printsSubTotal()` Print the ticketline subtotal (net = amount * priceSell) rounded to currency precision.
`String`	`printStatus()` Print the ticket status.
`String`	`printsTotal()` Print the ticketline total (gross = amount * priceSell * (1 + taxRate)) rounded to 2 decimals
`String`	`printSubTotal()` Print the ticketline subtotal (net = amount * priceSell) rounded to currency precision
`String`	`printTaxRate()` Print the tax rate as percent formatted string
`String`	`printTotal()` Print the ticketline total (gross = amount * priceSell * (1 + taxRate)) rounded to currency precision
`String`	`printUpdatedAt(String format)` Print the date updated of the ticketline
`void`	`setItemsPrinted(double amount)` Use this method to flag ticket lines as printed with an amount of items when printing a kitchen order receipt.
`void`	`setOrderPrinted()` Use this method to flag ticket lines as printed when printing a kitchen order receipt.
`void`	`setStatusOrdered()` Set the status flag to ORDERED.
`void`	`setStatusPreparing()` Set the status flag to PREPARING.
`void`	`setStatusServing()` Set the status flag to SERVING.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - line
```
protected final TicketLine line
```
  - logger
```
protected org.apache.log4j.Logger logger
```
  - debugLogger
```
protected org.apache.log4j.Logger debugLogger
```
  - contentLogger
```
protected org.apache.log4j.Logger contentLogger
```
- Constructor Detail
  - TicketLineFormatter
```
public TicketLineFormatter(TicketLine line)
```
    TicketLineFormatter is instantiated in TicketFormatter. A TicketLineFormatter object is also available in Printer.Ticketline as variable ticketline.
    
    Parameters:
    
    line -
  - TicketLineFormatter
```
public TicketLineFormatter(TicketLine line,
                           Modifiers mod)
```
    Used for rendering the ticketline in the sales panel (template Ticket.Line
    
    Parameters:
    
    line - the referenced ticketline
    
    mod - the currently active modifier mask
- Method Detail
  - getPriceSell
```
public Double getPriceSell()
```
    Get the ticketline items sell price (net) in Double precision
    
    Returns:
    
    sell price as Double
  - printPriceSell
```
public String printPriceSell()
```
    Print the ticketline items sell price (net) rounded to currency precision
    
    Returns:
    
    a currency formatted string
  - printsPriceSell
```
public String printsPriceSell()
```
    Print the ticketline items sell price (net)
    
    Returns:
    
    a 2 decimals formatted string
  - printTaxRate
```
public String printTaxRate()
```
    Print the tax rate as percent formatted string
    
    Returns:
    
    a percent formatted string
  - getTotal
```
public Double getTotal()
```
    Get the ticketline total (gross = amount * priceSell * (1 + taxRate)) rounded to currency precision
    
    Returns:
    
    the total as Double
  - printTotal
```
public String printTotal()
```
    Print the ticketline total (gross = amount * priceSell * (1 + taxRate)) rounded to currency precision
    
    Returns:
    
    a currency formatted string
  - printsTotal
```
public String printsTotal()
```
    Print the ticketline total (gross = amount * priceSell * (1 + taxRate)) rounded to 2 decimals
    
    Returns:
    
    a 2 decimals formatted string
  - printSubTotal
```
public String printSubTotal()
```
    Print the ticketline subtotal (net = amount * priceSell) rounded to currency precision
    
    Returns:
    
    a currency formatted string
  - getSubTotal
```
public Double getSubTotal()
```
    Get the ticketline subtotal (net = amount * priceSell) rounded to currency precision.
    
    Returns:
    
    subtotal as Double
  - printsSubTotal
```
public String printsSubTotal()
```
    Print the ticketline subtotal (net = amount * priceSell) rounded to currency precision.
    
    Returns:
    
    a 2 decimals formatted string
  - getGrossPriceSell
```
public String getGrossPriceSell()
```
    Deprecated. Use printPriceSellTax() instead. getXXX() methods in formatters should always return unformatted values.
    
    Print the ticketline items sell price with tax (gross) rounded to currency precision.
    
    Returns:
    
    a currency formatted string
  - printPriceSellTax
```
public String printPriceSellTax()
```
    Print the ticketline items sell price with tax (gross) rounded to currency precision. For weighed products the price is appended the weight unit as /[priceBase]kg.
    
    Returns:
    
    a currency formatted string
  - getPriceSellTax
```
public Double getPriceSellTax()
```
    Get the ticketline items sell price with tax (gross) in Double precision.
    
    Returns:
    
    the ticketline items sell price with tax as Double
  - printsPriceSellTax
```
public String printsPriceSellTax()
```
    Print the ticketline items sell price with tax (gross) rounded to currency precision.
    
    Returns:
    
    a 2 decinals formatted string
  - isProductCom
```
public boolean isProductCom()
```
    Identify helper products (commissioning products)
    
    Returns:
    
    true if the item is a helper product
  - printDescription
```
public String printDescription()
```
    Print the line items description as string. For weighed products, the tare value is appended to the description text.
    
    Returns:
    
    the description string or an empty string if the description is null.
  - printDescriptionWithComment
```
public String printDescriptionWithComment()
```
    Print the line items description with added public comment as string.
    
    Returns:
    
    the description string or an empty string if the description is null.
  - getDescriptionWithComment
```
public String getDescriptionWithComment()
```
    Print the line items description with added comment. Some special characters will be escaped to meet XML syntax.
    
    Returns:
    
    the description string or an empty string if the description is null.
    
    See Also:
    
    StringUtils.encodeXML(java.lang.String)
  - getDescription
```
public String getDescription()
```
    Print the line items description. Some special characters will be escaped to meet XML syntax. It might not be necessary to xml escape the description because xml parsing takes place before the method has been replaced by its result. Snippets of parsed xml text could eventually be parsed again, that's why we leave it that way. Although it appears that the velocity engine doeas not mind the xml special characters, I'm not completely sure if there could be a situation where they get in the way.
    
    Returns:
    
    the description string or an empty string if the description is null.
    
    See Also:
    
    StringUtils.encodeXML(java.lang.String)
  - printComment
```
public String printComment()
```
    Print the comment.
    
    Returns:
    
    the comment string or an empty string if the comment is null.
  - getComment
```
public String getComment()
```
    Get the lines comment. XML special characters will be escaped to meet XML syntax.
    
    Returns:
    
    the comment string or an empty string if the comment is null.
    
    See Also:
    
    StringUtils.encodeXML(java.lang.String)
  - printPubComment
```
public String printPubComment()
```
    Print the lines public comment. The public comment ends before the first '#'.
    
    Returns:
    
    the comment string or an empty string if the comment is null.
  - getPubComment
```
public String getPubComment()
```
    Get the lines public comment. XML special characters will be escaped to meet XML syntax. The public comment ends before the first '#'.
    
    Returns:
    
    the description string or an empty string if the description is null.
    
    See Also:
    
    StringUtils.encodeXML(java.lang.String)
  - printPrivComment
```
public String printPrivComment()
```
    Print the lines private comment. The public comment starts after the first '#'.
    
    Returns:
    
    the comment string part behind '#' or an empty string.
  - getPrivComment
```
public String getPrivComment()
```
    Get the lines private comment. XML special characters will be escaped to meet XML syntax.
    
    Returns:
    
    the comment string part behind '#' or an empty string.
    
    See Also:
    
    StringUtils.encodeXML(java.lang.String)
  - getModifiers
```
public String getModifiers()
```
    Print the display names of the modifiers currently active for the ticketline
    
    Returns:
    
    a string with the modifier display names
  - getAmount
```
public Double getAmount()
```
    Get the number of items for the ticketline
    
    Returns:
    
    the number of items as Double
  - printAmount
```
public String printAmount()
```
    Print the number of items for the ticketline and append a unit. In case of selling by weight this method returns the weight unit as kg nonregarding a different priceBase, i.e. the amount is recalculated to a priceBase=1.
    
    Returns:
    
    the number of items as Double
  - printsAmount
```
public String printsAmount()
```
    Print the number of items for the ticketline. No unit is appended. In case of selling by weight this method returns the weight unit as kg nonregarding a different priceBase, i.e. the amount is recalculated to priceBase=1.
    
    Returns:
    
    the number of items as Double
  - getTaxes
```
public List<TaxFormatter> getTaxes()
```
    Get a list of TaxFormatter objects used with this ticketline (in case of combined taxes for a product)
    
    Returns:
    
    a list of TaxFormatter objects
    
    See Also:
    
    TaxFormatter
  - getTaxName
```
public String getTaxName()
```
    Print the name of the tax applied for this item.
    
    Returns:
    
    a string with the tax name
  - getTaxRate
```
public Double getTaxRate()
```
    Get the rate of the tax applied for this item in Double precision
    
    Returns:
    
    the tax rate as Double
  - getTax
```
public TaxFormatter getTax()
```
    Get the TaxFormatter object for the tax apllied to the item (in case of no combined taxes being used).
    
    Returns:
    
    the TaxFormatter object for the item
  - getCategoryVisibleId
```
public Integer getCategoryVisibleId()
```
    Get the visibleId of the items category.
    
    Returns:
    
    the categories visibleId as Integer
  - getOrderPrinted
```
public boolean getOrderPrinted()
```
    Use this method to filter unprinted ticket lines when printing a kitchen order receipt.
    
    Returns:
    
    true if the line has already been printed.
  - getItemsPrinted
```
public double getItemsPrinted()
```
    Use this method to filter unprinted ticket lines when printing a kitchen order receipt.
    
    Returns:
    
    the number of items with which this line has already been printed.
  - setOrderPrinted
```
public void setOrderPrinted()
```
    Use this method to flag ticket lines as printed when printing a kitchen order receipt. This method is altering the original ticketline in the database.
  - setItemsPrinted
```
public void setItemsPrinted(double amount)
```
    Use this method to flag ticket lines as printed with an amount of items when printing a kitchen order receipt. This method is altering the original ticketline in the database.
    
    Parameters:
    
    amount - number of items printed
  - printCreatedAt
```
public String printCreatedAt(String format)
```
    Print the date created of the ticketline
    
    Parameters:
    
    format - A format string as required by SimpleDateFormat.
    
    Returns:
    
    The date created formatted according format.
  - printPlace
```
public String printPlace()
```
    Print the name of the tickets place.
    
    Returns:
    
    The name of the tickets place as String.
  - getPlace
```
public String getPlace()
```
    Get the name of the tickets place as XML escaped string.
    
    Returns:
    
    The name of the tickets place as String.
  - printUpdatedAt
```
public String printUpdatedAt(String format)
```
    Print the date updated of the ticketline
    
    Parameters:
    
    format - A format string as required by SimpleDateFormat.
    
    Returns:
    
    The date updated formatted according format.
  - setStatusOrdered
```
public void setStatusOrdered()
```
    Set the status flag to ORDERED.
  - setStatusPreparing
```
public void setStatusPreparing()
```
    Set the status flag to PREPARING.
  - setStatusServing
```
public void setStatusServing()
```
    Set the status flag to SERVING.
  - printStatus
```
public String printStatus()
```
    Print the ticket status.
    
    Returns:
    
    ticket status as String.
  - isCoupon
```
public Boolean isCoupon()
```
  - printSeat
```
public String printSeat()
```
    The seat number as String
    
    Returns:
    
    the seat number
  - hasAccountingLevels
```
public boolean hasAccountingLevels(int levelMask)
```
    Returns true if at least one of the accounting levels in mask is set for the product assigned to the line.
    
    Parameters:
    
    levelMask - A bit mask indicating a number of accounting levels.
    
    Returns:
    
    true if any match else false
  - hasModifiers
```
public boolean hasModifiers(int mask)
```
    Returns true if at least one of the modifiers in mask is set for the line.
    
    Parameters:
    
    mask - modifier mask to check
    
    Returns:
    
    true if any match else false
  - log
```
public void log(int level)
```
    Log an INFO message with the supplied integer value. This is for debugging purposes e.g. to output the accountingLevel of the line.
    
    Parameters:
    
    level - an integer to be written to the log
  - createSurfAccount
```
public boolean createSurfAccount(char type,
                                 String period)
```
    This is a placeholder for a functionality still to be developed.
    
    Parameters:
    
    type -
    
    period -
    
    Returns:
  - logLine
```
public void logLine()
```
    logLine() shall report description, amount, price, ...
  - printBarcode
```
public String printBarcode()
```
    Prints the barcode of the product, if any.
    
    Returns:
    
    the barcode string or an empty string
  - printReference
```
public String printReference()
```
    Prints the reference of the product, if any.
    
    Returns:
    
    the reference string or an empty string
  - getBarcode
```
public String getBarcode()
```
    Prints the XML escaped barcode string,if any (this is for completeness and should only be necessary in special cases where the code property is 'misused'.
    
    Returns:
    
    the XML escaped barcode string or an empty string
  - getReference
```
public String getReference()
```
    Prints the XML escaped reference string,if any (this is for completeness and should only be necessary in special cases.
    
    Returns:
    
    the XML escaped barcode string or an empty string
  - getParentTicket
```
public TicketFormatter getParentTicket()
```
    Get a a formatter for the lines parent object, can be used in audit tickets when the ticket variable is empty.
    
    Returns:
    
    a formatter object for the lines parent ticket.
  - printReservationEnd
```
public String printReservationEnd(int slotLength)
```
    Print the end time of a reservation period. The units field of the associated product is evaluated for the number of slots
    
    Parameters:
    
    slotLength -
    
    Returns:
    
    hh:mm as String, null if there is no product or no units entry.
  - getReservationStart
```
public Date getReservationStart()
```
    Get the start date for a reservation. The start date is always retrieved from the ticket! Either dateDueDelivery or dateOpen is returned.
    
    Returns:
    
    date DueDelivery. If null, dateOpen will be returned.
  - printNextReservationStart
```
public String printNextReservationStart(int slotLength)
```
    Prints the start time which is calculated by rounding to the next slot start.
    
    Parameters:
    
    slotLength -
    
    Returns:
    
    hh:mm as String, null if there is no product or no units entry.
  - printReservationStart
```
public String printReservationStart(int slotLength)
```
    Deprecated. slotLength is ignored, use printReservationStart()
    
    Prints the start time like ist has been entered in the creat slot reservationt dialog.
    
    Parameters:
    
    slotLength -
    
    Returns:
    
    hh:mm as String, an empty string if there's no product or no reservation
  - printReservationStart
```
public String printReservationStart()
```
    Prints the start time like ist has been entered in the create slot reservationt dialog.
    
    Returns:
    
    hh:mm as String, an empty string if there's no product or no reservation
  - printReservationDate
```
public String printReservationDate()
```
    Prints the reservation date like '15 Juni 2017')
    
    Returns:
  - printReservationDate
```
public String printReservationDate(String dateFormat)
```
    Prints the reservation date in the requested format
    
    Parameters:
    
    dateFormat - (see SimpleDateFormat)
    
    Returns:
  - getProduct
```
public ProductFormatter getProduct()
```
    Get a formatter for the lines product
    
    Returns:
    
    a new ProductFormatter
  - getDiscount
```
public Double getDiscount()
```
    Calculate the discount amount for the line.
    
    Returns:
    
    the discount amount
  - printDiscount
```
public String printDiscount()
```
    Print the currency formatted discount granted for the line total
    
    Returns:
    
    The discount formatted as currency.
  - printsDiscount
```
public String printsDiscount()
```
    Print the discount granted for the line total
    
    Returns:
    
    The discount formatted as double with 2 decimals.
  - printDiscountPercent
```
public String printDiscountPercent()
```
    Print the discount percentage granted for the line total. Percent values are rounded to integers.
    
    Returns:
    
    The discount formatted as percent.
  - getTotalOrig
```
public Double getTotalOrig()
```
  - isScaleProduct
```
public boolean isScaleProduct()
```

Class TicketLineFormatter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

line

logger

debugLogger

contentLogger

Constructor Detail

TicketLineFormatter

TicketLineFormatter

Method Detail

getPriceSell

printPriceSell

printsPriceSell

printTaxRate

getTotal

printTotal

printsTotal

printSubTotal

getSubTotal

printsSubTotal

getGrossPriceSell

printPriceSellTax

getPriceSellTax

printsPriceSellTax

isProductCom

printDescription

printDescriptionWithComment

getDescriptionWithComment

getDescription

printComment

getComment

printPubComment

getPubComment

printPrivComment

getPrivComment

getModifiers

getAmount

printAmount

printsAmount

getTaxes

getTaxName

getTaxRate

getTax

getCategoryVisibleId

getOrderPrinted

getItemsPrinted

setOrderPrinted

setItemsPrinted

printCreatedAt

printPlace

getPlace

printUpdatedAt

setStatusOrdered

setStatusPreparing

setStatusServing

printStatus

isCoupon

printSeat

hasAccountingLevels

hasModifiers

log

createSurfAccount

logLine

printBarcode

printReference

getBarcode

getReference

getParentTicket

printReservationEnd

getReservationStart

printNextReservationStart

printReservationStart

printReservationStart

printReservationDate

printReservationDate

getProduct