oracle.toplink.tools.profiler
Class PerformanceProfiler

java.lang.Object
  |
  +--oracle.toplink.tools.profiler.PerformanceProfiler

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable, SessionProfiler

public class PerformanceProfiler

extends java.lang.Object

implements java.io.Serializable, java.lang.Cloneable, SessionProfiler

Purpose: A tool used to provide high level performance profiling information.

Since:

TopLink 1.0

See Also:

Serialized Form

Constructor Summary

PerformanceProfiler()
PUBLIC: Create a new profiler.

PerformanceProfiler(boolean shouldLogProfile)
PUBLIC: Create a new profiler.

PerformanceProfiler(Session session)
OBSOLETE: Create a new profiler.

PerformanceProfiler(Session session, boolean shouldLogProfile)
OBSOLETE: Create a new profiler.

Method Summary

Type	Method
java.lang.Object	clone()
void	dontLogProfile() PUBLIC: Set whether after each query execution the profile result should be logged.
java.util.Vector	getProfiles() Return the profiles logged in this profiler.
Session	getSession()
void	logProfile() PUBLIC: Set whether after each query execution the profile result should be logged.
void	logProfileSummary() PUBLIC: Log a profile summary.
void	logProfileSummaryByClass() PUBLIC: Log a profile summary by class.
void	logProfileSummaryByQuery() PUBLIC: Log a profile summary by query.
void	setShouldLogProfile(boolean shouldLogProfile) PUBLIC: Set whether after each query execution the profile result should be logged.
boolean	shouldLogProfile()

Methods inherited from class java.lang.Object

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

Constructor Detail

PerformanceProfiler

public PerformanceProfiler()

PUBLIC: Create a new profiler. The profiler can be registered with a session to log performance information on queries.

PerformanceProfiler

public PerformanceProfiler(Session session)

OBSOLETE: Create a new profiler. The profiler can be registered with a session to log performance information on queries.

PerformanceProfiler

public PerformanceProfiler(Session session,
                           boolean shouldLogProfile)

OBSOLETE: Create a new profiler. The profiler can be registered with a session to log performance information on queries.

PerformanceProfiler

public PerformanceProfiler(boolean shouldLogProfile)

PUBLIC: Create a new profiler. The profiler can be registered with a session to log performance information on queries.

Method Detail

clone

public java.lang.Object clone()

dontLogProfile

public void dontLogProfile()

PUBLIC: Set whether after each query execution the profile result should be logged. Bu default this is true.

getProfiles

public java.util.Vector getProfiles()

Return the profiles logged in this profiler.

getSession

public Session getSession()

logProfile

public void logProfile()

PUBLIC: Set whether after each query execution the profile result should be logged. Bu default this is true.

logProfileSummary

public void logProfileSummary()

PUBLIC: Log a profile summary.

logProfileSummaryByClass

public void logProfileSummaryByClass()

PUBLIC: Log a profile summary by class.

logProfileSummaryByQuery

public void logProfileSummaryByQuery()

PUBLIC: Log a profile summary by query.

setSession

public void setSession(Session session)

Description copied from interface: SessionProfiler

INTERNAL: Set the sesssion.

Specified by:

setSession in interface SessionProfiler

setShouldLogProfile

public void setShouldLogProfile(boolean shouldLogProfile)

PUBLIC: Set whether after each query execution the profile result should be logged. Bu default this is true.

shouldLogProfile

public boolean shouldLogProfile()