wt.fc.profiling
Class AbstractProfilingLogger

java.lang.Object
  wt.fc.profiling.AbstractProfilingLogger

All Implemented Interfaces:

TraceTimingLogger

Direct Known Subclasses:

SQLExecutionTimeProfilingLogger

public abstract class AbstractProfilingLogger

extends Object

implements TraceTimingLogger

This abstract class provides common implementation for logging information to the profiling service.

Supported API: false

Extendable: false

Field Summary

private static String	CLASSNAME
protected static Object	PROFILING_KEY
private Map	propertyMap
private static String	RESOURCE

Fields inherited from interface wt.util.TraceTimingLogger

PROPERTY_MAP

Constructor Summary

AbstractProfilingLogger()

Method Summary

abstract TraceTimingEntry	addBeginEntry(String a_className, String a_name, long a_timeMillis, Object a_info) Adds a begin entry to the log.
abstract TraceTimingEntry	addBreakEntry(String a_className, String a_name, long a_timeMillis, Object a_info, int a_level) Adds an break-in-flow, end entry to the log.
abstract TraceTimingEntry	addEndEntry(String a_className, String a_name, long a_timeMillis, Object a_info) Adds an end entry to the log.
ProfilingKey	getProfilingKey() Gets the value of the attribute: profilingKey; The key to use for profiling.
Map	getPropertyMap() Gets the value of the attribute: propertyMap; Property map used to control the behavior of the Logger.
void	setPropertyMap(Map a_PropertyMap) Sets the value of the attribute: propertyMap; Property map used to control the behavior of the Logger.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

propertyMap

private Map propertyMap

PROFILING_KEY

protected static final Object PROFILING_KEY

Constructor Detail

AbstractProfilingLogger

public AbstractProfilingLogger()

Method Detail

getProfilingKey

public ProfilingKey getProfilingKey()
                             throws WTException

Gets the value of the attribute: profilingKey; The key to use for profiling.

Supported API: false

Returns:

ProfilingKey

Throws:

WTException

addBeginEntry

public abstract TraceTimingEntry addBeginEntry(String a_className,
                                               String a_name,
                                               long a_timeMillis,
                                               Object a_info)

Adds a begin entry to the log.

Supported API: false

Specified by:

addBeginEntry in interface TraceTimingLogger

Parameters:

a_className - The name of the class associated with this entry.

a_name - The name associated with this entry.

a_timeMillis - Time in milliseconds. If less than zero, then the current system time is used.

a_info - Informative message associated with this entry.

Returns:

TraceTimingEntry

addEndEntry

public abstract TraceTimingEntry addEndEntry(String a_className,
                                             String a_name,
                                             long a_timeMillis,
                                             Object a_info)

Adds an end entry to the log.

Supported API: false

Specified by:

addEndEntry in interface TraceTimingLogger

Parameters:

a_className - The name of the class associated with this entry.

a_name - The name associated with this entry.

a_timeMillis - Time in milliseconds. If less than zero, then the current system time is used.

a_info - Informative message associated with this entry.

Returns:

TraceTimingEntry

addBreakEntry

public abstract TraceTimingEntry addBreakEntry(String a_className,
                                               String a_name,
                                               long a_timeMillis,
                                               Object a_info,
                                               int a_level)

Adds an break-in-flow, end entry to the log.

Supported API: false

Specified by:

addBreakEntry in interface TraceTimingLogger

Parameters:

a_className - The name of the class associated with this entry.

a_name - The name associated with this entry.

a_timeMillis - Time in milliseconds. If less than zero, then the current system time is used.

a_info - Informative message associated with this entry.

a_level - Indicates the level of the corresponding begin entry.

Returns:

TraceTimingEntry

getPropertyMap

public Map getPropertyMap()

Gets the value of the attribute: propertyMap; Property map used to control the behavior of the Logger.

Supported API: false

Specified by:

getPropertyMap in interface TraceTimingLogger

Returns:

Map

setPropertyMap

public void setPropertyMap(Map a_PropertyMap)
                    throws WTPropertyVetoException

Sets the value of the attribute: propertyMap; Property map used to control the behavior of the Logger.

Supported API: false

Specified by:

setPropertyMap in interface TraceTimingLogger

Parameters:

a_PropertyMap -

Throws:

WTPropertyVetoException