com.ibm.websphere.logging.hpel.reader
Class HpelCBEFormatter

java.lang.Object
  extended by com.ibm.websphere.logging.hpel.reader.HpelFormatter
      extended by com.ibm.websphere.logging.hpel.reader.HpelCBEFormatter

public class HpelCBEFormatter
extends HpelFormatter

A HpelFormatter subclass implementation that provides formatting of RepositoryLogRecord to a CBE format.


Field Summary
 
Fields inherited from class com.ibm.websphere.logging.hpel.reader.HpelFormatter
FORMAT_ADVANCED, FORMAT_BASIC, FORMAT_CBE101
 
Constructor Summary
HpelCBEFormatter()
          Creates a HpelCBEFormatter instance
 
Method Summary
 java.lang.String formatRecord(RepositoryLogRecord record, java.util.Locale locale)
          Formats a RepositoryLogRecord into a localized CBE format output String.
 java.lang.String getFooter()
          Gets the formatter's footer.
 java.lang.String getFormattedRecord(RepositoryLogRecord record, java.util.Locale locale)
          Gets a String representation of a log record as a CBEEvent XML element
 java.lang.String[] getHeader()
          Gets the formatter's header.
 
Methods inherited from class com.ibm.websphere.logging.hpel.reader.HpelFormatter
addCustomLevel, addCustomLevel, convertParameters, formatMessage, formatRecord, formatRecord, getFormatter, getHeaderProps, getLineSeparator, getLocale, getTimeZoneID, setCustomHeader, setHeaderProps, setLineSeparator, setLocale, setTimeZoneID, translateMessage
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HpelCBEFormatter

public HpelCBEFormatter()
Creates a HpelCBEFormatter instance

Method Detail

formatRecord

public java.lang.String formatRecord(RepositoryLogRecord record,
                                     java.util.Locale locale)
Formats a RepositoryLogRecord into a localized CBE format output String.

Specified by:
formatRecord in class HpelFormatter
Parameters:
record - the RepositoryLogRecord to be formatted
locale - the Locale to use for localization when formatting this record.
Returns:
the formated string output.

getFooter

public java.lang.String getFooter()
Description copied from class: HpelFormatter
Gets the formatter's footer. This method will return an empty string if the formatter does not have a footer as part of the formatter's format style.

Specified by:
getFooter in class HpelFormatter
Returns:
the footer as a string

getHeader

public java.lang.String[] getHeader()
Description copied from class: HpelFormatter
Gets the formatter's header. This method will return an empty array if the formatter does not have a header as part of the formatter's format style return the header as an array of strings

Specified by:
getHeader in class HpelFormatter

getFormattedRecord

public java.lang.String getFormattedRecord(RepositoryLogRecord record,
                                           java.util.Locale locale)
Gets a String representation of a log record as a CBEEvent XML element

Parameters:
record - of the event.
locale - the locale to use when printing the output.
Returns:
String representation of the record in CBE format.