com.goldencode.p2j.aspects.ltw

Class AdaptiveQueryTraceAspect

java.lang.Object

com.goldencode.p2j.aspects.ltw.AdaptiveQueryTraceAspect

public abstract class AdaptiveQueryTraceAspect
extends java.lang.Object

An abstract aspect to capture profile data (invocation count and operation time) per AdaptiveQuery. The aspect is designed for load-time weaving using concrete aspect subclass defined in an aop.xml file. That concrete aspect must define a pointcut for the abstract adaptiveScope() method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	AdaptiveQueryTraceAspect.OverviewData Nested class used to keep track of information belonging to all of the AdaptiveQueries traced.
private static class	AdaptiveQueryTraceAspect.SingleData Nested class used to keep track of information belonging to only one AdaptiveQuery that is traced.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	CSV_FILE Fixed name of CSV output file (written to current directory)
private static boolean	enabled Flag which controls data collection
private static CentralLogger	LOG Logger
private static java.util.List<java.lang.reflect.Method>	operations List of methods that are traced
private static boolean	OUTPUT_ALL_QUERIES Flag that controls if all or just the invalidated queries will be displayed
private static AdaptiveQueryTraceAspect.OverviewData	overviewData Data storage for all AdaptiveQueries
private static long	PARENT_CALL_AMOUNT_LIMIT Value that controls the parents displayed after the overview data, it will only display parents that were called more times than the set value.
private static java.util.Map<java.lang.String,java.util.concurrent.atomic.AtomicLong>	parentCalls Map storing SingleData.parent and how many times the parent triggered new AdaptiveQuery instances.
private static java.util.Map<AdaptiveQuery,AdaptiveQueryTraceAspect.SingleData>	traceData Map of profile data by method signature

Constructor Summary

Constructors

Constructor and Description
AdaptiveQueryTraceAspect()

Method Summary

Modifier and Type	Method and Description
abstract void	adaptiveScope() An abstract pointcut which should be defined for load-time weaving inside a concrete-aspect element within META-INF/aop.xml.
static java.lang.String	calculatePercentage(java.util.concurrent.atomic.AtomicLongArray value, java.util.concurrent.atomic.AtomicLongArray total, int position) Calculate the percentage of a value from a total in an AtomicLongArray, being given a position.
boolean	checkNotEnable(org.aspectj.lang.ProceedingJoinPoint pjp) Check if tracing is enabled or method traced is one of the methods that can cause recursive calls.
boolean	checkUpdateTableCount(org.aspectj.lang.ProceedingJoinPoint joinPoint) Check if the current method is AdaptiveQuery.execute().
static void	enableDataCollection(boolean enable) Enable or disable data collection.
int	getOperationIfAny(org.aspectj.lang.ProceedingJoinPoint joinPoint) Check if the current traced method is an operation that exists in the list of traced methods.
java.lang.String	getStackMethodParent(java.lang.StackTraceElement[] ste) Search for the parent that eventually led to the AdaptiveQuery in a StackTrace.
void	handleAdaptiveQueryDetails(org.aspectj.lang.ProceedingJoinPoint joinPoint, AdaptiveQueryTraceAspect.SingleData data) Displays data about the current traced AdaptiveQuery method.
void	handleAdaptiveQueryScrollingStatus(org.aspectj.lang.ProceedingJoinPoint joinPoint, AdaptiveQueryTraceAspect.SingleData data) Introduces new data to an existent SingleData instance belonging to an AdaptiveQuery regarding it's Scrolling status.
void	handleInvalidation(org.aspectj.lang.ProceedingJoinPoint joinPoint, AdaptiveQueryTraceAspect.SingleData data) Introduces new data to an existent SingleData instance belonging to an AdaptiveQuery when the operation is AdaptiveQuery.invalidate().
void	handleOperation(org.aspectj.lang.ProceedingJoinPoint joinPoint, AdaptiveQueryTraceAspect.SingleData data) Introduces new data to an existent SingleData instance belonging to an AdaptiveQuery when the operation was defined in the specific operation list.
void	handleRevalidation(org.aspectj.lang.ProceedingJoinPoint joinPoint, AdaptiveQueryTraceAspect.SingleData data) Introduces new data to an existent SingleData instance belonging to an AdaptiveQuery when the operation is AdaptiveQuery.revalidate().
void	handleStateChanged(org.aspectj.lang.ProceedingJoinPoint joinPoint, AdaptiveQueryTraceAspect.SingleData data) Introduces new data to an existent SingleData instance belonging to an AdaptiveQuery when the operation is AdaptiveQuery.stateChanged().
(package private) static void	initialize() Method that initializes the operations traced in AdaptiveQuery and creates an instance of OverviewData which depends on the number of operations traced.
boolean	isDoubleCheckMethod(org.aspectj.lang.ProceedingJoinPoint joinPoint) Checks if the current method is AdaptiveQuery.doubleCheckInvalidation().
static void	processData() Post-process the collected trace data and log the results.
java.lang.Object	trace(org.aspectj.lang.ProceedingJoinPoint joinPoint) The primary tracing advice which collects trace information about calls to the AdaptiveQuery class.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final CentralLogger LOG

