org.hawkular.btm.api.model.btxn

Class Node

java.lang.Object

org.hawkular.btm.api.model.btxn.Node

Direct Known Subclasses:

ContainerNode

public abstract class Node
extends Object

This abstract class is the base for all nodes describing a business transaction instance flow.

Author:

gbrown

Constructor Summary

Constructors

Constructor and Description
Node()
Node(String uri)

Method Summary

Modifier and Type	Method and Description
void	addGlobalId(String id) This method adds a global correlation id.
void	addInteractionId(String id) This method adds an interaction correlation id.
void	addLocalId(String id) This method adds a local correlation id.
long	completedDuration() This method calculates the duration when all work initiated by this node has been completed.
long	completedTime() This method calculates the time when all work initiated by this node has been completed.
long	endTime() This method calculates the end time of this node based on the start time and duration.
boolean	equals(Object obj)
protected void	findCorrelatedNodes(CorrelationIdentifier cid, long baseTime, Set<Node> nodes) This method identifies all of the nodes within a business transaction that are associated with the supplied correlation identifier.
Set<CorrelationIdentifier>	getCorrelationIds()
Map<String,String>	getDetails() This method returns the specific details about the node.
long	getDuration()
long	getStartTime()
String	getUri()
int	hashCode()
protected boolean	isCorrelated(CorrelationIdentifier cid, long baseTime) This method determines whether the node is correlated to the supplied identifier.
protected long	overallEndTime() This method determines the overall end time of this node.
void	setCorrelationIds(Set<CorrelationIdentifier> correlationIds)
void	setDetails(Map<String,String> details)
void	setDuration(long duration)
void	setStartTime(long startTime)
void	setUri(String uri)

Methods inherited from class java.lang.Object

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

Constructor Detail

Node

public Node()

Node

public Node(String uri)

Method Detail

getUri

public String getUri()

Returns:

the uri

setUri

public void setUri(String uri)

Parameters:

uri - the uri to set

getStartTime

public long getStartTime()

Returns:

the startTime

setStartTime

public void setStartTime(long startTime)

Parameters:

startTime - the startTime to set

getDuration

public long getDuration()

Returns:

the duration

setDuration

public void setDuration(long duration)

Parameters:

duration - the duration to set

getDetails

public Map<String,String> getDetails()

This method returns the specific details about the node.

Returns:

the details

setDetails

public void setDetails(Map<String,String> details)

Parameters:

details - the details to set

getCorrelationIds

public Set<CorrelationIdentifier> getCorrelationIds()

Returns:

the correlationIds

setCorrelationIds

public void setCorrelationIds(Set<CorrelationIdentifier> correlationIds)

Parameters:

correlationIds - the correlationIds to set

addInteractionId

public void addInteractionId(String id)

This method adds an interaction correlation id.

Parameters:

id - The id

addGlobalId

public void addGlobalId(String id)

This method adds a global correlation id.

Parameters:

id - The id

addLocalId

public void addLocalId(String id)

This method adds a local correlation id.

Parameters:

id - The id

endTime

public long endTime()

This method calculates the end time of this node based on the start time and duration. An end time will only be returned if the start time has been set.

Returns:

The end time, based on start time and duration, or 0 if not known

completedTime

public long completedTime()

This method calculates the time when all work initiated by this node has been completed. Where async execution is performed, this could mean the work continues beyond the scope of the node that initiates the work.

Returns:

The completed time

completedDuration

public long completedDuration()

This method calculates the duration when all work initiated by this node has been completed. Where async execution is performed, this could mean the work continues beyond the scope of the node that initiates the work. This will only be calculated where a start time has been set.

Returns:

The completed time

overallEndTime

protected long overallEndTime()

This method determines the overall end time of this node.

Returns:

The overall end time

findCorrelatedNodes

protected void findCorrelatedNodes(CorrelationIdentifier cid,
                                   long baseTime,
                                   Set<Node> nodes)

This method identifies all of the nodes within a business transaction that are associated with the supplied correlation identifier.

Parameters:

cid - The correlation identifier

baseTime - The base time at which the correlation is being evaluated

nodes - The set of nodes that are associated with the correlation identifier

isCorrelated

protected boolean isCorrelated(CorrelationIdentifier cid,
                               long baseTime)

This method determines whether the node is correlated to the supplied identifier.

Parameters:

cid - The correlation id

baseTime - The base time at which the correlation is being evaluated

Returns:

Whether the node is correlated to the supplied id

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object