tap

Class TAPExecutionReport

java.lang.Object

tap.TAPExecutionReport

public class TAPExecutionReport
extends java.lang.Object

Report the execution (including the parsing and the output writing) of an ADQL query.

It gives information on the job parameters, the job ID, whether it is a synchronous task or not, times of each execution step (uploading, parsing, executing and writing), the resulting columns and the success or not of the execution.

This report is completely filled by ADQLExecutor, and aims to be used/read only at the end of the job or when it is definitely finished.

Version:

2.3 (03/2019)

Author:

Grégory Mantelet (CDS;ARI)

Field Summary

Fields

Modifier and Type	Field and Description
protected long[]	durations Duration of all execution steps.
java.lang.String	fixedQuery Input ADQL query after an automatic fix by TAP-Lib.
java.lang.String	jobID ID of the job whose the execution is reported here.
long	nbRows Total number of written rows.
TAPParameters	parameters List of all parameters provided in the user request.
DBColumn[]	resultingColumns List of all resulting columns.
boolean	success Indicate whether this job has ended successfully or not.
boolean	synchronous Indicate whether this execution is done in a synchronous or asynchronous job.
protected long	totalDuration Total duration of the job execution.

Constructor Summary

Constructors

Constructor and Description
TAPExecutionReport(java.lang.String jobID, boolean synchronous, TAPParameters params) Build an empty execution report.

Method Summary

Modifier and Type	Method and Description
long	getDuration(ExecutionProgression tapStep) Get the duration corresponding to the given job execution step.
long	getExecutionDuration() Get the execution of the EXECUTION step.
long	getFormattingDuration() Get the execution of the FORMAT step.
protected int	getIndexDuration(ExecutionProgression tapProgression) Map the execution progression with an index inside the durations array.
long	getParsingDuration() Get the execution of the PARSE step.
long	getTotalDuration() Get the total duration of the job execution.
long	getUploadDuration() Get the execution of the UPLOAD step.
void	setDuration(ExecutionProgression tapStep, long duration) Set the duration corresponding to the given execution step.
void	setTotalDuration(long duration) Set the total duration of the job execution.

Methods inherited from class java.lang.Object

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

Field Detail

jobID

public final java.lang.String jobID

ID of the job whose the execution is reported here.

synchronous

public final boolean synchronous

Indicate whether this execution is done in a synchronous or asynchronous job.

parameters

public final TAPParameters parameters

List of all parameters provided in the user request.

fixedQuery

public java.lang.String fixedQuery

Input ADQL query after an automatic fix by TAP-Lib.

This field is set only if the option fix_on_fail is enabled in the TAP configuration and that a query has been fixed.

Since:

2.3

resultingColumns

public DBColumn[] resultingColumns

List of all resulting columns. Empty array, if not yet known.

nbRows

public long nbRows

Total number of written rows.

Since:

2.0

durations

protected final long[] durations

Duration of all execution steps. For the moment only 4 steps (in the order): uploading, parsing, executing and writing.

totalDuration

protected long totalDuration

Total duration of the job execution.

success

public boolean success

Indicate whether this job has ended successfully or not. At the beginning or while executing, this field is always FALSE.

Constructor Detail

TAPExecutionReport

public TAPExecutionReport(java.lang.String jobID,
                          boolean synchronous,
                          TAPParameters params)

Build an empty execution report.

Parameters:

jobID - ID of the job whose the execution must be described here.

synchronous - true if the job is synchronous, false otherwise.

params - List of all parameters provided by the user for the execution.

Method Detail

getIndexDuration

protected int getIndexDuration(ExecutionProgression tapProgression)

Map the execution progression with an index inside the durations array.

Warning: for the moment, only ExecutionProgression.UPLOADING, ExecutionProgression.PARSING, ExecutionProgression.EXECUTING_ADQL and ExecutionProgression.WRITING_RESULT are managed.

Parameters:

tapProgression - Execution progression.

Returns:

Index in the array durations, or -1 if the given execution progression is not managed.

getDuration

public final long getDuration(ExecutionProgression tapStep)

Get the duration corresponding to the given job execution step.

Parameters:

tapStep - Job execution step.

Returns:

The corresponding duration (in ms), or -1 if this step has not been (yet) processed.

See Also:

getIndexDuration(ExecutionProgression)

setDuration

public final void setDuration(ExecutionProgression tapStep,
                              long duration)

Set the duration corresponding to the given execution step.

Parameters:

tapStep - Job execution step.

duration - Duration (in ms) of the given execution step.

getUploadDuration

public final long getUploadDuration()

Get the execution of the UPLOAD step.

Returns:

Duration (in ms).

See Also:

getDuration(ExecutionProgression)

getParsingDuration

public final long getParsingDuration()

Get the execution of the PARSE step.

Returns:

Duration (in ms).

See Also:

getDuration(ExecutionProgression)

getExecutionDuration

public final long getExecutionDuration()

Get the execution of the EXECUTION step.

Returns:

Duration (in ms).

See Also:

getDuration(ExecutionProgression)

getFormattingDuration

public final long getFormattingDuration()

Get the execution of the FORMAT step.

Returns:

Duration (in ms).

See Also:

getDuration(ExecutionProgression)

getTotalDuration

public final long getTotalDuration()

Get the total duration of the job execution.

Returns:

Duration (in ms).

setTotalDuration

public final void setTotalDuration(long duration)

Set the total duration of the job execution.

Parameters:

duration - Duration (in ms) to set.