atg.service.datacollection
Class FormattingSummaryLogger

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.service.datacollection.FormattingLogger
              atg.service.datacollection.FormattingSummaryLogger

All Implemented Interfaces:

NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, LogListener, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, DataCollector, DataListener, java.util.EventListener

Direct Known Subclasses:

FormattingSummaryConsoleLogger, FormattingSummaryFileLogger

public abstract class FormattingSummaryLogger
extends FormattingLogger

Formats summary items and prints them to output stream. Concrete subclasses need to initialize the output stream.

See Also:

FormattingLogger

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

FormattingSummaryLogger()

Method Summary

void	appendField(FormatField pFormatField, java.lang.Object pDataItem, java.lang.StringBuffer pBuffer) Append the specified field of the specified object to the string buffer, We expect items to be summary items.
boolean	isValidFormatVariable(java.lang.String pName) Determine if the specified name is the name of a valid format variable.

Methods inherited from class atg.service.datacollection.FormattingLogger

addDataItem, doStartService, doStopService, flush, getCount, getFieldDelimiter, getFormatFields, getLineTerminator, isSkipNullObject, isValidFormatField, logEvent, sanitizeFormatFields, setFieldDelimiter, setFormatFields, setLineTerminator, setSkipNullObject

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

FormattingSummaryLogger

public FormattingSummaryLogger()

Method Detail

isValidFormatVariable

public boolean isValidFormatVariable(java.lang.String pName)

Determine if the specified name is the name of a valid format variable. This is mostly for validating our properties file at startup. Override this method if you wish to support a different set of names.

Overrides:

isValidFormatVariable in class FormattingLogger

Parameters:

pName - name to check

Returns:

true if name is valid, else false

appendField

public void appendField(FormatField pFormatField,
                        java.lang.Object pDataItem,
                        java.lang.StringBuffer pBuffer)

Append the specified field of the specified object to the string buffer, We expect items to be summary items.

Overrides:

appendField in class FormattingLogger

Parameters:

pIndex - index of desired field to print

pDataItem - summary item whose data we are appending

pBuffer - buffer to which we append

See Also:

FormatField