Skip navigation links

Oracle TopLink Java API Reference
10g Release 3 (10.1.3.1)

B28219-01


oracle.toplink.tools.profiler
Class PerformanceProfiler

java.lang.Object
  extended byoracle.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

Field Summary

 

Fields inherited from interface oracle.toplink.sessions.SessionProfiler
ALL, AssignSequence, CACHE, CachedObjects, CacheHits, CacheMisses, CacheNounType, Caching, ChangeSetsNotProcessed, ChangeSetsProcessed, ClientSessionCreated, CONNECT, ConnectionInUse, ConnectionManagement, ConnectionNounType, DatabaseExecute, DeletedObject, DeleteQuery, 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, ReadQuery, 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, WriteQuery

 

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
 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.
 int getProfileWeight()
          INTERNAL: Return DMS sensor weight(DMS)
 Session getSession()
           
 void initialize()
          INTERNAL: Initialize TopLink 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(java.lang.String operationName)
          INTERNAL: Increase DMS Event sensor occurrence.
 void setProfileWeight(int weight)
          INTERNAL: Set DMS sensor weight(DMS)
 void setSession(Session session)
          INTERNAL: Set the sesssion.
 void setShouldLogProfile(boolean shouldLogProfile)
          PUBLIC: Set whether after each query execution the profile result should be logged.
 boolean shouldLogProfile()
           
 void update(java.lang.String operationName, java.lang.Object value)
          INTERNAL: Update the value of the State sensor.

 

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()

update

public void update(java.lang.String operationName,
                   java.lang.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(java.lang.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 TopLink noun tree(DMS)
Specified by:
initialize in interface SessionProfiler

Skip navigation links

Copyright © 1998, 2006, Oracle. All Rights Reserved.