com.starteam.events
Class TraceEvent

java.lang.Object
  java.util.EventObject
      com.starteam.events.TraceEvent

All Implemented Interfaces:

java.io.Serializable

public final class TraceEvent
extends java.util.EventObject

Event triggered when partial Trace results are available.

Note that even though the query work may be distributed across multiple threads, TraceFinder.Events are serialized; thus, listeners are not invoked for a new event until all the event handlers have finished processing the previous event.

See Also:

Serialized Form

Method Summary

void	cancel() Cancel execution of the TraceFinder Queries
java.lang.Throwable	getFailure() Reports an exception.
Server	getServer() Gets the repository from which these traces were obtained.
int	getTotalWork() Gets the total units of work required to execute this query.
TraceCollection	getTraces() A set of traces representing partial results to a query.
int	getWorkCompleted() Gets the number of units of work completed so far.
boolean	isCanceled() returns true if further execution of TraceFinder Queries have been canceled
boolean	isSuccessful() Returns true if we're reporting query results; false if we're reporting an exception.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getServer

public Server getServer()

Gets the repository from which these traces were obtained.

Returns:

Server

getTraces

public TraceCollection getTraces()

A set of traces representing partial results to a query.

Every trace that will eventually appear in the result set appears exactly once in some TraceFinder.Event's TraceCollection.

Furthermore, every server that is searched appears at least once in a TraceFinder.Event. If a given server is searched but does not have any traces that match the query, then it will appear in a TraceFinder.Event whose TraceCollection is empty.

Returns:

TraceCollection

isSuccessful

public boolean isSuccessful()

Returns true if we're reporting query results; false if we're reporting an exception.

Returns:

boolean

getFailure

public java.lang.Throwable getFailure()

Reports an exception.

Returns:

Throwable

getTotalWork

public int getTotalWork()

Gets the total units of work required to execute this query.

Returns:

the total units of work

getWorkCompleted

public int getWorkCompleted()

Gets the number of units of work completed so far.

Returns:

the total units of work completed

cancel

public void cancel()

Cancel execution of the TraceFinder Queries

isCanceled

public boolean isCanceled()

returns true if further execution of TraceFinder Queries have been canceled

Returns:

True if further execution of TraceFinder Queries have been canceled