public class

XMLDebugFormatter

extends XMLFormatter
implements Configurable
java.lang.Object
   ↳ com.microstrategy.utils.log.Formatter
     ↳ com.microstrategy.utils.log.XMLFormatter2
       ↳ com.microstrategy.utils.log.XMLFormatter
         ↳ com.microstrategy.utils.log.XMLDebugFormatter

Summary

[Expand]
Inherited Fields
From class com.microstrategy.utils.log.XMLFormatter2
Public Constructors
XMLDebugFormatter()
Public Methods
void configure(String prefix)
Requests the configurable object to configure itself.
String format(List logRecords)
boolean isTracing()
void setTracing(boolean tracingOn)
Protected Methods
void buildAllInfo(XMLBuilder xml, LogRecord record, int count)
void buildAllInfo(XMLBuilder xml, LogRecord record)
void buildExit(XMLBuilder xml, LogRecord exit)
[Expand]
Inherited Methods
From class com.microstrategy.utils.log.XMLFormatter2
From class com.microstrategy.utils.log.Formatter
From class java.lang.Object
From interface com.microstrategy.utils.log.Configurable

Public Constructors

public XMLDebugFormatter ()

Public Methods

public void configure (String prefix)

Requests the configurable object to configure itself. The "partial properties key" is a parameter of this method. It allows different pluggable logger components to configure themselves without knowing their parent. For example let's assume we have in the logger.properties file a handler named "fileH". Then for the handler itself the prefix will be the "fileH". For the formatter of this handler the prefix will be "fileH.formatter". For the filter of this handler the prefix will be "fileH.filter". And so on. Here is the simplified handler creation workflow:

  • A handler is created based on the corresponding class property ("fileH.class" in our example).
  • The handler's configure method is called with it's name as a prefix ("fileH" in our example).
  • Inside this method the handler reads it's configuration properties and configures itself. Among other things it creates child components. For example it will read the "fileH.filter" property, which defines the filter class name and will create corresponding object.
  • For each child component the handler will call it's configure method passing proper prefix. For example for the filter the prefix will be "fileH.filter".

Parameters
prefix String The partial properties key.

public String format (List logRecords)

public boolean isTracing ()

public void setTracing (boolean tracingOn)

Protected Methods

protected void buildAllInfo (XMLBuilder xml, LogRecord record, int count)

protected void buildAllInfo (XMLBuilder xml, LogRecord record)

protected void buildExit (XMLBuilder xml, LogRecord exit)