org.eclipse.persistence.tools.profiler
Class PerformanceProfiler

java.lang.Object
  org.eclipse.persistence.tools.profiler.PerformanceProfiler

All Implemented Interfaces:

Serializable, Cloneable, SessionProfiler

public class PerformanceProfiler
extends Object
implements Serializable, Cloneable, SessionProfiler

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

Since:

TopLink 1.0

Author:

James Sutherland

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.eclipse.persistence.sessions.SessionProfiler

ALL, AssignSequence, CACHE, CachedObjects, CacheHits, CacheMisses, CacheNounType, Caching, ChangeSetsNotProcessed, ChangeSetsProcessed, ClientSessionCreated, CONNECT, ConnectionInUse, ConnectionManagement, ConnectionNounType, ConnectionPing, DatabaseExecute, DeletedObject, DescriptorEvent, DistributedMerge, DistributedMergeDmsDisplayName, HEAVY, JtsAfterCompletion, JtsBeforeCompletion, Logging, LoggingDMSDisPlayName, LoginTime, Merge, MergeTime, MiscellaneousNounType, NONE, NORMAL, OBJECT_BUILDING, ObjectBuilding, OptimisticLockException, QUERY_PREPARE, QueryNounType, QueryPreparation, RcmNounType, RcmReceived, RcmSent, RcmStatus, Register, RemoteChangeSet, ROW_FETCH, RowFetch, Sequencing, SessionEvent, SessionName, SessionNounType, SQL_GENERATION, SQL_PREPARE, SqlGeneration, SqlPrepare, STATEMENT_EXECUTE, TlConnects, TlDisconnects, TopLinkRootNoun, TRANSACTION, TransactionNounType, UnitOfWorkRegister, UowCommit, UowCreated, UowRollbacks, Wrapping

Constructor Summary

PerformanceProfiler()
PUBLIC: Create a new profiler.

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

PerformanceProfiler(Session session)
Deprecated. replaced by PerformanceProfiler()

PerformanceProfiler(Session session, boolean shouldLogProfile)
Deprecated. replaced by PerformanceProfiler()

Method Summary

Profile	buildProfileSummary() INTERNAL: Return a summary profile reporting on the profiles contained.
Hashtable	buildProfileSummaryByClass() INTERNAL: Return a map of summary profiles reporting on the profile contained.
Hashtable	buildProfileSummaryByQuery() INTERNAL: Return a map of summary profiles reporting on the profile contained.
Object	clone()
void	dontLogProfile() PUBLIC: Set whether after each query execution the profile result should be logged.
void	endOperationProfile(String operationName) INTERNAL: End the operation timing.
void	endOperationProfile(String operationName, DatabaseQuery query, int weight) INTERNAL: End the operation timing.
Vector	getProfiles() Return the profiles logged in this profiler.
int	getProfileWeight() INTERNAL: Return DMS sensor weight(DMS)
org.eclipse.persistence.internal.sessions.AbstractSession	getSession()
void	initialize() INTERNAL: Initialize EclipseLink noun tree(DMS)
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	occurred(String operationName) INTERNAL: Increase DMS Event sensor occurrence.(DMS)
Object	profileExecutionOfQuery(DatabaseQuery query, Record row, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Finish a profile operation if profiling.
void	setProfileWeight(int weight) INTERNAL: Set DMS sensor weight(DMS)
void	setSession(Session session) INTERNAL: Set the session.
void	setShouldLogProfile(boolean shouldLogProfile) PUBLIC: Set whether after each query execution the profile result should be logged.
boolean	shouldLogProfile()
void	startOperationProfile(String operationName) INTERNAL: Start the operation timing.
void	startOperationProfile(String operationName, DatabaseQuery query, int weight) INTERNAL: Start the operation timing.
void	update(String operationName, Object value) INTERNAL: Update the value of the State sensor.(DMS)

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)

Deprecated. replaced by PerformanceProfiler()

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)

Deprecated. replaced by PerformanceProfiler()

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

buildProfileSummary

public Profile buildProfileSummary()

INTERNAL: Return a summary profile reporting on the profiles contained.

buildProfileSummaryByClass

public Hashtable buildProfileSummaryByClass()

INTERNAL: Return a map of summary profiles reporting on the profile contained.

buildProfileSummaryByQuery

public Hashtable buildProfileSummaryByQuery()

INTERNAL: Return a map of summary profiles reporting on the profile contained.

clone

public Object clone()

Overrides:

clone in class Object

dontLogProfile

public void dontLogProfile()

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

endOperationProfile

public void endOperationProfile(String operationName)

INTERNAL: End the operation timing.

Specified by:

endOperationProfile in interface SessionProfiler

endOperationProfile

public void endOperationProfile(String operationName,
                                DatabaseQuery query,
                                int weight)

INTERNAL: End the operation timing.

Specified by:

endOperationProfile in interface SessionProfiler

getProfiles

public Vector getProfiles()

Return the profiles logged in this profiler.

getSession

public org.eclipse.persistence.internal.sessions.AbstractSession getSession()

logProfile

public void logProfile()

PUBLIC: Set whether after each query execution the profile result should be logged. By 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.

profileExecutionOfQuery

public Object profileExecutionOfQuery(DatabaseQuery query,
                                      Record row,
                                      org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Finish a profile operation if profiling. This assumes the start operation proceeds on the stack. The session must be passed to allow units of work etc. to share their parents profiler.

Specified by:

profileExecutionOfQuery in interface SessionProfiler

Returns:

the execution result of the query.

setSession

public void setSession(Session session)

Description copied from interface: SessionProfiler

INTERNAL: Set the session.

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. By default this is true.

shouldLogProfile

public boolean shouldLogProfile()

startOperationProfile

public void startOperationProfile(String operationName)

INTERNAL: Start the operation timing.

Specified by:

startOperationProfile in interface SessionProfiler

startOperationProfile

public void startOperationProfile(String operationName,
                                  DatabaseQuery query,
                                  int weight)

INTERNAL: Start the operation timing.

Specified by:

startOperationProfile in interface SessionProfiler

update

public void update(String operationName,
                   Object value)

Description copied from interface: SessionProfiler

INTERNAL: Update the value of the State sensor.(DMS)

Specified by:

update in interface SessionProfiler

occurred

public void occurred(String operationName)

Description copied from interface: SessionProfiler

INTERNAL: Increase DMS Event sensor occurrence.(DMS)

Specified by:

occurred in interface SessionProfiler

setProfileWeight

public void setProfileWeight(int weight)

Description copied from interface: SessionProfiler

INTERNAL: Set DMS sensor weight(DMS)

Specified by:

setProfileWeight in interface SessionProfiler

getProfileWeight

public int getProfileWeight()

Description copied from interface: SessionProfiler

INTERNAL: Return DMS sensor weight(DMS)

Specified by:

getProfileWeight in interface SessionProfiler

initialize

public void initialize()

Description copied from interface: SessionProfiler

INTERNAL: Initialize EclipseLink noun tree(DMS)

Specified by:

initialize in interface SessionProfiler