PerformanceProfiler (Oracle Fusion Middleware Java API Reference for Oracle TopLink)

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, 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

Author:

James Sutherland

See Also:

Serialized Form

Field Summary
- Fields inherited from interface org.eclipse.persistence.sessions.SessionProfiler
  ALL, AssignSequence, CachedObjects, CacheHits, CacheMisses, Caching, ChangeSetsNotProcessed, ChangeSetsProcessed, ClientSessionCreated, ConnectionManagement, ConnectionPing, Connects, DescriptorEvent, Disconnects, DistributedMerge, HEAVY, JtsAfterCompletion, JtsBeforeCompletion, Logging, LoginTime, Merge, NONE, NORMAL, ObjectBuilding, OptimisticLockException, QueryPreparation, RcmReceived, RcmSent, RcmStatus, Register, RemoteChangeSet, RowFetch, SessionEvent, SessionName, SqlGeneration, SqlPrepare, StatementExecute, Transaction, UowCommit, UowCommits, UowCreated, UowRollbacks

Constructor Summary

Constructors
Constructor and Description
`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

Methods
Modifier and Type	Method and Description
`Profile`	`buildProfileSummary()` INTERNAL: Return a summary profile reporting on the profiles contained.
`java.util.Hashtable`	`buildProfileSummaryByClass()` INTERNAL: Return a map of summary profiles reporting on the profile contained.
`java.util.Hashtable`	`buildProfileSummaryByQuery()` INTERNAL: Return a map of summary profiles reporting on the profile contained.
`PerformanceProfiler`	`clone()`
`void`	`dontLogProfile()` PUBLIC: Set whether after each query execution the profile result should be logged.
`void`	`endOperationProfile(java.lang.String operationName)` INTERNAL: End the operation timing.
`void`	`endOperationProfile(java.lang.String operationName, DatabaseQuery query, int weight)` INTERNAL: End the operation timing.
`java.util.List<Profile>`	`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(java.lang.String operationName)` INTERNAL: Increase DMS Event sensor occurrence.
`void`	`occurred(java.lang.String operationName, DatabaseQuery query)` INTERNAL: Increase DMS Event sensor occurrence.
`java.lang.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(java.lang.String operationName)` INTERNAL: Start the operation timing.
`void`	`startOperationProfile(java.lang.String operationName, DatabaseQuery query, int weight)` INTERNAL: Start the operation timing.
`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)
```
    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 java.util.Hashtable buildProfileSummaryByClass()
```
    INTERNAL: Return a map of summary profiles reporting on the profile contained.
  - buildProfileSummaryByQuery
```
public java.util.Hashtable buildProfileSummaryByQuery()
```
    INTERNAL: Return a map of summary profiles reporting on the profile contained.
  - clone
```
public PerformanceProfiler clone()
```
    Overrides:
    
    clone in class java.lang.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(java.lang.String operationName)
```
    INTERNAL: End the operation timing.
    
    Specified by:
    
    endOperationProfile in interface SessionProfiler
  - endOperationProfile
```
public void endOperationProfile(java.lang.String operationName,
                       DatabaseQuery query,
                       int weight)
```
    INTERNAL: End the operation timing.
    
    Specified by:
    
    endOperationProfile in interface SessionProfiler
  - getProfiles
```
public java.util.List<Profile> 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 java.lang.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(java.lang.String operationName)
```
    INTERNAL: Start the operation timing.
    
    Specified by:
    
    startOperationProfile in interface SessionProfiler
  - startOperationProfile
```
public void startOperationProfile(java.lang.String operationName,
                         DatabaseQuery query,
                         int weight)
```
    INTERNAL: Start the operation timing.
    
    Specified by:
    
    startOperationProfile in interface SessionProfiler
  - 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
  - occurred
```
public void occurred(java.lang.String operationName,
            DatabaseQuery query)
```
    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

Class PerformanceProfiler

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PerformanceProfiler

PerformanceProfiler

PerformanceProfiler

PerformanceProfiler

Method Detail

buildProfileSummary

buildProfileSummaryByClass

buildProfileSummaryByQuery

clone

dontLogProfile

endOperationProfile

endOperationProfile

getProfiles

getSession

logProfile

logProfileSummary

logProfileSummaryByClass

logProfileSummaryByQuery

profileExecutionOfQuery

setSession

setShouldLogProfile

shouldLogProfile

startOperationProfile

startOperationProfile

update

occurred

occurred

setProfileWeight

getProfileWeight

initialize