org.javasimon.jdbc.logging
Class SimonFormatter

java.lang.Object
  java.util.logging.Formatter
      org.javasimon.jdbc.logging.SimonFormatter

Direct Known Subclasses:

LoggingCallback.CsvFormatter, LoggingCallback.HumanFormatter

public abstract class SimonFormatter
extends Formatter

SimonFormatter is abstract root for custom log formatters for logging feature of Simon JDBC driver.

Main format method is formatRecord(java.util.logging.LogRecord, CallbackLogParams). It consumes standard logging LogRecord and object CallbackLogParams. CallbackLogParams contains parameters from callbacks like name of Simon, split, etc.

Since:

2.0

Version:

$Revision: 304 $ $Date: 2011-04-08 10:39:02 +0200 (Fri, 08 Apr 2011) $

Author:

Radovan Sninsky

See Also:

CallbackLogParams, LoggingCallback.formatter()

Constructor Summary

SimonFormatter()

Method Summary

String	format(LogRecord record)
protected abstract String	formatRecord(LogRecord record, CallbackLogParams params) Custom format method.
protected boolean	isStart(CallbackLogParams p) Checks if callback was start event.
protected String	note(CallbackLogParams p) Getter for note.

Methods inherited from class java.util.logging.Formatter

formatMessage, getHead, getTail

Methods inherited from class java.lang.Object

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

Constructor Detail

SimonFormatter

public SimonFormatter()

Method Detail

format

public final String format(LogRecord record)

Specified by:

format in class Formatter

formatRecord

protected abstract String formatRecord(LogRecord record,
                                       CallbackLogParams params)

Custom format method.

Parameters:

record - standard logging log record

params - callback logging parameters

Returns:

log message formated to string

isStart

protected boolean isStart(CallbackLogParams p)

Checks if callback was start event.

Parameters:

p - callback logging params

Returns:

true if event was start; otherwise false

note

protected String note(CallbackLogParams p)

Getter for note.

Parameters:

p - callback logging params

Returns:

note if present; otherwise empty string