EclipseLink Core 4.0.2 · org.eclipse.persistence.tools.profiler.PerformanceProfiler

Modifier and Type	Field and Description
protected int	nestLevel
protected long	nestTime
protected Map<Integer, Map<String, Long>>	operationStartTimesByThread
protected Map<Integer, Map<String, Long>>	operationTimingsByThread
protected List<Profile>	profiles
protected long	profileTime
protected transient AbstractSession	session
protected boolean	shouldLogProfile

Access	Constructor and Description
public	PerformanceProfiler() PUBLIC: Create a new profiler.
public	PerformanceProfiler(boolean shouldLogProfile) PUBLIC: Create a new profiler.

Method Summary

Modifier and Type	Method and Description
protected void	addProfile(Profile profile)
public Profile	buildProfileSummary() INTERNAL: Return a summary profile reporting on the profiles contained.
public Hashtable<Class<?>, Profile>	buildProfileSummaryByClass() INTERNAL: Return a map of summary profiles reporting on the profile contained.
public Hashtable<Class<?>, Profile>	buildProfileSummaryByQuery() INTERNAL: Return a map of summary profiles reporting on the profile contained.
public PerformanceProfiler	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public void	dontLogProfile() PUBLIC: Set whether after each query execution the profile result should be logged.
public void	endOperationProfile(String operationName) Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.endOperationProfile. Implements org.eclipse.persistence.sessions.SessionProfiler.endOperationProfile. INTERNAL: End the operation timing.
public void	endOperationProfile(String operationName, DatabaseQuery query, int weight) Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.endOperationProfile. Implements org.eclipse.persistence.sessions.SessionProfiler.endOperationProfile. INTERNAL: End the operation timing.
protected int	getNestLevel()
protected long	getNestTime()
protected Map<String, Long>	getOperationStartTimes()
protected Map<Integer, Map<String, Long>>	getOperationStartTimesByThread()
protected Map<String, Long>	getOperationTimings()
protected Map<Integer, Map<String, Long>>	getOperationTimingsByThread()
public List<Profile>	getProfiles() Return the profiles logged in this profiler.
protected long	getProfileTime()
public int	getProfileWeight() Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.getProfileWeight. Implements org.eclipse.persistence.sessions.SessionProfiler.getProfileWeight. INTERNAL: Return DMS sensor weight(DMS)
public AbstractSession	getSession()
public void	initialize() Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.initialize. Implements org.eclipse.persistence.sessions.SessionProfiler.initialize. INTERNAL: Initialize EclipseLink noun tree(DMS)
public void	logProfile() PUBLIC: Set whether after each query execution the profile result should be logged.
public void	logProfileSummary() PUBLIC: Log a profile summary.
public void	logProfileSummaryByClass() PUBLIC: Log a profile summary by class.
public void	logProfileSummaryByQuery() PUBLIC: Log a profile summary by query.
public Object	Returns: the execution result of the query. profileExecutionOfQuery(DatabaseQuery query, DataRecord row, AbstractSession session) Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.profileExecutionOfQuery. Implements org.eclipse.persistence.sessions.SessionProfiler.profileExecutionOfQuery. INTERNAL: Finish a profile operation if profiling.
protected void	setNestLevel(int nestLevel)
protected void	setNestTime(long nestTime)
protected void	setOperationStartTimes(Map<String, Long> operationStartTimes)
protected void	setOperationStartTimesByThread(Map<Integer, Map<String, Long>> operationStartTimesByThread)
protected void	setOperationTimings(Map<String, Long> operationTimings)
protected void	setOperationTimingsByThread(Map<Integer, Map<String, Long>> operationTimingsByThread)
protected void	setProfiles(Vector<Profile> profiles)
protected void	setProfileTime(long profileTime)
public void	setSession(Session session) Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.setSession. Implements org.eclipse.persistence.sessions.SessionProfiler.setSession. INTERNAL: Set the session.
public void	setShouldLogProfile(boolean shouldLogProfile) PUBLIC: Set whether after each query execution the profile result should be logged.
public boolean	shouldLogProfile()
public void	startOperationProfile(String operationName) Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.startOperationProfile. Implements org.eclipse.persistence.sessions.SessionProfiler.startOperationProfile. INTERNAL: Start the operation timing.
public void	startOperationProfile(String operationName, DatabaseQuery query, int weight) Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.startOperationProfile. Implements org.eclipse.persistence.sessions.SessionProfiler.startOperationProfile. INTERNAL: Start the operation timing.
protected void	writeNestingTabs(Writer writer)