Logger

enabled

private static volatile boolean enabled

Flag which controls data collection

traceData

private static final java.util.Map<AdaptiveQuery,AdaptiveQueryTraceAspect.SingleData> traceData

Map of profile data by method signature

parentCalls

private static final java.util.Map<java.lang.String,java.util.concurrent.atomic.AtomicLong> parentCalls

Map storing SingleData.parent and how many times the parent triggered new AdaptiveQuery instances.

overviewData

private static AdaptiveQueryTraceAspect.OverviewData overviewData

Data storage for all AdaptiveQueries

operations

private static final java.util.List<java.lang.reflect.Method> operations

List of methods that are traced

CSV_FILE

private static java.lang.String CSV_FILE

Fixed name of CSV output file (written to current directory)

OUTPUT_ALL_QUERIES

private static final boolean OUTPUT_ALL_QUERIES

Flag that controls if all or just the invalidated queries will be displayed

See Also:

Constant Field Values

PARENT_CALL_AMOUNT_LIMIT

private static final long PARENT_CALL_AMOUNT_LIMIT

Value that controls the parents displayed after the overview data, it will only display parents that were called more times than the set value.

See Also:

Constant Field Values

Constructor Detail

AdaptiveQueryTraceAspect

public AdaptiveQueryTraceAspect()

Method Detail

initialize

static void initialize()

Method that initializes the operations traced in AdaptiveQuery and creates an instance of OverviewData which depends on the number of operations traced.

enableDataCollection

public static void enableDataCollection(boolean enable)

Enable or disable data collection. Upon disabling data collection, any collected results are processed and exported.

Parameters:

enable - true to start data collection; false to stop it and process the results.

processData

public static void processData()

Post-process the collected trace data and log the results.

calculatePercentage

public static java.lang.String calculatePercentage(java.util.concurrent.atomic.AtomicLongArray value,
                                                   java.util.concurrent.atomic.AtomicLongArray total,
                                                   int position)

Calculate the percentage of a value from a total in an AtomicLongArray, being given a position.

Parameters:

value - Value divided by the total

total - Total for division

position - Position of the value and total in the AtomicLongArray

Returns:

A double representing the percentage

adaptiveScope

public abstract void adaptiveScope()

An abstract pointcut which should be defined for load-time weaving inside a concrete-aspect element within META-INF/aop.xml.

trace

public java.lang.Object trace(org.aspectj.lang.ProceedingJoinPoint joinPoint)
                       throws java.lang.Throwable

The primary tracing advice which collects trace information about calls to the AdaptiveQuery class. Each AdaptiveQuery instance will have a SingleData instance associated with it, while also collecting data in the OverviewData from all the existent queries.

Parameters:

joinPoint - Join point which represents the method being traced.

Returns:

Object, if any, returned by the method being traced.

Throws:

java.lang.Throwable - if an exception is thrown by the method being traced.

handleAdaptiveQueryDetails

