de.ipcon.db.core.tx

Class TransactionFormatter

java.lang.Object

de.ipcon.db.core.tx.TransactionFormatter

Direct Known Subclasses:

TransactionFormatterGrouped, TransactionFormatterHTML, TransactionFormatterPlain, TransactionFormatterSummarizedPlain

public abstract class TransactionFormatter
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
TransactionFormatter(TransactionFormatterBuilder builder)

Method Summary

Modifier and Type	Method and Description
abstract boolean	asHTML()
java.lang.String	format() Converts the procedures of this TransactionFormatter's transaction to a human-readable string representation according to the given settings.
void	formatToSB(java.lang.StringBuilder sb)
void	formatToSB(java.lang.StringBuilder sb, java.util.Collection<BOProcI> procs, boolean omitPrefix)
abstract java.lang.String	getFooter()
abstract java.lang.String	getHeader()
abstract java.lang.String	getItemEnd()
abstract java.lang.String	getItemStart()

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionFormatter

public TransactionFormatter(TransactionFormatterBuilder builder)

Method Detail

format

public java.lang.String format()

Converts the procedures of this TransactionFormatter's transaction to a human-readable string representation according to the given settings.

Parameters:

from - Start index(inclusive) of the procs inside the Transaction that are to be printed.

till - End index(inclusive) of the procs inside the Transaction that are to be printed. A value of -1 is equivalent to printing all.

maxProcs - Number of procs that are to be printed (exclusive). A value of -1 means unlimited.

onlyThisBO - If not null, only BOProcI-s affecting this BO will be included in the output.

canonize - Whether the procs of the transaction are to be canonized Transaction.canonize(boolean).

skipBackProcs - Whether to skip "redundant" procs setting only back relations from the output. Only makes sense if canonize is passed as true as well.

Returns:

A string representation of the procedures within the transaction.

formatToSB

public void formatToSB(java.lang.StringBuilder sb)

formatToSB

public void formatToSB(java.lang.StringBuilder sb,
                       java.util.Collection<BOProcI> procs,
                       boolean omitPrefix)

asHTML

public abstract boolean asHTML()

getHeader

public abstract java.lang.String getHeader()

getItemStart

public abstract java.lang.String getItemStart()

getItemEnd

public abstract java.lang.String getItemEnd()

getFooter

public abstract java.lang.String getFooter()