Inherited from org.eclipse.persistence.sessions.SessionProfilerAdapter:: occurred occurred setProfileWeight update

nestLevel	back to summary
protected int nestLevel

nestTime	back to summary
protected long nestTime

operationStartTimesByThread	back to summary
protected Map<Integer, Map<String, Long>> operationStartTimesByThread

operationTimingsByThread	back to summary
protected Map<Integer, Map<String, Long>> operationTimingsByThread

profiles	back to summary
protected List<Profile> profiles

profileTime	back to summary
protected long profileTime

session	back to summary
protected transient AbstractSession session

shouldLogProfile	back to summary
protected boolean shouldLogProfile

PerformanceProfiler	back to summary
public PerformanceProfiler() PUBLIC: Create a new profiler. The profiler can be registered with a session to log performance information on queries.

PerformanceProfiler	back to summary
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

addProfile	back to summary
protected void addProfile(Profile profile)

buildProfileSummary	back to summary
public Profile buildProfileSummary() INTERNAL: Return a summary profile reporting on the profiles contained.

buildProfileSummaryByClass	back to summary
public Hashtable<Class<?>, Profile> buildProfileSummaryByClass() INTERNAL: Return a map of summary profiles reporting on the profile contained.

buildProfileSummaryByQuery	back to summary
public Hashtable<Class<?>, Profile> buildProfileSummaryByQuery() INTERNAL: Return a map of summary profiles reporting on the profile contained.

clone back to summary

clone	back to summary
public PerformanceProfiler clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:PerformanceProfiler a clone of this instance. Annotations @Override

public PerformanceProfiler clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:PerformanceProfiler

a clone of this instance.

Annotations

@Override

dontLogProfile	back to summary
public void dontLogProfile() PUBLIC: Set whether after each query execution the profile result should be logged. By default this is false.

endOperationProfile	back to summary
public void endOperationProfile(String operationName) Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.endOperationProfile. Implements org.eclipse.persistence.sessions.SessionProfiler.endOperationProfile. INTERNAL: End the operation timing. Annotations @Override

endOperationProfile

back to summary

public void endOperationProfile(String operationName)

Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.endOperationProfile.

Implements org.eclipse.persistence.sessions.SessionProfiler.endOperationProfile.

INTERNAL: End the operation timing.

Annotations

@Override

endOperationProfile	back to summary
public void endOperationProfile(String operationName, DatabaseQuery query, int weight) Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.endOperationProfile. Implements org.eclipse.persistence.sessions.SessionProfiler.endOperationProfile. INTERNAL: End the operation timing. Annotations @Override

endOperationProfile

back to summary

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

Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.endOperationProfile.

Implements org.eclipse.persistence.sessions.SessionProfiler.endOperationProfile.

INTERNAL: End the operation timing.

Annotations

@Override

getNestLevel	back to summary
protected int getNestLevel()

getNestTime	back to summary
protected long getNestTime()

getOperationStartTimes	back to summary
protected Map<String, Long> getOperationStartTimes()

getOperationStartTimesByThread	back to summary
protected Map<Integer, Map<String, Long>> getOperationStartTimesByThread()

getOperationTimings	back to summary
protected Map<String, Long> getOperationTimings()

getOperationTimingsByThread	back to summary
protected Map<Integer, Map<String, Long>> getOperationTimingsByThread()

getProfiles	back to summary
public List<Profile> getProfiles() Return the profiles logged in this profiler.

getProfileTime	back to summary
protected long getProfileTime()

getProfileWeight	back to summary
public int getProfileWeight() Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.getProfileWeight. Implements org.eclipse.persistence.sessions.SessionProfiler.getProfileWeight. Doc from org.eclipse.persistence.sessions.SessionProfilerAdapter.getProfileWeight. INTERNAL: Return DMS sensor weight(DMS) Annotations @Override

getProfileWeight

back to summary

public int getProfileWeight()

Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.getProfileWeight.

Implements org.eclipse.persistence.sessions.SessionProfiler.getProfileWeight.

Doc from org.eclipse.persistence.sessions.SessionProfilerAdapter.getProfileWeight.

INTERNAL: Return DMS sensor weight(DMS)

Annotations

@Override

getSession	back to summary
public AbstractSession getSession()

initialize	back to summary
public void initialize() Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.initialize. Implements org.eclipse.persistence.sessions.SessionProfiler.initialize. Doc from org.eclipse.persistence.sessions.SessionProfilerAdapter.initialize. INTERNAL: Initialize EclipseLink noun tree(DMS) Annotations @Override