public void handleAdaptiveQueryDetails(org.aspectj.lang.ProceedingJoinPoint joinPoint,
                                       AdaptiveQueryTraceAspect.SingleData data)

Displays data about the current traced AdaptiveQuery method.

Parameters:

joinPoint - Join point which represents the method being traced.

data - Information of an AdaptiveQuery.

handleAdaptiveQueryScrollingStatus

public void handleAdaptiveQueryScrollingStatus(org.aspectj.lang.ProceedingJoinPoint joinPoint,
                                               AdaptiveQueryTraceAspect.SingleData data)

Introduces new data to an existent SingleData instance belonging to an AdaptiveQuery regarding it's Scrolling status.

Parameters:

joinPoint - Join point which represents the method being traced.

data - Information of an AdaptiveQuery.

handleInvalidation

public void handleInvalidation(org.aspectj.lang.ProceedingJoinPoint joinPoint,
                               AdaptiveQueryTraceAspect.SingleData data)

Introduces new data to an existent SingleData instance belonging to an AdaptiveQuery when the operation is AdaptiveQuery.invalidate().

Parameters:

joinPoint - Join point which represents the method being traced.

data - Information of an AdaptiveQuery.

handleRevalidation

public void handleRevalidation(org.aspectj.lang.ProceedingJoinPoint joinPoint,
                               AdaptiveQueryTraceAspect.SingleData data)

Introduces new data to an existent SingleData instance belonging to an AdaptiveQuery when the operation is AdaptiveQuery.revalidate().

Parameters:

joinPoint - Join point which represents the method being traced.

data - Information of an AdaptiveQuery.

handleStateChanged

public void handleStateChanged(org.aspectj.lang.ProceedingJoinPoint joinPoint,
                               AdaptiveQueryTraceAspect.SingleData data)

Introduces new data to an existent SingleData instance belonging to an AdaptiveQuery when the operation is AdaptiveQuery.stateChanged().

Parameters:

joinPoint - Join point which represents the method being traced.

data - Information of an AdaptiveQuery.

handleOperation

public void handleOperation(org.aspectj.lang.ProceedingJoinPoint joinPoint,
                            AdaptiveQueryTraceAspect.SingleData data)

Introduces new data to an existent SingleData instance belonging to an AdaptiveQuery when the operation was defined in the specific operation list.

Parameters:

joinPoint - Join point which represents the method being traced.

data - Information of an AdaptiveQuery.

checkUpdateTableCount

public boolean checkUpdateTableCount(org.aspectj.lang.ProceedingJoinPoint joinPoint)

Check if the current method is AdaptiveQuery.execute().

Parameters:

joinPoint - Join point which represents the method being traced.

Returns:

true/false

isDoubleCheckMethod

public boolean isDoubleCheckMethod(org.aspectj.lang.ProceedingJoinPoint joinPoint)

Checks if the current method is AdaptiveQuery.doubleCheckInvalidation().

Parameters:

joinPoint - Join point which represents the method being traced.

Returns:

true/false

getOperationIfAny

public int getOperationIfAny(org.aspectj.lang.ProceedingJoinPoint joinPoint)

Check if the current traced method is an operation that exists in the list of traced methods.

Parameters:

joinPoint - Join point which represents the method being traced.

Returns:

-1 if it's not an operation value corresponding to the position in the list of methods

checkNotEnable

public boolean checkNotEnable(org.aspectj.lang.ProceedingJoinPoint pjp)

Check if tracing is enabled or method traced is one of the methods that can cause recursive calls. If a particular information is required from an AdaptiveQuery and it can be obtained from one of the methods present in the class, make sure that it is ignored when tracing.

Parameters:

pjp - Join point which represents the method being traced.

Returns:

true if method should be ignored false if method should proceed and be traced

getStackMethodParent

public java.lang.String getStackMethodParent(java.lang.StackTraceElement[] ste)

Search for the parent that eventually led to the AdaptiveQuery in a StackTrace. The parent is associated with the method from the converted 4GL application.

Parameters:

ste - A StackTraceElement array containing the current thread trace until it reached the trace method.

Returns:

null if there is no parent a String value that holds the first parent found in the stack trace