com.starteam
Class TraceFinder

java.lang.Object
  com.starteam.TraceFinder

public final class TraceFinder
extends java.lang.Object

Searches for Traces across StarTeam servers.

Searches all servers in the application's Servers collection. If two server objects in the collection refer to the same underlying repository, only one of them is searched.

Nested Class Summary

static class	TraceFinder.Direction Allows a set of traces to be filtered by direction.
static class	TraceFinder.PinType Allows a set of traces to be filtered by revision.

Method Summary

void	addListener(TraceListener listener) Adds an application's TraceFinder.Listener.
void	cancel() Cancels a running trace finder.Stops all query threads as soon as possible.
Server[]	getServersSearched() Gets all the servers that the TraceFinder that were searched during the last query.
TraceCollection	getTraces(LinkValue value, TraceFinder.Direction direction, TraceFinder.PinType pin) Gets all traces to or from the given LinkValue that meet the specified criteria.
TraceCollection	getTraces(java.lang.String url, TraceFinder.Direction direction, TraceFinder.PinType pin) Gets all traces to or from the given endpoint that meet the specified criteria.
TraceCollection	getTraces(ViewMember item) Gets all traces that reference the given revision or any historical revision of the given StarTeam item either as the source or the target.
TraceCollection	getTraces(ViewMember item, TraceFinder.Direction direction, TraceFinder.PinType pin) Gets all traces to or from the given StarTeam item that meet the specified criteria.
TraceCollection	getTracesFrom(ViewMember source) Gets all traces that reference the given revision or any historical revision of the given StarTeam item as source endpoint.
TraceCollection	getTracesTo(ViewMember target) Gets all traces that referenceGets all traces that reference the given revision or any historical revision of the given StarTeam item as target endpoint.
void	removeListener(TraceListener listener) Removes an application's TraceFinder.Listener.
void	requestTraceProperties(PropertyCollection properties) Requests the set of properties for which the values are desired to be returned by the server command for the traces found

Methods inherited from class java.lang.Object

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

Method Detail

addListener

public void addListener(TraceListener listener)

Adds an application's TraceFinder.Listener.

Parameters:

listener - Listener

removeListener

public void removeListener(TraceListener listener)

Removes an application's TraceFinder.Listener.

Parameters:

listener - Listener

cancel

public void cancel()

Cancels a running trace finder.Stops all query threads as soon as possible. The cancel() method returns when the threads have stopped. The invoked query returns partial results.

getServersSearched

public Server[] getServersSearched()

Gets all the servers that the TraceFinder that were searched during the last query.

Returns:

Collection of servers that were searched for traces.

getTraces

public TraceCollection getTraces(ViewMember item)

Gets all traces that reference the given revision or any historical revision of the given StarTeam item either as the source or the target.

Parameters:

item - The endpoint StarTeam item.

Returns:

TraceCollection that reference the given item.

getTracesFrom

public TraceCollection getTracesFrom(ViewMember source)

Gets all traces that reference the given revision or any historical revision of the given StarTeam item as source endpoint.

Parameters:

source - The StarTeam item.

Returns:

The TraceCollection that reference the given source endpoint.

getTracesTo

public TraceCollection getTracesTo(ViewMember target)

Gets all traces that referenceGets all traces that reference the given revision or any historical revision of the given StarTeam item as target endpoint.

Parameters:

target - The StarTeam item.

Returns:

The TraceCollection that reference the given target endpoint.

getTraces

public TraceCollection getTraces(ViewMember item,
                                 TraceFinder.Direction direction,
                                 TraceFinder.PinType pin)

Gets all traces to or from the given StarTeam item that meet the specified criteria.

Parameters:

item - The source or target endpoint.

direction - Indicates whether the URL must match the source endpoint of the trace, or the target endpoint, or may match either.

pin - Indicates whether the trace must reference a specific revision of the item, or may match any revision. Many Pin values are supported only for LinkValues that reference StarTeam items.

Returns:

The TraceCollection that match the given criteria.

getTraces

public TraceCollection getTraces(LinkValue value,
                                 TraceFinder.Direction direction,
                                 TraceFinder.PinType pin)

Gets all traces to or from the given LinkValue that meet the specified criteria.

Parameters:

value - The source or target endpoint.

direction - Indicates whether the URL must match the source endpoint of the trace, or the target endpoint, or may match either.

pin - Indicates whether the trace must reference a specific revision of the item, or may match any revision. Many Pin values are supported only for LinkValues that reference StarTeam items.

Returns:

The TraceCollection that match the given criteria.

getTraces

public TraceCollection getTraces(java.lang.String url,
                                 TraceFinder.Direction direction,
                                 TraceFinder.PinType pin)

Gets all traces to or from the given endpoint that meet the specified criteria.

Parameters:

url - The URL of the source or target endpoint.

direction - Indicates whether the URL must match the source endpoint of the trace, or the target endpoint, or may match either.

pin - Indicates whether the trace must reference a specific revision of the item, or may match any revision. Many Pin values are supported only for StarTeam URLs.

Returns:

The TraceCollection that match the given criteria.

requestTraceProperties

public void requestTraceProperties(PropertyCollection properties)

Requests the set of properties for which the values are desired to be returned by the server command for the traces found

Parameters:

properties - - an array of trace properties