initialize

back to summary

public void initialize()

Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.initialize.

Implements org.eclipse.persistence.sessions.SessionProfiler.initialize.

Doc from org.eclipse.persistence.sessions.SessionProfilerAdapter.initialize.

INTERNAL: Initialize EclipseLink noun tree(DMS)

Annotations

@Override

logProfile	back to summary
public void logProfile() PUBLIC: Set whether after each query execution the profile result should be logged. By default this is true.

logProfileSummary	back to summary
public void logProfileSummary() PUBLIC: Log a profile summary.

logProfileSummaryByClass	back to summary
public void logProfileSummaryByClass() PUBLIC: Log a profile summary by class.

logProfileSummaryByQuery	back to summary
public void logProfileSummaryByQuery() PUBLIC: Log a profile summary by query.

profileExecutionOfQuery	back to summary
public Object profileExecutionOfQuery(DatabaseQuery query, DataRecord row, AbstractSession session) Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.profileExecutionOfQuery. Implements org.eclipse.persistence.sessions.SessionProfiler.profileExecutionOfQuery. 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. Returns:Object the execution result of the query. Annotations @Override @SuppressWarnings:unchecked

profileExecutionOfQuery

back to summary

public Object profileExecutionOfQuery(DatabaseQuery query, DataRecord row, AbstractSession session)

Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.profileExecutionOfQuery.

Implements org.eclipse.persistence.sessions.SessionProfiler.profileExecutionOfQuery.

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.

Returns:Object

the execution result of the query.

Annotations

@Override
@SuppressWarnings:unchecked

setNestLevel	back to summary
protected void setNestLevel(int nestLevel)

setNestTime	back to summary
protected void setNestTime(long nestTime)

setOperationStartTimes	back to summary
protected void setOperationStartTimes(Map<String, Long> operationStartTimes)

setOperationStartTimesByThread	back to summary
protected void setOperationStartTimesByThread(Map<Integer, Map<String, Long>> operationStartTimesByThread)

setOperationTimings	back to summary
protected void setOperationTimings(Map<String, Long> operationTimings)

setOperationTimingsByThread	back to summary
protected void setOperationTimingsByThread(Map<Integer, Map<String, Long>> operationTimingsByThread)

setProfiles	back to summary
protected void setProfiles(Vector<Profile> profiles)

setProfileTime	back to summary
protected void setProfileTime(long profileTime)

setSession	back to summary
public void setSession(Session session) Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.setSession. Implements org.eclipse.persistence.sessions.SessionProfiler.setSession. Doc from org.eclipse.persistence.sessions.SessionProfilerAdapter.setSession. INTERNAL: Set the session. Annotations @Override

setSession

back to summary

public void setSession(Session session)

Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.setSession.

Implements org.eclipse.persistence.sessions.SessionProfiler.setSession.

Doc from org.eclipse.persistence.sessions.SessionProfilerAdapter.setSession.

INTERNAL: Set the session.

Annotations

@Override

setShouldLogProfile	back to summary
public void setShouldLogProfile(boolean shouldLogProfile) PUBLIC: Set whether after each query execution the profile result should be logged. By default this is true.

shouldLogProfile	back to summary
public boolean shouldLogProfile()

startOperationProfile	back to summary
public void startOperationProfile(String operationName) Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.startOperationProfile. Implements org.eclipse.persistence.sessions.SessionProfiler.startOperationProfile. INTERNAL: Start the operation timing. Annotations @Override

startOperationProfile

back to summary

public void startOperationProfile(String operationName)

Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.startOperationProfile.

Implements org.eclipse.persistence.sessions.SessionProfiler.startOperationProfile.

INTERNAL: Start the operation timing.

Annotations

@Override

startOperationProfile	back to summary
public void startOperationProfile(String operationName, DatabaseQuery query, int weight) Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.startOperationProfile. Implements org.eclipse.persistence.sessions.SessionProfiler.startOperationProfile. INTERNAL: Start the operation timing. Annotations @Override

startOperationProfile

back to summary

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

Overrides org.eclipse.persistence.sessions.SessionProfilerAdapter.startOperationProfile.

Implements org.eclipse.persistence.sessions.SessionProfiler.startOperationProfile.

INTERNAL: Start the operation timing.

Annotations

@Override

writeNestingTabs	back to summary
protected void writeNestingTabs(Writer writer)

public Class PerformanceProfiler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail